role
重要
これは Azure Sphere (レガシ) のドキュメントです。 Azure Sphere (レガシ) は 2027 年 9 月 27 日に 再提供されておりユーザーは現時点で Azure Sphere (統合) に移行する必要があります。 TOC の上にある Version セレクターを使用して、Azure Sphere (統合) のドキュメントを表示します。
ロールベースのアクセス制御 (RBAC) のために、テナント内のユーザー ロールを管理します。
| 操作 | description |
|---|---|
| add | ユーザーのロールを追加します。 |
| delete | ユーザー ロールを削除します。 |
| list | ユーザーとそのロールの一覧を表示します。 |
| show | 特定のユーザー アカウントに割り当てられたロールを返します。 |
| show-types | このテナントでサポートされているロールの一覧を表示します。 |
add
ユーザーにロールを追加します。
- 管理者は、テナント内のすべてのデバイスと操作に対するフル アクセス権を持っています。これには、他のユーザーを追加または削除するためのアクセス許可が含まれます。 管理者ロールは、既定ではテナントを作成するユーザーに割り当てられます。
- 共同作成者は、デバイスを追加し、デプロイを作成および変更することができます。 アプリケーションの作成、接続されているデバイスの管理、デプロイの更新を行うが、テナント アクセスの管理を担当していないソフトウェア開発者やハードウェア開発者には、共同作成者ロールを付与する必要があります。
- 閲覧者は、要求されたデバイス、デプロイ、デバイスからの任意のエラー報告データ (入手可能なとき) など、テナントに関する情報にアクセスできます。 このロールは、エンドユーザーのインストールで接続されたデバイスのパフォーマンスを追跡する責任を負うメンテナンス担当者や運用担当者に適しています。
Note
このコマンドを実行すると、ユーザーの Microsoft アカウントがまだ登録されていない場合、Azure Sphere に自動的に登録されます。 以前は、 register-user コマンドを使用して新しいユーザーを Azure Sphere に登録していました。これは、既存のテナント内の新しいロールにユーザーを追加するときに自動的に行われるようになり、register-user コマンドは非推奨になりました。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -u、--user | String | ユーザーの名前 (電子メール アドレス) を指定します。 |
| -r、--role | String | 選択したユーザーに割り当てるロールを指定します。 使用可能なロールは、管理者、共同作成者、閲覧者です。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
azsphere role add --user john@contoso.com --role Administrator
delete
現在または選択されている Azure Sphere テナントのユーザーからロールを削除します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -u、--user | String | ロールの削除元ユーザーを識別するユーザーの ID または電子メールを指定します。 |
| -r、--role | 列挙型 | 削除するロールを指定します。 使用可能なロールは、管理者、共同作成者、閲覧者です。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
Note
現在のユーザーの管理者ロールは、別の管理者のみが削除できます。
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
azsphere role delete --user bob@contoso.com --role contributor --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
list
現在のテナントまたは選択したテナントのユーザー ロールの一覧を表示します。
一覧の最初の 500 エントリより後は切り捨てられます。
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
azsphere role list --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
--------------------- -------------
Name Roles
===================================
bob@contoso.com Administrator
Contributor
--------------------- -------------
show
選択されたユーザーのロール情報を表示します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -u、--user | String | 表示するユーザー名 (メール アドレス)。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
azsphere role show --user john@contoso.com --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
-------------
Roles
=============
Administrator
Contributor
-------------
show-types
このテナントで割り当て可能なロールを表示します。
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
azsphere role show-types
-------------
Result
=============
Administrator
-------------
Contributor
-------------
Reader
-------------