az iot central role

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 拡張機能は、az iot central role コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

IoT Central アプリケーションのロールを管理および構成します。

コマンド

名前	説明	型	状態
az iot central role list	IoT Central アプリケーションのロールの一覧を取得します。	Extension	GA
az iot central role show	ID でロールの詳細を取得します。	Extension	GA

az iot central role list

IoT Central アプリケーションのロールの一覧を取得します。

az iot central role list --app-id
                         [--api-version --av {2022-06-30-preview, 2022-07-31}]
                         [--central-api-uri --central-dns-suffix]
                         [--token]

例

アプリケーションのロールを一覧表示する

az iot central role list --app-id {appid}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

このコマンド パラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビュー バージョンを呼び出します。

プロパティ	値
規定値:	2022-07-31
指定可能な値:	2022-06-30-preview, 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

プロパティ	値
規定値:	azureiotcentral.com

--token

Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapiを参照してください。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az iot central role show

ID でロールの詳細を取得します。

az iot central role show --app-id
                         --role-id
                         [--api-version --av {2022-06-30-preview, 2022-07-31}]
                         [--central-api-uri --central-dns-suffix]
                         [--token]

例

ロールの詳細を取得する

az iot central role show --app-id {appid} --role-id {roleId}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

--role-id -r

ロールの一意識別子。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

このコマンド パラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビュー バージョンを呼び出します。

プロパティ	値
規定値:	2022-07-31
指定可能な値:	2022-06-30-preview, 2022-07-31

--central-api-uri --central-dns-suffix

アプリケーションに関連付けられている IoT Central DNS サフィックス。

プロパティ	値
規定値:	azureiotcentral.com

--token

Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapiを参照してください。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False