az iot central user

注

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

IoT Central ユーザーを管理および構成します。

コマンド

名前	説明	型	状態
az iot central user create	アプリケーションにユーザーを追加します。	拡張	GA
az iot central user delete	アプリケーションからユーザーを削除します。	拡張	GA
az iot central user list	IoT Central アプリケーションのユーザーの一覧を取得します。	拡張	GA
az iot central user show	ID でユーザーの詳細を取得します。	拡張	GA
az iot central user update	アプリケーション内のユーザーのロールを更新します。	拡張	GA

az iot central user create

アプリケーションにユーザーを追加します。

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

例

電子メールでアプリケーションにユーザーを追加する

az iot central user create --user-id {userId} --app-id {appId} --email {emailAddress} --role admin

アプリケーションにサービス プリンシパルを追加する

az iot central user create --user-id {userId} --app-id {appId} --tenant-id {tenantId} --object-id {objectId} --role operator

必須のパラメーター

--app-id -n

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

--assignee --user-id

ユーザーに関連付けられている ID。

--role -r

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

省略可能のパラメーター

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

--email

アプリに追加するユーザーの電子メール アドレス。 これを指定すると、サービス プリンシパル パラメーター (tenant_idとobject_id) は無視されます。

--object-id --oid

アプリに追加するサービス プリンシパルのオブジェクト ID。 テナント ID も指定する必要があります。 電子メールが指定されている場合、これは無視され、ユーザーはサービス プリンシパル ユーザーではなく、標準の "電子メール" ユーザーになります。

--org-id --organization-id

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

--tenant-id --tnid

アプリに追加されるサービス プリンシパルのテナント ID。 オブジェクト ID も指定する必要があります。 電子メールが指定されている場合、これは無視され、ユーザーはサービス プリンシパル ユーザーではなく、標準の "電子メール" ユーザーになります。

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

アプリケーションからユーザーを削除します。

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

例

ユーザーを削除する

az iot central user delete --app-id {appid} --user-id {userId}

必須のパラメーター

--app-id -n

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

--assignee --user-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 user list

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

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

例

ユーザーの一覧

az iot central user 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 user show

ID でユーザーの詳細を取得します。

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

例

ユーザーの詳細を取得する

az iot central user show --app-id {appid} --user-id {userId}

必須のパラメーター

--app-id -n

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

--assignee --user-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 user update

アプリケーション内のユーザーのロールを更新します。

別のロールを持つユーザーを更新します。 サービス プリンシパル ユーザーの tenantId または objectId の更新は許可されません。 メール ユーザーのメール アドレスの更新は許可されていません。

az iot central user update --app-id
                           --assignee
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--roles]
                           [--tenant-id]
                           [--token]

例

アプリケーションの電子メールまたはサービス プリンシパルによってユーザーのロールを更新します。

az iot central user update --user-id {userId} --app-id {appId} --roles "org1\admin"

必須のパラメーター

--app-id -n

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

--assignee --user-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

--email

アプリに追加するユーザーの電子メール アドレス。 これを指定すると、サービス プリンシパル パラメーター (tenant_idとobject_id) は無視されます。

--object-id --oid

アプリに追加するサービス プリンシパルのオブジェクト ID。 テナント ID も指定する必要があります。 電子メールが指定されている場合、これは無視され、ユーザーはサービス プリンシパル ユーザーではなく、標準の "電子メール" ユーザーになります。

--roles

このユーザーに関連付けられるロールのコンマ区切りの一覧。 組み込みロールのいずれかを指定することも、カスタム ロールのロール ID を指定することもできます。 詳細については、https://aka.ms/iotcentral-customrolesdocsを参照してください。 API バージョン == 1.1-preview で実行する場合、組織はロールと共に指定できます。 例: "organization_id\role"。

--tenant-id --tnid

アプリに追加されるサービス プリンシパルのテナント ID。 オブジェクト ID も指定する必要があります。 電子メールが指定されている場合、これは無視され、ユーザーはサービス プリンシパル ユーザーではなく、標準の "電子メール" ユーザーになります。

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