az iot hub certificate

  • リファレンス

Note

このコマンド グループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。 各拡張機能をインストールして、拡張機能を活用します。 拡張機能の詳細をご覧ください。

IoT Hub 証明書を管理します。

コマンド

名前 説明 型 Status
az iot hub certificate create

Azure IoT Hub 証明書を作成/アップロードします。

 コア GA
az iot hub certificate delete

Azure IoT Hub 証明書を削除します。

 コア GA
az iot hub certificate generate-verification-code

Azure IoT Hub 証明書の検証コードを生成します。

 コア GA
az iot hub certificate list

Azure IoT Hub に含まれるすべての証明書を一覧表示します。

 コア GA
az iot hub certificate root-authority

IoT Hub インスタンスの証明書ルート証明機関を管理します。

 拡張機能 非推奨
az iot hub certificate root-authority set

IoT Hub インスタンスの証明書ルート証明機関を特定のバージョンに設定します。

 拡張機能 非推奨
az iot hub certificate root-authority show

IoT Hub インスタンスの現在の証明書ルート証明機関を表示します。

 拡張機能 非推奨
az iot hub certificate show

特定の Azure IoT Hub 証明書に関する情報を表示します。

 コア GA
az iot hub certificate update

Azure IoT Hub 証明書を更新します。

 コア GA
az iot hub certificate verify

Azure IoT Hub 証明書を検証します。

 コア GA

az iot hub certificate create

編集

Azure IoT Hub 証明書を作成/アップロードします。

Azure IoT Hub の CA 証明書の詳細については、次を参照してください https://docs.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview。

az iot hub certificate create --hub-name
                              --name
                              --path
                              [--resource-group]
                              [--verified {false, true}]

例

検証済みの CA 証明書 PEM ファイルを IoT ハブにアップロードします。

az iot hub certificate create --hub-name MyIotHub --name MyCertificate --path /certificates/Certificate.pem --verified

CA 証明書 CER ファイルを IoT ハブにアップロードします。

az iot hub certificate create --hub-name MyIotHub --name MyCertificate --path /certificates/Certificate.cer

Azure IoT Hub 証明書の作成/アップロード (自動生成)

az iot hub certificate create --hub-name MyIotHub --name MyCertificate --path /certificates/Certificate.cer --resource-group MyResourceGroup --subscription MySubscription

必須のパラメーター

--hub-name

IoT Hub 名。

--name -n

証明書のフレンドリ名。

--path -p

証明書を含むファイルへのパス。

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--verified -v

証明書が検証されるかどうかを示すブール値。

承認された値: false, true
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot hub certificate delete

編集

Azure IoT Hub 証明書を削除します。

Azure IoT Hub の CA 証明書の詳細については、次を参照してください https://docs.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview。

az iot hub certificate delete --etag
                              --name
                              [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--subscription]

例

MyCertificate を削除します

az iot hub certificate delete --hub-name MyIotHub --name MyCertificate --etag AAAAAAAAAAA=

必須のパラメーター

--etag -e

オブジェクトのエンティティ タグ (etag)。

--name -n

証明書のフレンドリ名。

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot hub certificate generate-verification-code

編集

Azure IoT Hub 証明書の検証コードを生成します。

この検証コードは、証明書の所有証明手順を完了するために使用されます。 この検証コードは、ルート証明書の秘密キーで署名された新しい証明書の CN として使用します。 Azure IoT Hub の CA 証明書の詳細については、次を参照してください https://docs.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview。

az iot hub certificate generate-verification-code --etag
                                                  --name
                                                  [--hub-name]
                                                  [--ids]
                                                  [--resource-group]
                                                  [--subscription]

例

MyCertificate の検証コードを生成します

az iot hub certificate generate-verification-code --hub-name MyIotHub --name MyCertificate --etag AAAAAAAAAAA=

Azure IoT Hub 証明書の検証コードを生成します (自動生成)

az iot hub certificate generate-verification-code --etag AAAAAAAAAAA= --hub-name MyIotHub --name MyCertificate --resource-group MyResourceGroup --subscription MySubscription

必須のパラメーター

--etag -e

オブジェクトのエンティティ タグ (etag)。

--name -n

証明書のフレンドリ名。

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot hub certificate list

編集

Azure IoT Hub に含まれるすべての証明書を一覧表示します。

Azure IoT Hub の CA 証明書の詳細については、次を参照してください https://docs.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview。

az iot hub certificate list [--hub-name]
                            [--ids]
                            [--resource-group]
                            [--subscription]

例

MyIotHub ですべての証明書を一覧表示する

az iot hub certificate list --hub-name MyIotHub

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot hub certificate show

編集

特定の Azure IoT Hub 証明書に関する情報を表示します。

Azure IoT Hub の CA 証明書の詳細については、次を参照してください https://docs.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview。

az iot hub certificate show --name
                            [--hub-name]
                            [--ids]
                            [--resource-group]
                            [--subscription]

例

MyCertificate の詳細を表示する

az iot hub certificate show --hub-name MyIotHub --name MyCertificate

特定の Azure IoT Hub 証明書に関する情報を表示します (自動生成)

az iot hub certificate show --hub-name MyIotHub --name MyCertificate --resource-group MyResourceGroup --subscription MySubscription

必須のパラメーター

--name -n

証明書のフレンドリ名。

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot hub certificate update

編集

Azure IoT Hub 証明書を更新します。

既存の証明書を同じ名前に置き換える新しい証明書をアップロードします。 Azure IoT Hub の CA 証明書の詳細については、次を参照してください https://docs.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview。

az iot hub certificate update --etag
                              --name
                              --path
                              [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--subscription]
                              [--verified {false, true}]

例

新しい PEM ファイルをアップロードして、IoT ハブに CA 証明書を更新します。

az iot hub certificate update --hub-name MyIotHub --name MyCertificate --path /certificates/NewCertificate.pem --etag AAAAAAAAAAA=

新しい CER ファイルをアップロードして、IoT ハブに CA 証明書を更新します。

az iot hub certificate update --hub-name MyIotHub --name MyCertificate --path /certificates/NewCertificate.cer --etag AAAAAAAAAAA=

必須のパラメーター

--etag -e

オブジェクトのエンティティ タグ (etag)。

--name -n

証明書のフレンドリ名。

--path -p

証明書を含むファイルへのパス。

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verified -v

証明書が検証されるかどうかを示すブール値。

承認された値: false, true
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot hub certificate verify

編集

Azure IoT Hub 証明書を検証します。

generate-verification-code を呼び出して取得した検証コードを含む検証証明書をアップロードして、証明書を検証します。 これは所有証明プロセスの最後のステップです。 Azure IoT Hub の CA 証明書の詳細については、次を参照してください https://docs.microsoft.com/azure/iot-hub/iot-hub-x509ca-overview。

az iot hub certificate verify --etag
                              --name
                              --path
                              [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--subscription]

例

MyCertificate 秘密キーの所有権を確認します。

az iot hub certificate verify --hub-name MyIotHub --name MyCertificate --path /certificates/Verification.pem --etag AAAAAAAAAAA=

Azure IoT Hub 証明書を検証します (自動生成)

az iot hub certificate verify --etag AAAAAAAAAAA= --hub-name MyIotHub --name MyCertificate --path /certificates/Verification.pem --resource-group MyResourceGroup --subscription MySubscription

必須のパラメーター

--etag -e

オブジェクトのエンティティ タグ (etag)。

--name -n

証明書のフレンドリ名。

--path -p

証明書を含むファイルへのパス。

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。