tenant
重要
這是 Azure Sphere （舊版） 檔。 Azure Sphere（舊版）將於 2027 年 9 月 27 日淘汰，且使用者此時必須移轉至 Azure Sphere（整合式）。 使用位於 TOC 上方的版本選取器來檢視 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 命令，以選取要用於計算機上目前使用者的預設租使用者。 這是為了確保預設租用戶是執行無法復原的一次性作業時要使用的正確租使用者，例如 宣告裝置。
| 作業 | 描述 |
|---|---|
| create | 建立新的租使用者。 |
| download-error-report | 傳回目前租用戶內裝置的錯誤資訊。 |
| 清單 | 列出可用的 Azure Sphere 租使用者。 |
| select | 選取此電腦上要使用的預設 Azure Sphere 租使用者。 |
| show-selected | 顯示此電腦的預設 Azure Sphere 租使用者。 |
| update | 更新租用戶的詳細數據，例如租用戶的名稱。 |
create
建立新的 Azure Sphere 租使用者。 需要連結的裝置才能執行此命令。 如需詳細資訊，請參閱 建立 Azure Sphere 租使用者。
如果您已經有租使用者，而且確實想要另一個租使用者，請使用 --force-additional 參數。 目前，您無法刪除 Azure Sphere 租使用者。
建立租用戶之後，請執行 azsphere tenant select 以選取 要用於此電腦上目前使用者的預設租使用者。 您可以使用 azsphere role add 命令，為目前 Azure Sphere 租使用者中的使用者新增角色。
azsphere tenant create 命令適用於本機連結的 Azure Sphere 裝置。 如果您嘗試命令但未連結裝置，您會收到錯誤。 當您建立租使用者時，會記錄裝置標識碼，而且每個裝置只能建立一個租使用者。
必要參數
| 參數 | 類型 | 描述 |
|---|---|---|
| -n, --name | String | 指定租用戶的名稱。 在為租用戶命名時，請使用英數字元。 不允許使用特殊字元。 名稱不得超過 50 個字元，且區分大小寫。 |
選擇性參數
| 參數 | 類型 | 描述 |
|---|---|---|
| -d， --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時，需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置，但您一次只能在 Linux 上連線一部裝置。 基於這個理由，Windows 不支援此參數，但不支援 Linux。 如果您使用此參數搭配Linux上的命令，則會傳回錯誤。 |
| --force-additional | 布林值 | 強制建立新的 Azure Sphere 租使用者。 只有當您確定要使用目前的帳戶來使用連結的裝置建立新的 Azure Sphere 租使用者時，才使用此命令。 |
| --disable-confirm-prompt | 布林值 | 停用使用者確認提示。 |
全域參數
Azure Sphere CLI 提供下列全域參數：
| 參數 | 描述 |
|---|---|
| --debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤，可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
| -h, --help | 列印 CLI 參考命令及其自變數的相關信息，並列出可用的子群組和命令。 |
| --only-show-errors | 只顯示錯誤，隱藏警告。 |
| -o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc（色彩化 JSON）、tsv （Tab-Separated Values）、數據表（人類可讀取的 ASCII 數據表），以及 yaml。 根據預設，CLI 會輸出 table。 若要深入瞭解可用的輸出格式，請參閱 Azure Sphere CLI 命令的輸出格式。 |
| --查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例，請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
| --verbose | 列印作業期間在 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 以選取 要用於此電腦上目前使用者的預設租使用者。
download-error-report
傳回目前租用戶內裝置所報告之錯誤的相關信息。
此命令會從 Azure Sphere 安全性服務雲端提取事件數據，而且不需要特定裝置的實體連線。 azsphere tenant download-error-report 命令可在目前租使用者的內容中運作，並傳回該租用戶內所有裝置的錯誤報告。
注意
最近回報的事件最多可能需要 24 小時才能下載。 如需詳細資訊，請參閱 收集及解譯錯誤數據。
選擇性參數
| 參數 | 類型 | 描述 |
|---|---|---|
| --目的地 | String | 指定輸出檔案的路徑和檔名。 |
| -t、 --tenant | GUID 或名稱 | 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。 |
全域參數
Azure Sphere CLI 提供下列全域參數：
| 參數 | 描述 |
|---|---|
| --debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤，可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
| -h, --help | 列印 CLI 參考命令及其自變數的相關信息，並列出可用的子群組和命令。 |
| --only-show-errors | 只顯示錯誤，隱藏警告。 |
| -o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc（色彩化 JSON）、tsv （Tab-Separated Values）、數據表（人類可讀取的 ASCII 數據表），以及 yaml。 根據預設，CLI 會輸出 table。 若要深入瞭解可用的輸出格式，請參閱 Azure Sphere CLI 命令的輸出格式。 |
| --查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例，請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
| --verbose | 列印作業期間在 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 | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤，可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
| -h, --help | 列印 CLI 參考命令及其自變數的相關信息，並列出可用的子群組和命令。 |
| --only-show-errors | 只顯示錯誤，隱藏警告。 |
| -o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc（色彩化 JSON）、tsv （Tab-Separated Values）、數據表（人類可讀取的 ASCII 數據表），以及 yaml。 根據預設，CLI 會輸出 table。 若要深入瞭解可用的輸出格式，請參閱 Azure Sphere CLI 命令的輸出格式。 |
| --查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例，請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
| --verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI，請參閱 全域參數 ，以取得可用選項的詳細資訊。
範例
azsphere tenant list
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
select
選取要用於此電腦上目前用戶的預設 Azure Sphere 租使用者。
若要顯示目前的預設租使用者，請使用 azsphere tenant show-selected。
必要參數
| 參數 | 類型 | 描述 |
|---|---|---|
| -t、 --tenant | GUID 或名稱 | 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。 |
全域參數
Azure Sphere CLI 提供下列全域參數：
| 參數 | 描述 |
|---|---|
| --debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤，可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
| -h, --help | 列印 CLI 參考命令及其自變數的相關信息，並列出可用的子群組和命令。 |
| --only-show-errors | 只顯示錯誤，隱藏警告。 |
| -o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc（色彩化 JSON）、tsv （Tab-Separated Values）、數據表（人類可讀取的 ASCII 數據表），以及 yaml。 根據預設，CLI 會輸出 table。 若要深入瞭解可用的輸出格式，請參閱 Azure Sphere CLI 命令的輸出格式。 |
| --查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例，請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
| --verbose | 列印作業期間在 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
顯示此電腦上目前用戶的預設 Azure Sphere 租使用者詳細數據。
這是使用 azsphere tenant select 命令選取的租使用者。
全域參數
Azure Sphere CLI 提供下列全域參數：
| 參數 | 描述 |
|---|---|
| --debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤，可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
| -h, --help | 列印 CLI 參考命令及其自變數的相關信息，並列出可用的子群組和命令。 |
| --only-show-errors | 只顯示錯誤，隱藏警告。 |
| -o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc（色彩化 JSON）、tsv （Tab-Separated Values）、數據表（人類可讀取的 ASCII 數據表），以及 yaml。 根據預設，CLI 會輸出 table。 若要深入瞭解可用的輸出格式，請參閱 Azure Sphere CLI 命令的輸出格式。 |
| --查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例，請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
| --verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 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 或名稱 | 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。 |
全域參數
Azure Sphere CLI 提供下列全域參數：
| 參數 | 描述 |
|---|---|
| --debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤，可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
| -h, --help | 列印 CLI 參考命令及其自變數的相關信息，並列出可用的子群組和命令。 |
| --only-show-errors | 只顯示錯誤，隱藏警告。 |
| -o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc（色彩化 JSON）、tsv （Tab-Separated Values）、數據表（人類可讀取的 ASCII 數據表），以及 yaml。 根據預設，CLI 會輸出 table。 若要深入瞭解可用的輸出格式，請參閱 Azure Sphere CLI 命令的輸出格式。 |
| --查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例，請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
| --verbose | 列印作業期間在 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
------------------------------------ --------------------- -------------
提示
如果您尚未選取預設租使用者，則會顯示可用的租用戶清單。 選取其中一個選項來設定預設租使用者。