az iot ops identity
Note
このリファレンスは、Azure CLI (バージョン 2.62.0 以降) の azure-iot-ops 拡張機能の一部です。 拡張機能は、 az iot ops identity コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
インスタンス ID 管理。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az iot ops identity assign |
ユーザー割り当てマネージド ID をインスタンスに割り当てます。 |
Extension | GA |
az iot ops identity remove |
インスタンスからユーザー割り当てマネージド ID を削除します。 |
Extension | GA |
az iot ops identity show |
インスタンス ID を表示します。 |
Extension | GA |
az iot ops identity assign
ユーザー割り当てマネージド ID をインスタンスに割り当てます。
この操作には、該当する目的の ID のフェデレーションが含まれます。
--usage 'schema' が存在する場合、既定では、想定されるロールがまだ存在しない場合、インスタンス スキーマ レジストリに対する ID のロール割り当てが行われます。
az iot ops identity assign --mi-user-assigned
--name
--resource-group
[--custom-sr-role-id]
[--fc]
[--self-hosted-issuer {false, true}]
[--skip-sr-ra {false, true}]
[--usage {dataflow, schema}]
例
データフローで使用するために必要なユーザー割り当てマネージド ID を割り当ててフェデレーションします。
az iot ops identity assign --name myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID
スキーマ レジストリで使用するために、必要なユーザー割り当てマネージド ID を割り当ててフェデレーションします。
az iot ops identity assign --name myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --usage schema
スキーマ レジストリで使用するユーザー割り当てマネージド ID を、ID ロールの割り当てに使用するカスタム ロールと共に割り当ててフェデレーションします。
az iot ops identity assign --name myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --usage schema --custom-sr-role-id $CUSTOM_ROLE_ID
スキーマ レジストリで使用するために必要なユーザー割り当てマネージド ID を割り当ててフェデレーションしますが、操作のロールの割り当て手順はスキップします。
az iot ops identity assign --name myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --usage schema --skip-sr-ra
必須のパラメーター
インスタンスで使用するユーザー割り当てマネージド ID のリソース ID。
IoT Operations インスタンス名。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleDefinitions/{roleId} の形式の完全修飾ロール定義 ID。 --usage が 'schema' に設定されている場合にのみ適用されます。
フェデレーション資格情報の名前。
フェデレーションには、セルフホステッド oidc 発行者を使用します。
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
使用すると、操作のロールの割り当て手順がスキップされます。 --usage が 'schema' に設定されている場合にのみ適用されます。
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
関連付けられている ID の使用の種類を示します。
プロパティ | 値 |
---|---|
規定値: | dataflow |
指定可能な値: | dataflow, schema |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az iot ops identity remove
インスタンスからユーザー割り当てマネージド ID を削除します。
az iot ops identity remove --mi-user-assigned
--name
--resource-group
[--fc]
例
目的のユーザー割り当てマネージド ID をインスタンスから削除します。
az iot ops identity remove --name myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID
必須のパラメーター
インスタンスで使用するユーザー割り当てマネージド ID のリソース ID。
IoT Operations インスタンス名。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
フェデレーション資格情報の名前。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az iot ops identity show
インスタンス ID を表示します。
az iot ops identity show --name
--resource-group
例
ターゲット インスタンスに関連付けられている ID を表示します。
az iot ops identity show --name myinstance -g myresourcegroup
必須のパラメーター
IoT Operations インスタンス名。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |