次の方法で共有

az iot central api-token

  • リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot central api-token コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

IoT Central アプリケーションの API トークンを管理します。

IoT Central を使用すると、IoT Central API へのアクセスに使用する API トークンを生成および管理できます。 API の詳細については、 を参照 https://aka.ms/iotcentraldocsapiしてください。

コマンド

名前 説明 型 状態
az iot central api-token create

IoT Central アプリケーションに関連付けられている API トークンを生成します。

 拡張子 GA
az iot central api-token delete

IoT Central アプリケーションに関連付けられている API トークンを削除します。

 拡張子 GA
az iot central api-token list

IoT Central アプリケーションに関連付けられている API トークンの一覧を取得します。

 拡張子 GA
az iot central api-token show

IoT Central アプリケーションに関連付けられている API トークンの詳細を取得します。

 拡張子 GA

az iot central api-token create

IoT Central アプリケーションに関連付けられている API トークンを生成します。

注: トークンを再度取得できないため、生成されたら書き留めます。

az iot central api-token create --app-id
                                --role
                                --tkid
                                [--api-version {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri]
                                [--org-id]
                                [--token]

例

新しい API トークンを追加する

az iot central api-token create --token-id {tokenId} --app-id {appId} --role admin

必須のパラメーター

--app-id -n

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

--role -r

このトークンまたはユーザーに関連付けられるロール。 組み込みロールのいずれかを指定することも、カスタム ロールのロール ID を指定することもできます。 詳細については、以下を https://aka.ms/iotcentral-customrolesdocs参照してください。

--tkid --token-id

このトークンに関連付けられている IoT Central ID 。許可される [0-9a-zA-Z-] で、最大長の制限は 40 です。 後で CLI または API を使用してこのトークンを変更または削除するときに使用する ID を指定します。

省略可能のパラメーター

--api-version --av
非推奨

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

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

指定可能な値: 2022-06-30-preview, 2022-07-31
規定値: 2022-07-31
--central-api-uri --central-dns-suffix

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

規定値: azureiotcentral.com
--org-id --organization-id

トークン ロールの割り当ての組織の ID。 api-version == 1.1-preview でのみ使用できます。

--token

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

グローバル パラメーター
--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 central api-token delete

IoT Central アプリケーションに関連付けられている API トークンを削除します。

az iot central api-token delete --app-id
                                --tkid
                                [--api-version {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri]
                                [--token]

例

API トークンを削除する

az iot central api-token delete --app-id {appid} --token-id {tokenId}

必須のパラメーター

--app-id -n

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

--tkid --token-id

このトークンに関連付けられている IoT Central ID 。許可される [0-9a-zA-Z-] で、最大長の制限は 40 です。 後で CLI または API を使用してこのトークンを変更または削除するときに使用する ID を指定します。

省略可能のパラメーター

--api-version --av
非推奨

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

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

指定可能な値: 2022-06-30-preview, 2022-07-31
規定値: 2022-07-31
--central-api-uri --central-dns-suffix

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

規定値: azureiotcentral.com
--token

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

グローバル パラメーター
--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 central api-token list

IoT Central アプリケーションに関連付けられている API トークンの一覧を取得します。

一覧の情報には、アプリケーション内のトークンに関する基本情報が含まれており、トークン値は含まれません。

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

例

API トークンの一覧

az iot central api-token list --app-id {appid}

必須のパラメーター

--app-id -n

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

省略可能のパラメーター

--api-version --av
非推奨

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

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

指定可能な値: 2022-06-30-preview, 2022-07-31
規定値: 2022-07-31
--central-api-uri --central-dns-suffix

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

規定値: azureiotcentral.com
--token

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

グローバル パラメーター
--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 central api-token show

IoT Central アプリケーションに関連付けられている API トークンの詳細を取得します。

IoT Central アプリの API トークンの詳細 (関連付けられているロールなど) を一覧表示します。

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

例

API トークンを取得する

az iot central api-token show --app-id {appid} --token-id {tokenId}

必須のパラメーター

--app-id -n

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

--tkid --token-id

このトークンに関連付けられている IoT Central ID 。許可される [0-9a-zA-Z-] で、最大長の制限は 40 です。 後で CLI または API を使用してこのトークンを変更または削除するときに使用する ID を指定します。

省略可能のパラメーター

--api-version --av
非推奨

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

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

指定可能な値: 2022-06-30-preview, 2022-07-31
規定値: 2022-07-31
--central-api-uri --central-dns-suffix

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

規定値: azureiotcentral.com
--token

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

グローバル パラメーター
--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 を使います。