テナント
重要
これは Azure Sphere (レガシ) のドキュメントです。 Azure Sphere (レガシ) は 2027 年 9 月 27 日に 再提供されておりユーザーは現時点で Azure Sphere (統合) に移行する必要があります。 TOC の上にある Version セレクターを使用して、Azure Sphere (統合) のドキュメントを表示します。
Azure Sphere テナントを管理します。
重要
コマンド azsphere tenant download-ca-certificate、 azsphere tenant download-ca-certificate-chain、および azsphere tenant download-validation-certificate は廃止されています。 代わりに azsphere ca-certificate download、azsphere ca-certificate download-chain、azsphere ca-certificate download-proof、および azsphere ca-certificate listを使用してください。
Azure Sphere CLI では、 テナントの作成時に既定のテナントが自動的に選択されません。 azsphere tenant select コマンドを実行して、PC 上の現在のユーザーに使用する既定のテナントを選択する必要があります。 これは、デバイスのオーバーレイなど、元に戻すことができない 1 回限りの操作を実行するときに、既定のテナントが正しく使用されるようにするため。
| 操作 | 説明 |
|---|---|
| create | 新しいテナントを作成します。 |
| download-error-report | 現在のテナント内のデバイスのエラー情報を返します。 |
| list | 使用可能な Azure Sphere テナントを一覧表示します。 |
| 選択 | このコンピューターで使用する既定の Azure Sphere テナントを選択します。 |
| show-selected | このコンピューターの既定の Azure Sphere テナントを表示します。 |
| update | テナントの名前など、テナントの詳細を更新します。 |
create
新しい Azure Sphere テナントを作成します。 このコマンドを実行するには、接続されているデバイスが必要です。 詳細については、「 Azure Sphere テナントの作成」を参照してください。
既にテナントがあり、別のテナントが必要なことが明らかな場合は、--force-additional パラメーターを使用します。 現時点では、Azure Sphere テナントを削除することはできません。
テナントが作成されたら、 azsphere tenant select を実行して、この PC 上の現在のユーザーに使用する既定のテナントを選択します。 azsphere role add コマンドを使用して、現在の Azure Sphere テナントのユーザーのロールを追加できます。
azsphere tenant create コマンドは、ローカルに接続されている Azure Sphere デバイスで機能します。 デバイスが接続されていないのにコマンドを実行しようとすると、エラーが発生します。 デバイス ID はテナントを作成するときに記録され、デバイスごとに作成できるテナントは 1 つだけです。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -n, --name | String | テナントの名前を指定します。 テナントに名前を付けるときは、英数字を使用してください。 特殊文字は使用できません。 名前は 50 文字を超えてはなりません。大文字と小文字は区別されます。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -d、--device | String | 複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。 |
| --force-additional | Boolean | 新しい Azure Sphere テナントを強制的に作成します。 このコマンドは、現在のアカウントを使用して、接続されているデバイスを使用して新しい Azure Sphere テナントを作成することが確実な場合にのみ使用します。 |
| --disable-confirm-prompt | Boolean | ユーザー確認プロンプトを無効にします。 |
グローバル パラメーター
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 tenant create --name MyTenant
このアカウントを使用して、接続されたデバイスを使用して新しい Azure Sphere テナントを作成することが確実な場合は、 --force-additional パラメーターと --disable-confirm-prompt パラメーターを使用します。 以前に Azure Sphere テナントの作成に使用されたデバイスを使用して新しいテナントを作成することはできません。
azsphere tenant create --name MyTenant --force-additional
You have logged in with the following account:
bob@contoso.com
Do you want to use this account to create a new Azure Sphere tenant using the attached device?
You cannot change the tenant name 'MyTenant1' once it has been created.
Enter 'yes' to continue. Enter anything else to exit.
yes
> verbose: TraceId: c761ba73-761e-4df2-94f5-3f87384d71b7
Created a new Azure Sphere tenant:
--> Tenant Name: MyTenant1
--> Tenant ID: 768c2cd6-059a-49ad-9f53-89f5271cea15
Please use 'azsphere tenant select --tenant MyTenant' to select the created tenant.
ヒント
テナントを作成したら、 azsphere tenant select を実行して、この PC 上の現在のユーザーに使用する既定のテナントを選択します。
download-error-report
現在のテナント内のデバイスによって報告されたエラーに関する情報を返します。
このコマンドでは、Azure Sphere Security Service クラウドからイベント データがプルされます。特定のデバイスへの物理的な接続は必要ありません。 azsphere tenant download-error-report コマンドは、現在のテナントのコンテキストで動作し、そのテナント内のすべてのデバイスについてエラー レポートを返します。
Note
最近報告されたイベントがダウンロードできるようになるまでに最大 24 時間かかる場合があります。 詳細については、「 エラー データの収集と解釈を参照してください。
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| --行き先 | 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 tenant download-error-report --destination c:\error-report.csv --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
list
Azure Sphere テナントの一覧を表示します。
グローバル パラメーター
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 tenant list
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
SELECT…
この PC 上の現在のユーザーに使用する既定の Azure Sphere テナントを選択します。
現在の既定のテナントを表示するために、azsphere tenant show-selected を使用します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -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 tenant select --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
show-selected
この PC 上の現在のユーザーの既定の Azure Sphere テナントの詳細を表示します。
これは、azsphere tenant select コマンドで選択したテナントです。
グローバル パラメーター
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 tenant show-selected
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
update
テナントの名前など、テナントの詳細を更新します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -n、--new-name | String | テナントの新しい名前を指定します。 テナントに名前を付けるときは、英数字を使用してください。 特殊文字は使用できません。 名前は 50 文字を超えてはなりません。大文字と小文字は区別されます。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -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 tenant update --tenant a323c263-2aa3-2559-aabb-a3fc32631900 --new-name Tenant2
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
a323c263-2aa3-2559-aabb-a3fc32631900 Tenant2 Administrator
Contributor
------------------------------------ --------------------- -------------
ヒント
既定のテナントを選択していない場合は、使用可能なテナントの一覧が表示されます。 いずれかのオプションを選択して、既定のテナントを設定します。