テナント
Azure Sphere テナントを管理します。
大事な
コマンド azsphere tenant download-ca-certificate、、 azsphere tenant download-ca-certificate-chain、 azsphere tenant download-validation-certificate は廃止されています。 代わりに、、azsphere ca-certificate download-chain、azsphere ca-certificate download-proof、 をazsphere ca-certificate list使用azsphere ca-certificate downloadします。
Azure Sphere CLI では、テナントの作成時に既定の テナントが自動的に選択されません。 azsphere tenant select コマンドを実行して、PC 上の現在のユーザーに使用する既定のテナントを選択する必要があります。 これは、 デバイスの要求など、元に戻すことができない 1 回限りの操作を実行するときに、既定のテナントが正しく使用されるようにするためです。
| 操作 | 説明 |
|---|---|
| 作成 | 新しいテナントを作成します。 |
| download-error-report | 現在のテナント内のデバイスのエラー情報を返します。 |
| リスト | 使用可能な Azure Sphere テナントを一覧表示します。 |
| 選択 | このコンピューターで使用する既定の Azure Sphere テナントを選択します。 |
| show-selected | このコンピューターの既定の Azure Sphere テナントを表示します。 |
| 更新 | テナントの名前など、テナントの詳細を更新します。 |
作成
新しい 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 | 文字列 | テナントの名前を指定します。 テナントに名前を付ける場合は、英数字を使用します。 特殊文字は使用できません。 名前は 50 文字以内で、大文字と小文字が区別されます。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -d、--device | 文字列 | 複数のデバイスが接続されている場合にコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスのみを接続できます。 このため、このパラメーターは Windows ではサポートされますが、Linux ではサポートされません。 Linux の コマンドでこのパラメーターを使用すると、エラーが返されます。 |
| --force-additional | ブール | 新しい Azure Sphere テナントの作成を強制します。 このコマンドは、現在のアカウントを使用して、接続されているデバイスを使用して新しい Azure Sphere テナントを作成することが確実な場合にのみ使用します。 |
| --disable-confirm-prompt | ブール | ユーザー確認プロンプトを無効にします。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --デバッグ | ログ記録の詳細度を増やして、すべてのデバッグ ログを表示します。 バグが見つかる場合は、バグ レポートを送信するときに、 フラグを --debug 使用して生成された出力を指定します。 |
| -h、--help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o、--output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色付けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は を出力します table。 使用可能な出力形式の詳細については、「 Azure Sphere CLI コマンドの出力形式」を参照してください。 |
| --クエリ | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、「 JMESPath チュートリアル 」および 「Azure CLI コマンド出力のクエリ 」を参照してください。 |
| --詳細 | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログに使用 --debug します。 |
メモ
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、「 グローバル パラメーター 」を参照してください。
例
azsphere tenant create --name MyTenant
このアカウントを --force-additional 使用して、接続されているデバイスを使用して新しい Azure Sphere テナントを作成することが確実な場合は、 パラメーターと --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 コマンドは、現在のテナントのコンテキストで機能し、そのテナント内のすべてのデバイスのエラー レポートを返します。
メモ
最近報告されたイベントがダウンロードできるようになるには、最大で 24 時間かかる場合があります。 詳細については、「 エラー データの収集と解釈」を参照してください。
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| --先 | 文字列 | 出力ファイルのパスとファイル名を指定します。 |
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --デバッグ | ログ記録の詳細度を増やして、すべてのデバッグ ログを表示します。 バグが見つかる場合は、バグ レポートを送信するときに、 フラグを --debug 使用して生成された出力を指定します。 |
| -h、--help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o、--output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色付けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は を出力します table。 使用可能な出力形式の詳細については、「 Azure Sphere CLI コマンドの出力形式」を参照してください。 |
| --クエリ | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、「 JMESPath チュートリアル 」および 「Azure CLI コマンド出力のクエリ 」を参照してください。 |
| --詳細 | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログに使用 --debug します。 |
メモ
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、「 グローバル パラメーター 」を参照してください。
例
azsphere tenant download-error-report --destination c:\error-report.csv --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
リスト
Azure Sphere テナントを一覧表示します。
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --デバッグ | ログ記録の詳細度を増やして、すべてのデバッグ ログを表示します。 バグが見つかる場合は、バグ レポートを送信するときに、 フラグを --debug 使用して生成された出力を指定します。 |
| -h、--help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o、--output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色付けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は を出力します table。 使用可能な出力形式の詳細については、「 Azure Sphere CLI コマンドの出力形式」を参照してください。 |
| --クエリ | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、「 JMESPath チュートリアル 」および 「Azure CLI コマンド出力のクエリ 」を参照してください。 |
| --詳細 | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログに使用 --debug します。 |
メモ
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、「 グローバル パラメーター 」を参照してください。
例
azsphere tenant list
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
選択
この PC の現在のユーザーに使用する既定の Azure Sphere テナントを選択します。
現在の既定のテナントを表示するには、 azsphere tenant show-selected を使用します。
必須パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --デバッグ | ログ記録の詳細度を増やして、すべてのデバッグ ログを表示します。 バグが見つかる場合は、バグ レポートを送信するときに、 フラグを --debug 使用して生成された出力を指定します。 |
| -h、--help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o、--output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色付けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は を出力します table。 使用可能な出力形式の詳細については、「 Azure Sphere CLI コマンドの出力形式」を参照してください。 |
| --クエリ | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、「 JMESPath チュートリアル 」および 「Azure CLI コマンド出力のクエリ 」を参照してください。 |
| --詳細 | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログに使用 --debug します。 |
メモ
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 使用して生成された出力を指定します。 |
| -h、--help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o、--output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色付けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は を出力します table。 使用可能な出力形式の詳細については、「 Azure Sphere CLI コマンドの出力形式」を参照してください。 |
| --クエリ | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、「 JMESPath チュートリアル 」および 「Azure CLI コマンド出力のクエリ 」を参照してください。 |
| --詳細 | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログに使用 --debug します。 |
メモ
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、「 グローバル パラメーター 」を参照してください。
例
azsphere tenant show-selected
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
更新
テナントの名前など、テナントの詳細を更新します。
必須パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -n、--new-name | 文字列 | テナントの新しい名前を指定します。 テナントに名前を付ける場合は、英数字を使用します。 特殊文字は使用できません。 名前は 50 文字以内で、大文字と小文字が区別されます。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --デバッグ | ログ記録の詳細度を増やして、すべてのデバッグ ログを表示します。 バグが見つかる場合は、バグ レポートを送信するときに、 フラグを --debug 使用して生成された出力を指定します。 |
| -h、--help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o、--output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色付けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は を出力します table。 使用可能な出力形式の詳細については、「 Azure Sphere CLI コマンドの出力形式」を参照してください。 |
| --クエリ | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、「 JMESPath チュートリアル 」および 「Azure CLI コマンド出力のクエリ 」を参照してください。 |
| --詳細 | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログに使用 --debug します。 |
メモ
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
------------------------------------ --------------------- -------------
ヒント
既定のテナントを選択していない場合は、使用可能なテナントの一覧が表示されます。 いずれかのオプションを選択して、既定のテナントを設定します。