az iot hub policy

IoT ハブの共有アクセス ポリシーを管理します。

コマンド

名前	説明	型	Status
az iot hub policy create	IoT ハブに新しい共有アクセス ポリシーを作成します。	コア	GA
az iot hub policy delete	IoT ハブから共有アクセス ポリシーを削除します。	コア	GA
az iot hub policy list	IoT ハブの共有アクセス ポリシーを一覧表示します。	コア	GA
az iot hub policy renew-key	IoT ハブの共有アクセス ポリシーのキーを再生成します。	コア	GA
az iot hub policy show	IoT ハブの共有アクセス ポリシーの詳細を取得します。	コア	GA

az iot hub policy create

IoT ハブに新しい共有アクセス ポリシーを作成します。

az iot hub policy create --hub-name
                         --name
                         --permissions
                         [--resource-group]

例

新しい共有アクセス ポリシーを作成します。

az iot hub policy create --hub-name MyIotHub --name new-policy --permissions RegistryWrite ServiceConnect DeviceConnect

必須のパラメーター

--hub-name

IoT Hub 名。

--name -n

共有アクセス ポリシー名。

--permissions

共有アクセス ポリシーのアクセス許可。 複数のアクセス許可にスペース区切りリストを使用します。 指定できる値: RegistryRead、RegistryWrite、ServiceConnect、DeviceConnect。

省略可能のパラメーター

--resource-group -g

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

グローバル パラメーター

--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 policy delete

IoT ハブから共有アクセス ポリシーを削除します。

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

例

IoT ハブから共有アクセス ポリシーを削除します。 (自動生成)

az iot hub policy delete --hub-name MyHub --name MySharedAccessPolicy

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

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

--name -n

共有アクセス ポリシー名。

--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 policy list

IoT ハブの共有アクセス ポリシーを一覧表示します。

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

例

IoT ハブの共有アクセス ポリシーを一覧表示します。 (自動生成)

az iot hub policy list --hub-name MyHub --resource-group MyResourceGroup

省略可能のパラメーター

--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 policy renew-key

IoT ハブの共有アクセス ポリシーのキーを再生成します。

az iot hub policy renew-key --renew-key {primary, secondary, swap}
                            [--hub-name]
                            [--ids]
                            [--name]
                            [--no-wait]
                            [--resource-group]
                            [--subscription]

例

IoT ハブの共有アクセス ポリシーの主キーを再生成します。

az iot hub policy renew-key --hub-name MyHub --name MySharedAccessPolicy --rk Primary

必須のパラメーター

--renew-key --rk

キーを再生成します。

承認された値: primary, secondary, swap

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

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

--name -n

共有アクセス ポリシー名。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--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 policy show

IoT ハブの共有アクセス ポリシーの詳細を取得します。

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

例

IoT ハブの共有アクセス ポリシーの詳細を取得します。 (自動生成)

az iot hub policy show --hub-name MyHub --name MySharedAccessPolicy

省略可能のパラメーター

--hub-name

IoT Hub 名。

--ids

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

--name -n

共有アクセス ポリシー名。

--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 を使います。