az iot hub

Note

這個指令群組的指令在 Azure CLI 和至少一個擴充功能中都有定義。安裝每個擴充功能以受益於其擴充功能。深入了解擴充功能。

Manage Azure IoT hubs.

命令

名稱	Description	類型	狀態
az iot hub certificate	管理 IoT 中樞憑證。	核心和擴充功能	GA
az iot hub certificate create	Create/upload a Azure IoT 中樞 certificate.	Core	GA
az iot hub certificate create (azure-iot 擴充功能)	Create/upload a Azure IoT 中樞 certificate.	Extension	GA
az iot hub certificate delete	Deletes an Azure IoT 中樞 certificate.	Core	GA
az iot hub certificate delete (azure-iot 擴充功能)	Deletes an Azure IoT 中樞 certificate.	Extension	GA
az iot hub certificate generate-verification-code	會產生 Azure IoT 中樞憑證的驗證碼。	Core	GA
az iot hub certificate generate-verification-code (azure-iot 擴充功能)	會產生 Azure IoT 中樞憑證的驗證碼。	Extension	GA
az iot hub certificate list	列出 Azure IoT 中樞內所有憑證。	Core	GA
az iot hub certificate list (azure-iot 擴充功能)	列出 Azure IoT 中樞內所有憑證。	Extension	GA
az iot hub certificate show	顯示特定 Azure IoT 中樞憑證的資訊。	Core	GA
az iot hub certificate show (azure-iot 擴充功能)	顯示特定 Azure IoT 中樞憑證的資訊。	Extension	GA
az iot hub certificate update	更新 Azure IoT 中樞證書。	Core	GA
az iot hub certificate update (azure-iot 擴充功能)	更新 Azure IoT 中樞證書。	Extension	GA
az iot hub certificate verify	Verifyes a Azure IoT 中樞 certificate.	Core	GA
az iot hub certificate verify (azure-iot 擴充功能)	Verifyes a Azure IoT 中樞 certificate.	Extension	GA
az iot hub configuration	大規模管理 IoT 自動裝置管理設定。	Extension	GA
az iot hub configuration create	在目標 IoT 中樞建立一個物聯網自動裝置管理設定。	Extension	GA
az iot hub configuration delete	刪除IoT裝置設定。	Extension	GA
az iot hub configuration list	在 IoT 中樞中列出物聯網自動裝置管理設定。	Extension	GA
az iot hub configuration show	取得IoT自動裝置管理設定的詳細數據。	Extension	GA
az iot hub configuration show-metric	評估IoT裝置組態中定義的目標使用者或系統計量。	Extension	GA
az iot hub configuration update	更新IoT自動裝置管理設定的指定屬性。	Extension	GA
az iot hub connection-string	管理 IoT 中樞連線字串。	Extension	GA
az iot hub connection-string show	使用指定的原則名稱和索引鍵，顯示指定 IoT 中樞的連接字串。	Extension	GA
az iot hub consumer-group	管理IoT中樞的事件中樞取用者群組。	核心和擴充功能	GA
az iot hub consumer-group create	建立事件中樞取用者群組。	Core	GA
az iot hub consumer-group create (azure-iot 擴充功能)	建立事件中樞取用者群組。	Extension	GA
az iot hub consumer-group delete	刪除事件中樞取用者群組。	Core	GA
az iot hub consumer-group delete (azure-iot 擴充功能)	刪除事件中樞取用者群組。	Extension	GA
az iot hub consumer-group list	列出事件中樞取用者群組。	Core	GA
az iot hub consumer-group list (azure-iot 擴充功能)	列出事件中樞取用者群組。	Extension	GA
az iot hub consumer-group show	取得事件中樞取用者群組的詳細數據。	Core	GA
az iot hub consumer-group show (azure-iot 擴充功能)	取得事件中樞取用者群組的詳細數據。	Extension	GA
az iot hub create	Create an Azure IoT hub.	Core	GA
az iot hub create (azure-iot 擴充功能)	Create an Azure IoT hub.	Extension	GA
az iot hub delete	刪除 IoT 中樞。	Core	GA
az iot hub delete (azure-iot 擴充功能)	刪除 IoT 中樞。	Extension	GA
az iot hub device-identity	管理 IoT 裝置。	Extension	GA
az iot hub device-identity children	管理 IoT Edge 裝置的子裝置關聯性。	Extension	GA
az iot hub device-identity children add	將裝置新增為目標邊緣裝置的子系。	Extension	GA
az iot hub device-identity children list	輸出指派子裝置的集合。	Extension	GA
az iot hub device-identity children remove	從目標邊緣裝置移除子裝置。	Extension	GA
az iot hub device-identity connection-string	管理物聯網裝置的連接字串。	Extension	GA
az iot hub device-identity connection-string show	顯示給定的 IoT 中樞裝置連接字串。	Extension	GA
az iot hub device-identity create	在 IoT 中樞建立一個裝置。	Extension	GA
az iot hub device-identity delete	刪除一個 IoT 中樞裝置。	Extension	GA
az iot hub device-identity export	將所有裝置身份從 IoT 中樞匯出到 Azure 儲存體 blob container.	Extension	GA
az iot hub device-identity import	從儲存容器的 blob 匯入裝置身份到 IoT 中樞。	Extension	GA
az iot hub device-identity list	在 IoT 中樞中列出裝置。	Extension	GA
az iot hub device-identity parent	管理IoT裝置的父裝置關聯性。	Extension	GA
az iot hub device-identity parent set	設定目標裝置的父裝置。	Extension	GA
az iot hub device-identity parent show	取得目標裝置的父裝置。	Extension	GA
az iot hub device-identity renew-key	更新使用 SAS 認證的 IoT 中樞裝置目標金鑰。	Extension	GA
az iot hub device-identity show	取得 IoT 中樞裝置的詳細資訊。	Extension	GA
az iot hub device-identity update	更新一個 IoT 中樞裝置。	Extension	GA
az iot hub device-twin	管理 IoT 裝置對應項設定。	Extension	GA
az iot hub device-twin list	在 IoT 中樞中列出裝置雙胞胎。	Extension	GA
az iot hub device-twin replace	以目標 json 取代裝置對應項定義。	Extension	GA
az iot hub device-twin show	取得裝置對應項定義。	Extension	GA
az iot hub device-twin update	更新裝置對應項所需的屬性和標籤。	Extension	GA
az iot hub devicestream	管理 IoT 中樞的裝置串流。	Extension	Preview
az iot hub devicestream show	取得 IoT 中樞的裝置串流端點。	Extension	Preview
az iot hub digital-twin	操作並互動 IoT 中樞裝置的數位孿生。	Extension	GA
az iot hub digital-twin invoke-command	叫用數字對應項裝置的根或元件層級命令。	Extension	GA
az iot hub digital-twin show	展示 IoT 中樞裝置的數位孿生。	Extension	GA
az iot hub digital-twin update	透過 JSON 修補程式規格更新數位對應項裝置的讀寫屬性。	Extension	GA
az iot hub distributed-tracing	管理每個裝置的分散式設定。	Extension	Preview
az iot hub distributed-tracing show	取得裝置的分散式追蹤設定。	Extension	Preview
az iot hub distributed-tracing update	更新裝置的分散式追蹤選項。	Extension	Preview
az iot hub generate-sas-token	為目標 IoT 中樞、裝置或模組產生 SAS 令牌。	Extension	GA
az iot hub identity	Manage identitys of a Azure IoT hub.	核心和擴充功能	GA
az iot hub identity assign	將管理身份指派給 IoT 中樞。	Core	GA
az iot hub identity assign (azure-iot 擴充功能)	將管理身份指派給 IoT 中樞。	Extension	GA
az iot hub identity remove	移除 IoT 中樞中的受管理身份。	Core	GA
az iot hub identity remove (azure-iot 擴充功能)	移除 IoT 中樞中的受管理身份。	Extension	GA
az iot hub identity show	展示 IoT 中樞的身份屬性。	Core	GA
az iot hub identity show (azure-iot 擴充功能)	展示 IoT 中樞的身份屬性。	Extension	GA
az iot hub invoke-device-method	叫用裝置方法。	Extension	GA
az iot hub invoke-module-method	叫用模組方法。	Extension	GA
az iot hub job	Manage IoT 中樞 jobs （v2）.	Extension	GA
az iot hub job cancel	取消一個 IoT 中樞的任務。	Extension	GA
az iot hub job create	建立並排程一個 IoT 中樞工作以執行。	Extension	GA
az iot hub job list	列出 IoT 中樞的歷史職缺。	Extension	GA
az iot hub job show	顯示現有 IoT 中樞職缺的詳細資訊。	Extension	GA
az iot hub list	列出IoT中樞。	Core	GA
az iot hub list (azure-iot 擴充功能)	列出IoT中樞。	Extension	GA
az iot hub list-skus	列出可用的定價層。	Core	GA
az iot hub list-skus (azure-iot 擴充功能)	列出可用的定價層。	Extension	GA
az iot hub manual-failover	手動啟動 IoT 中樞到地理配對的災難復原區域的故障切換。	Core	GA
az iot hub manual-failover (azure-iot 擴充功能)	手動啟動 IoT 中樞到地理配對的災難復原區域的故障切換。	Extension	GA
az iot hub message-endpoint	管理 IoT 中樞的自訂端點。	Extension	Preview
az iot hub message-endpoint create	在 IoT 中樞上新增一個端點。	Extension	Preview
az iot hub message-endpoint create cosmosdb-container	為 IoT 中樞新增一個 Cosmos DB 容器端點。	Extension	Preview
az iot hub message-endpoint create eventhub	為 IoT 中樞新增一個 Event Hub 端點。	Extension	Preview
az iot hub message-endpoint create servicebus-queue	為 IoT 中樞新增一個服務匯流排 Queue 端點。	Extension	Preview
az iot hub message-endpoint create servicebus-topic	為 IoT 中樞新增一個服務匯流排主題端點。	Extension	Preview
az iot hub message-endpoint create storage-container	為 IoT 中樞新增一個儲存容器端點。	Extension	Preview
az iot hub message-endpoint delete	刪除所有或特定端點，用於 IoT 中樞。	Extension	Preview
az iot hub message-endpoint list	取得 IoT 中樞所有端點的資訊。	Extension	Preview
az iot hub message-endpoint show	取得上述 IoT 中樞端點的資訊。	Extension	Preview
az iot hub message-endpoint update	更新現有端點的屬性以啟用 IoT 中樞。	Extension	Preview
az iot hub message-endpoint update cosmosdb-container	更新現有 Cosmos DB 容器端點的屬性，以支援 IoT 中樞。	Extension	Preview
az iot hub message-endpoint update eventhub	更新現有 Event Hub 端點的屬性以啟用 IoT 中樞。	Extension	Preview
az iot hub message-endpoint update servicebus-queue	更新現有服務匯流排佇列端點的屬性，以支援 IoT 中樞。	Extension	Preview
az iot hub message-endpoint update servicebus-topic	更新現有服務匯流排主題端點的屬性，以支援 IoT 中樞。	Extension	Preview
az iot hub message-endpoint update storage-container	更新現有 Storage Container 端點的屬性以支援 IoT 中樞。	Extension	Preview
az iot hub message-enrichment	管理 IoT 中樞端點的訊息豐富功能。	核心和擴充功能	GA
az iot hub message-enrichment create	在您的 IoT 中樞中為所選端點建立訊息豐富內容。	Core	GA
az iot hub message-enrichment create (azure-iot 擴充功能)	在您的 IoT 中樞中為所選端點建立訊息豐富內容。	Extension	GA
az iot hub message-enrichment delete	刪除IoT中樞的訊息擴充（依索引鍵）。	Core	GA
az iot hub message-enrichment delete (azure-iot 擴充功能)	刪除IoT中樞的訊息擴充（依索引鍵）。	Extension	GA
az iot hub message-enrichment list	獲取所有訊息豐富功能，適用於你的 IoT 中樞。	Core	GA
az iot hub message-enrichment list (azure-iot 擴充功能)	獲取所有訊息豐富功能，適用於你的 IoT 中樞。	Extension	GA
az iot hub message-enrichment update	更新IoT中樞的訊息擴充（依金鑰）。	Core	GA
az iot hub message-enrichment update (azure-iot 擴充功能)	更新IoT中樞的訊息擴充（依金鑰）。	Extension	GA
az iot hub message-route	管理 IoT 中樞的路由。	Extension	Preview
az iot hub message-route create	新增 IoT 中樞的路由。	Extension	Preview
az iot hub message-route delete	刪除所有路由或 IoT 中樞中提到的路由。	Extension	Preview
az iot hub message-route fallback	管理IoT中樞的後援路由。	Extension	Preview
az iot hub message-route fallback set	在 IoT 中樞中啟用或停用備用路由。	Extension	Preview
az iot hub message-route fallback show	展示 IoT 中樞的備用路徑。	Extension	Preview
az iot hub message-route list	把所有路由都放在 IoT 中樞裡。	Extension	Preview
az iot hub message-route show	在 IoT 中樞獲取路線資訊。	Extension	Preview
az iot hub message-route test	測試所有路由或在 IoT 中樞中提到的路徑。	Extension	Preview
az iot hub message-route update	更新 IoT 中樞的路由。	Extension	Preview
az iot hub module-identity	管理 IoT 裝置模組。	Extension	GA
az iot hub module-identity connection-string	管理物聯網裝置模組的連接字串。	Extension	GA
az iot hub module-identity connection-string show	顯示目標物聯網裝置模組的連接字串。	Extension	GA
az iot hub module-identity create	在目標物聯網裝置上建立一個模組，並設置在 IoT 中樞中。	Extension	GA
az iot hub module-identity delete	在 IoT 中樞中刪除一個裝置。	Extension	GA
az iot hub module-identity list	列出位於 IoT 中樞中物聯網裝置上的模組。	Extension	GA
az iot hub module-identity renew-key	更新使用 SAS 認證的 IoT 中樞裝置模組的目標金鑰。	Extension	GA
az iot hub module-identity show	在 IoT 中樞中取得物聯網裝置模組的詳細資訊。	Extension	GA
az iot hub module-identity update	更新一個 IoT 中樞裝置模組。	Extension	GA
az iot hub module-twin	管理 IoT 裝置模組對應項設定。	Extension	GA
az iot hub module-twin replace	以目標 json 取代模組對應項定義。	Extension	GA
az iot hub module-twin show	顯示模組對應項定義。	Extension	GA
az iot hub module-twin update	更新模組對應項所需的屬性和標籤。	Extension	GA
az iot hub monitor-events	監控裝置遙測與訊息傳送到 IoT 中樞。	Extension	GA
az iot hub monitor-feedback	監視裝置所傳送的意見反應，以確認雲端到裝置 (C2D) 訊息。	Extension	GA
az iot hub policy	管理 IoT 中樞的共用存取原則。	核心和擴充功能	GA
az iot hub policy create	在IoT中樞中建立新的共用存取原則。	Core	GA
az iot hub policy create (azure-iot 擴充功能)	在IoT中樞中建立新的共用存取原則。	Extension	GA
az iot hub policy delete	從 IoT 中樞刪除共用存取原則。	Core	GA
az iot hub policy delete (azure-iot 擴充功能)	從 IoT 中樞刪除共用存取原則。	Extension	GA
az iot hub policy list	列出IoT中樞的共用存取原則。	Core	GA
az iot hub policy list (azure-iot 擴充功能)	列出IoT中樞的共用存取原則。	Extension	GA
az iot hub policy renew-key	重新產生IoT中樞共用存取原則的金鑰。	Core	GA
az iot hub policy renew-key (azure-iot 擴充功能)	重新產生IoT中樞共用存取原則的金鑰。	Extension	GA
az iot hub policy show	取得IoT中樞共用存取原則的詳細數據。	Core	GA
az iot hub policy show (azure-iot 擴充功能)	取得IoT中樞共用存取原則的詳細數據。	Extension	GA
az iot hub query	使用強大的類 SQL 語言查詢 IoT 中樞。	Extension	GA
az iot hub show	取得IoT中樞的詳細數據。	Core	GA
az iot hub show (azure-iot 擴充功能)	取得IoT中樞的詳細數據。	Extension	GA
az iot hub show-quota-metrics	取得IoT中樞的配額計量。	Core	GA
az iot hub show-quota-metrics (azure-iot 擴充功能)	取得IoT中樞的配額計量。	Extension	GA
az iot hub show-stats	取得IoT中樞的統計數據。	Core	GA
az iot hub show-stats (azure-iot 擴充功能)	取得IoT中樞的統計數據。	Extension	GA
az iot hub state	管理 IoT 中樞的狀態。	Extension	Experimental
az iot hub state export	將 IoT 中樞的狀態匯出成檔案。	Extension	Experimental
az iot hub state import	將檔案中的 Hub 狀態匯入到 IoT 中樞。	Extension	Experimental
az iot hub state migrate	將一個中樞的狀態移轉至另一個中樞，而不儲存至檔案。	Extension	Experimental
az iot hub update	更新IoT中樞的元數據。	Core	GA
az iot hub update (azure-iot 擴充功能)	更新IoT中樞的元數據。	Extension	GA
az iot hub wait	等 IoT 中樞實例的操作完成後再說。	Core	GA

az iot hub create

編輯

Create an Azure IoT hub.

關於Azure IoT 中樞的介紹，請參見 https://learn.microsoft.com/azure/iot-hub/。

az iot hub create --name
                  --resource-group
                  [--acquire-policy-token]
                  [--c2d-max-delivery-count --cdd]
                  [--c2d-ttl --ct]
                  [--change-reference]
                  [--dds --disable-device-sas {false, true}]
                  [--disable-local-auth --dla {false, true}]
                  [--disable-module-sas --dms {false, true}]
                  [--edr --enforce-data-residency {false, true}]
                  [--fc --fileupload-storage-container-name]
                  [--fcs --fileupload-storage-connectionstring]
                  [--fd --feedback-max-delivery-count]
                  [--feedback-lock-duration --fld]
                  [--feedback-ttl --ft]
                  [--fileupload-notification-lock-duration --fnld]
                  [--fileupload-notification-max-delivery-count --fnd]
                  [--fileupload-notification-ttl --fnt]
                  [--fileupload-notifications --fn {false, true}]
                  [--fileupload-sas-ttl --fst]
                  [--fileupload-storage-auth-type --fsa {identityBased, keyBased}]
                  [--fileupload-storage-identity --fsi]
                  [--location]
                  [--mi-system-assigned {false, true}]
                  [--mi-user-assigned]
                  [--min-tls-version --mintls]
                  [--no-wait]
                  [--partition-count]
                  [--rd --retention-day]
                  [--role]
                  [--scopes]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--tags]
                  [--unit]

範例

在資源群組區域內建立一個免費價格層級 F1 的 IoT 中樞。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --sku F1 --partition-count 2

建立一個 IoT 中樞，包含標準價格層級的 S1 和 4 分區，位於「westus」區域，並標註標籤。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --tags a=b c=d

建立一個系統指派的管理身份的 IoT 中樞，並為該身份的儲存帳號指派角色和範圍。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --mi-system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

建立一個 IoT 中樞，並啟用本地認證、裝置 SAS 金鑰和模組 SAS 金鑰

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --disable-local-auth --disable-device-sas --disable-module-sas

建立一個強制執行資料駐留權的 IoT 中樞。這會停用跨區域災害復原。

az iot hub create --resource-group MyResourceGroup --name MyIoTHub --edr

必要參數

--name -n

IoT 中樞名稱。

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--c2d-max-delivery-count --cdd

IoT 中樞嘗試將雲端到裝置訊息傳遞至裝置的次數，介於 1 到 100 之間。

屬性	值
預設值:	10

--c2d-ttl --ct

IoT 中樞對裝置來說，訊息可被消耗的時間長度介於 1 至 48 小時之間。

屬性	值
預設值:	1

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--dds --disable-device-sas

布爾值，指出是否要停用所有裝置（包括 Edge 裝置，但不包括模組）限定範圍的 SAS 金鑰以進行驗證。

屬性	值
接受的值:	false, true

--disable-local-auth --dla

布爾值，指出是否要停用IoT中樞範圍的SAS金鑰以進行驗證。

屬性	值
接受的值:	false, true

--disable-module-sas --dms

布爾值，指出是否要停用模組範圍的SAS金鑰以進行驗證。

屬性	值
接受的值:	false, true

--edr --enforce-data-residency

透過關閉跨區域災難復原，強制此 IoT 中樞的資料駐留。在資源上設定此屬性后，這個屬性是不可變的。僅適用於選取的區域。了解更多資訊，請至 https://aka.ms/iothubdisabledr。

屬性	值
接受的值:	false, true

--fc --fileupload-storage-container-name

您上傳檔案的根容器名稱。容器不需要存在，但應該使用指定的 connectionString 來建立。

--fcs --fileupload-storage-connectionstring

就是檔案上傳到 Azure 儲存體帳號的連接字串。

--fd --feedback-max-delivery-count

IoT 中樞嘗試在意見反應佇列上傳遞訊息的次數，介於 1 到 100 之間。

屬性	值
預設值:	10

--feedback-lock-duration --fld

意見反應佇列的鎖定持續時間，介於 5 到 300 秒之間。

屬性	值
預設值:	5

--feedback-ttl --ft

IoT 中樞將在 1 到 48 小時內維護雲端到裝置訊息到期或傳遞意見反應的時間週期。

屬性	值
預設值:	1

--fileupload-notification-lock-duration --fnld

檔案上傳通知佇列的鎖定持續時間，介於 5 到 300 秒之間。

屬性	值
預設值:	5

--fileupload-notification-max-delivery-count --fnd

IoT 中樞嘗試在 1 到 100 之間傳遞檔案通知訊息的次數。

屬性	值
預設值:	10

--fileupload-notification-ttl --fnt

檔案上傳通知在 IoT 中樞到期前可使用的時間長度介於 1 至 48 小時之間。

屬性	值
預設值:	1

--fileupload-notifications --fn

一個布林值，表示是否要將上傳檔案的資訊記錄到 messages/servicebound/filenotifications IoT 中樞端點。

屬性	值
預設值:	False
接受的值:	false, true

--fileupload-sas-ttl --fst

IoT 中樞產生的 SAS URI 有效期為 1 至 24 小時。

屬性	值
預設值:	1

--fileupload-storage-auth-type --fsa

上傳檔案的 Azure 儲存體帳號的認證類型。

屬性	值
接受的值:	identityBased, keyBased

--fileupload-storage-identity --fsi

用於檔案上傳驗證的受控識別。使用 '[system]' 來參考系統指派的受控識別或資源標識符，以參考使用者指派的受控識別。

--location -l

你的 IoT 中樞位置。預設值是目標資源群組的位置。

--mi-system-assigned

為此中樞啟用系統指派的受控識別。

屬性	值
接受的值:	false, true

--mi-user-assigned

啟用此中樞的使用者指派受控識別。接受以空格分隔的身分識別資源標識符清單。

--min-tls-version --mintls

指定要支援此中樞的最低 TLS 版本。可以設定為「1.0」或「1.2」。例如，設定為「1.2」的最低 TLS 版本會導致使用低於 1.2 的 TLS 版本拒絕的用戶端。

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
預設值:	False

--partition-count

裝置到雲端訊息支援事件中樞的數據分割數目。

屬性	值
預設值:	4

--rd --retention-day

指定此 IoT 中樞將在 1 到 7 天之間維護裝置到雲端事件的時間長度。

屬性	值
預設值:	1

--role

要指派給中樞系統指派受控識別的角色。

--scopes

空間分隔的範圍清單，以指派系統指派受控識別的角色（--role）。

--sku

Azure IoT 中樞嘅定價層。請注意，每個訂用帳戶中只允許一個免費的IoT中樞實例（F1）。如果免費實例超過一個，則會擲回例外狀況。

屬性	值
預設值:	S1
接受的值:	B1, B2, B3, F1, S1, S2, S3

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--unit

你的 IoT 中樞裡的單位。

屬性	值
預設值:	1

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub create (azure-iot 擴充功能)

Create an Azure IoT hub.

關於Azure IoT 中樞的介紹，請參見 https://learn.microsoft.com/azure/iot-hub/。

az iot hub create --name
                  --resource-group
                  [--acquire-policy-token]
                  [--c2d-max-delivery-count --cdd]
                  [--c2d-ttl --ct]
                  [--change-reference]
                  [--custom-ns-role-id]
                  [--dds --disable-device-sas {false, true}]
                  [--disable-local-auth --dla {false, true}]
                  [--disable-module-sas --dms {false, true}]
                  [--edr --enforce-data-residency {false, true}]
                  [--fc --fileupload-storage-container-name]
                  [--fcs --fileupload-storage-connectionstring]
                  [--fd --feedback-max-delivery-count]
                  [--feedback-lock-duration --fld]
                  [--feedback-ttl --ft]
                  [--fileupload-notification-lock-duration --fnld]
                  [--fileupload-notification-max-delivery-count --fnd]
                  [--fileupload-notification-ttl --fnt]
                  [--fileupload-notifications --fn {false, true}]
                  [--fileupload-sas-ttl --fst]
                  [--fileupload-storage-auth-type --fsa {identityBased, keyBased}]
                  [--fileupload-storage-identity --fsi]
                  [--location]
                  [--mi-system-assigned {false, true}]
                  [--mi-user-assigned]
                  [--min-tls-version --mintls]
                  [--no-wait]
                  [--ns-identity-id]
                  [--ns-resource-id]
                  [--partition-count]
                  [--rd --retention-day]
                  [--role]
                  [--scopes]
                  [--skip-ns-ra {false, true}]
                  [--sku {B1, B2, B3, F1, GEN2, S1, S2, S3}]
                  [--tags]
                  [--unit]

範例

在資源群組區域內建立一個免費價格層級 F1 的 IoT 中樞。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --sku F1 --partition-count 2

建立一個 IoT 中樞，包含標準價格層級的 S1 和 4 分區，位於「westus」區域，並標註標籤。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --tags a=b c=d

建立一個系統指派的管理身份的 IoT 中樞，並為該身份的儲存帳號指派角色和範圍。

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --mi-system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

建立一個 IoT 中樞，並啟用本地認證、裝置 SAS 金鑰和模組 SAS 金鑰

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --disable-local-auth --disable-device-sas --disable-module-sas

建立一個強制執行資料駐留權的 IoT 中樞。這會停用跨區域災害復原。

az iot hub create --resource-group MyResourceGroup --name MyIoTHub --edr

建立一個帶有裝置登錄檔命名空間屬性的 Generation2 IoT 中樞。

az iot hub create --resource-group MyResourceGroup --name MyHub --sku GEN2 --ns-resource-id NamespaceResourceId --ns-identity-id UserIdentityResourceId

建立一個 Generation2 IoT 中樞，包含裝置登錄檔命名空間屬性和自訂角色指派。

az iot hub create --resource-group MyResourceGroup --name MyHub --sku GEN2 --ns-resource-id NamespaceResourceId --ns-identity-id UserIdentityResourceId --custom-ns-role-id RoleResourceId

建立一個 Generation2 IoT 中樞，包含裝置登錄檔命名空間屬性，並跳過角色指派。

az iot hub create --resource-group MyResourceGroup --name MyHub --sku GEN2 --ns-resource-id NamespaceResourceId --ns-identity-id UserIdentityResourceId --skip-ns-ra

必要參數

--name -n

IoT 中樞名稱。

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--c2d-max-delivery-count --cdd

IoT 中樞嘗試將雲端到裝置訊息傳遞至裝置的次數，介於 1 到 100 之間。

屬性	值
預設值:	10

--c2d-ttl --ct

IoT 中樞對裝置來說，訊息可被消耗的時間長度介於 1 至 48 小時之間。

屬性	值
預設值:	1

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--custom-ns-role-id

完整限定的角色定義 ID 以適用於 ADR 命名空間，格式為：/subscriptions/{subscriptionId}/providers/Microsoft。Authorization/roleDefinitions/{roleId}. 僅適用於 Gen2 IoT 中樞。

屬性	值
參數群組:	ADR Namespace Role Assignment Arguments

--dds --disable-device-sas

布爾值，指出是否要停用所有裝置（包括 Edge 裝置，但不包括模組）限定範圍的 SAS 金鑰以進行驗證。

屬性	值
接受的值:	false, true

--disable-local-auth --dla

布爾值，指出是否要停用IoT中樞範圍的SAS金鑰以進行驗證。

屬性	值
接受的值:	false, true

--disable-module-sas --dms

布爾值，指出是否要停用模組範圍的SAS金鑰以進行驗證。

屬性	值
接受的值:	false, true

--edr --enforce-data-residency

屬性	值
接受的值:	false, true

--fc --fileupload-storage-container-name

您上傳檔案的根容器名稱。容器不需要存在，但應該使用指定的 connectionString 來建立。

--fcs --fileupload-storage-connectionstring

就是檔案上傳到 Azure 儲存體帳號的連接字串。

--fd --feedback-max-delivery-count

IoT 中樞嘗試在意見反應佇列上傳遞訊息的次數，介於 1 到 100 之間。

屬性	值
預設值:	10

--feedback-lock-duration --fld

意見反應佇列的鎖定持續時間，介於 5 到 300 秒之間。

屬性	值
預設值:	5

--feedback-ttl --ft

IoT 中樞將在 1 到 48 小時內維護雲端到裝置訊息到期或傳遞意見反應的時間週期。

屬性	值
預設值:	1

--fileupload-notification-lock-duration --fnld

檔案上傳通知佇列的鎖定持續時間，介於 5 到 300 秒之間。

屬性	值
預設值:	5

--fileupload-notification-max-delivery-count --fnd

IoT 中樞嘗試在 1 到 100 之間傳遞檔案通知訊息的次數。

屬性	值
預設值:	10

--fileupload-notification-ttl --fnt

檔案上傳通知在 IoT 中樞到期前可使用的時間長度介於 1 至 48 小時之間。

屬性	值
預設值:	1

--fileupload-notifications --fn

一個布林值，表示是否要將上傳檔案的資訊記錄到 messages/servicebound/filenotifications IoT 中樞端點。

屬性	值
預設值:	False
接受的值:	false, true

--fileupload-sas-ttl --fst

IoT 中樞產生的 SAS URI 有效期為 1 至 24 小時。

屬性	值
預設值:	1

--fileupload-storage-auth-type --fsa

上傳檔案的 Azure 儲存體帳號的認證類型。

屬性	值
接受的值:	identityBased, keyBased

--fileupload-storage-identity --fsi

用於檔案上傳驗證的受控識別。使用 '[system]' 來參考系統指派的受控識別或資源標識符，以參考使用者指派的受控識別。

--location -l

你的 IoT 中樞位置。預設值是目標資源群組的位置。

--mi-system-assigned

為此中樞啟用系統指派的受控識別。

屬性	值
接受的值:	false, true

--mi-user-assigned

啟用此中樞的使用者指派受控識別。接受以空格分隔的身分識別資源標識符清單。

--min-tls-version --mintls

指定要支援此中樞的最低 TLS 版本。可以設定為「1.0」或「1.2」。例如，設定為「1.2」的最低 TLS 版本會導致使用低於 1.2 的 TLS 版本拒絕的用戶端。

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
預設值:	False

--ns-identity-id

使用者受控識別資源識別碼，以存取裝置登錄命名空間。

--ns-resource-id

Device Registry 命名空間資源識別碼，以連結至此 IoT 中樞。

--partition-count

裝置到雲端訊息支援事件中樞的數據分割數目。

屬性	值
預設值:	4

--rd --retention-day

指定此 IoT 中樞將在 1 到 7 天之間維護裝置到雲端事件的時間長度。

屬性	值
預設值:	1

--role

要指派給中樞系統指派受控識別的角色。

--scopes

空間分隔的範圍清單，以指派系統指派受控識別的角色（--role）。

--skip-ns-ra

用來在建立 IoT 中樞之後略過 ADR 命名空間角色指派。僅適用於 Gen2 IoT 中樞。

屬性	值
參數群組:	ADR Namespace Role Assignment Arguments
接受的值:	false, true

--sku

Azure IoT 中樞嘅定價層。請注意，每個訂用帳戶中只允許一個免費的IoT中樞實例（F1）。如果免費實例超過一個，則會擲回例外狀況。

屬性	值
預設值:	S1
接受的值:	B1, B2, B3, F1, GEN2, S1, S2, S3

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--unit

你的 IoT 中樞裡的單位。

屬性	值
預設值:	1

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub delete

編輯

刪除 IoT 中樞。

az iot hub delete [--acquire-policy-token]
                  [--change-reference]
                  [--ids]
                  [--name]
                  [--no-wait]
                  [--resource-group]
                  [--subscription]

範例

刪除 IoT 中樞。 (autogenerated)

az iot hub delete --name MyIoTHub --resource-group MyResourceGroup

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

一或多個資源識別碼（以空格分隔）。它應該是包含「資源標識碼」自變數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
預設值:	False

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub delete (azure-iot 擴充功能)

刪除 IoT 中樞。

az iot hub delete [--acquire-policy-token]
                  [--change-reference]
                  [--ids]
                  [--name]
                  [--no-wait]
                  [--resource-group]
                  [--subscription]

範例

刪除 IoT 中樞。 (autogenerated)

az iot hub delete --name MyIoTHub --resource-group MyResourceGroup

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
預設值:	False

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub generate-sas-token

為目標 IoT 中樞、裝置或模組產生 SAS 令牌。

針對裝置 SAS 令牌，原則參數只會用來存取裝置登錄。因此，原則應該具有登錄的讀取許可權。對於 IoT 中樞代幣，該政策是 SAS 的一部分。

az iot hub generate-sas-token [--acquire-policy-token]
                              [--auth-type {key, login}]
                              [--change-reference]
                              [--connection-string --cs]
                              [--device-id]
                              [--du --duration]
                              [--hub-name]
                              [--key-type --kt {primary, secondary}]
                              [--login]
                              [--module-id]
                              [--pn --policy-name]
                              [--resource-group]

範例

使用 iothubowner 政策和主鍵產生一個 IoT 中樞 SAS 令牌。

az iot hub generate-sas-token -n {iothub_name}

使用 registryRead 政策和次要金鑰產生一個 IoT 中樞 SAS 令牌。

az iot hub generate-sas-token -n {iothub_name} --policy registryRead --key-type secondary

使用 iothubowner 原則產生裝置 SAS 令牌，以存取 {iothub_name} 裝置登錄。

az iot hub generate-sas-token -d {device_id} -n {iothub_name}

使用IoT 中樞連接字串產生裝置 SAS 令牌（具備登錄檔存取權限）

az iot hub generate-sas-token -d {device_id} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

使用IoT 中樞連接字串產生Iot Hub SAS 代幣

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

使用裝置連接字串產生裝置 SAS 令牌

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

使用 Module 連接字串產生 Module SAS 代幣

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;ModuleId=mymodule;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--auth-type

指示操作是否應該自動產生政策金鑰，或使用目前的 Azure AD 會話。如果驗證類型是登入，而且會提供資源主機名，除非需要，否則將會略過資源查閱。您可以使用來設定預設值 az configure --defaults iothub-data-auth-type={auth-type-value}。

屬性	值
參數群組:	Access Control Arguments
預設值:	key
接受的值:	key, login

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--connection-string --cs

目標連接字串。此方法繞過 IoT 中樞登錄檔，直接從提供的對稱金鑰產生 SAS 令牌，無需進一步驗證。除了持續時間之外，所有其他命令參數都會被忽略。支援的連接字串類型：Iot 集線器、裝置、模組。

--device-id -d

目標裝置標識碼。

--du --duration

有效的令牌持續時間，以秒為單位。

屬性	值
預設值:	3600

--hub-name -n

IoT 中樞名稱或主機名稱。如果未提供 --login，則為必要項。

屬性	值
參數群組:	IoT Hub Identifier Arguments

--key-type --kt

用於驗證的共用存取原則金鑰類型。

屬性	值
預設值:	primary
接受的值:	primary, secondary

--login -l

此指令支援帶有執行動作權限的實體連接字串。使用來避免透過「az login」的工作階段登入。若同時提供實體連接字串與名稱，則該連接字串會優先。如果未提供 --hub-name，則為必要專案。

屬性	值
參數群組:	IoT Hub Identifier Arguments

--module-id -m

目標模組識別碼。

--pn --policy-name

針對目標 IoT 中樞實體的共用存取政策，並附有操作權限。

屬性	值
預設值:	iothubowner

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub invoke-device-method

叫用裝置方法。

az iot hub invoke-device-method --device-id
                                --method-name --mn
                                [--acquire-policy-token]
                                [--auth-type {key, login}]
                                [--change-reference]
                                [--hub-name]
                                [--login]
                                [--method-payload --mp]
                                [--resource-group]
                                [--timeout --to]

範例

在裝置上叫用直接方法。

az iot hub invoke-device-method --hub-name {iothub_name} --device-id {device_id} --method-name Reboot --method-payload '{"version":"1.0"}'

必要參數

--device-id -d

目標裝置標識碼。

--method-name --mn

叫用的目標方法。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--auth-type

屬性	值
參數群組:	Access Control Arguments
預設值:	key
接受的值:	key, login

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--hub-name -n

IoT 中樞名稱或主機名稱。如果未提供 --login，則為必要項。

屬性	值
參數群組:	IoT Hub Identifier Arguments

--login -l

屬性	值
參數群組:	IoT Hub Identifier Arguments

--method-payload --mp

要傳遞至方法的 Json 承載。必須是檔案路徑或原始 json。

屬性	值
預設值:	{}

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

--timeout --to

等候裝置方法結果的秒數上限。

屬性	值
預設值:	30

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub invoke-module-method

叫用模組方法。

此命令同時支援邊緣和非邊緣裝置模組。

az iot hub invoke-module-method --device-id
                                --method-name --mn
                                --module-id
                                [--acquire-policy-token]
                                [--auth-type {key, login}]
                                [--change-reference]
                                [--hub-name]
                                [--login]
                                [--method-payload --mp]
                                [--resource-group]
                                [--timeout --to]

範例

在邊緣裝置模組上叫用直接方法。

az iot hub invoke-module-method -n {iothub_name} -d {device_id} -m '$edgeAgent' --method-name 'RestartModule' --method-payload '{"schemaVersion": "1.0"}'

必要參數

--device-id -d

目標裝置標識碼。

--method-name --mn

叫用的目標方法。

--module-id -m

目標模組識別碼。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--auth-type

屬性	值
參數群組:	Access Control Arguments
預設值:	key
接受的值:	key, login

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--hub-name -n

IoT 中樞名稱或主機名稱。如果未提供 --login，則為必要項。

屬性	值
參數群組:	IoT Hub Identifier Arguments

--login -l

屬性	值
參數群組:	IoT Hub Identifier Arguments

--method-payload --mp

要傳遞至方法的 Json 承載。必須是檔案路徑或原始 json。

屬性	值
預設值:	{}

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

--timeout --to

等候模組方法結果的秒數上限。

屬性	值
預設值:	30

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub list

編輯

列出IoT中樞。

az iot hub list [--resource-group]

範例

列出訂用帳戶中的所有IoT中樞。

az iot hub list

列出資源群組『MyGroup』中的所有 IoT 中樞

az iot hub list --resource-group MyGroup

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub list (azure-iot 擴充功能)

列出IoT中樞。

az iot hub list [--resource-group]

範例

列出訂用帳戶中的所有IoT中樞。

az iot hub list

列出資源群組『MyGroup』中的所有 IoT 中樞

az iot hub list --resource-group MyGroup

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub list-skus

編輯

列出可用的定價層。

az iot hub list-skus [--acquire-policy-token]
                     [--change-reference]
                     [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

範例

列出可用的定價層。 (autogenerated)

az iot hub list-skus --name MyIoTHub

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub list-skus (azure-iot 擴充功能)

列出可用的定價層。

az iot hub list-skus [--acquire-policy-token]
                     [--change-reference]
                     [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

範例

列出可用的定價層。 (autogenerated)

az iot hub list-skus --name MyIoTHub

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub manual-failover

編輯

手動啟動 IoT 中樞到地理配對的災難復原區域的故障切換。

az iot hub manual-failover [--acquire-policy-token]
                           [--change-reference]
                           [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]

範例

起始從主要區域到次要區域的故障轉移「myhub」。

az iot hub manual-failover -n myhub

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
預設值:	False

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub manual-failover (azure-iot 擴充功能)

手動啟動 IoT 中樞到地理配對的災難復原區域的故障切換。

az iot hub manual-failover [--acquire-policy-token]
                           [--change-reference]
                           [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]

範例

起始從主要區域到次要區域的故障轉移「myhub」。

az iot hub manual-failover -n myhub

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
預設值:	False

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub monitor-events

監控裝置遙測與訊息傳送到 IoT 中樞。

此指令使用 azure-eventhub 的 AMQP 實作。

注意：即使訊息本文不可譯碼，也會顯示事件，在此情況下，事件承載部分會顯示為 {{不可譯碼的承載}}，其餘可用的事件屬性。

az iot hub monitor-events [--acquire-policy-token]
                          [--cg --consumer-group]
                          [--change-reference]
                          [--content-type --ct]
                          [--device-id]
                          [--device-query]
                          [--enqueued-time --et]
                          [--hub-name]
                          [--interface]
                          [--login]
                          [--mc --message-count]
                          [--module-id]
                          [--properties --props {all, anno, app, sys}]
                          [--resource-group]
                          [--timeout --to]
                          [--yes {false, true}]

範例

基本用法

az iot hub monitor-events -n {iothub_name}

基本用法IoT 中樞連接字串

az iot hub monitor-events -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

篩選目標裝置時的基本使用方式

az iot hub monitor-events -n {iothub_name} -d {device_id}

篩選標識碼中具有通配符的目標裝置時的基本用法

az iot hub monitor-events -n {iothub_name} -d Device*

使用 IoT 中樞查詢語言篩選裝置

az iot hub monitor-events -n {iothub_name} -q "select * from devices where tags.location.region = 'US'"

篩選裝置，並指定要系結的事件中樞取用者群組。

az iot hub monitor-events -n {iothub_name} -d {device_id} --cg {consumer_group_name}

接收訊息批註（訊息標頭）

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno

接收訊息批註 + 系統屬性。永不逾時。

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno sys --timeout 0

從所有裝置訊息接收所有訊息屬性

az iot hub monitor-events -n {iothub_name} --props all

接收所有訊息，並將訊息承載剖析為 JSON

az iot hub monitor-events -n {iothub_name} --content-type application/json

從中樞接收指定的訊息數目，然後關閉。

az iot hub monitor-events -n {iothub_name} --message-count {message_count}

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--cg --consumer-group -c

指定連接到事件中樞端點時要使用的取用者群組。

屬性	值
預設值:	$Default

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--content-type --ct

指定訊息承載的 Content-Type，以自動將輸出格式化為該類型。

--device-id -d

目標裝置標識碼。

--device-query -q

指定要篩選裝置的自訂查詢。

--enqueued-time --et -e

指出應該作為從分割區讀取訊息的起點的時間。單位是 unix epoch 之後的毫秒數。如果未使用任何時間，表示「現在」。

--hub-name -n

IoT 中樞名稱或主機名稱。如果未提供 --login，則為必要項。

屬性	值
參數群組:	IoT Hub Identifier Arguments

--interface -i

要篩選的目標介面標識碼。例如：dtmi：com：example：TemperatureController;1。

--login -l

屬性	值
參數群組:	IoT Hub Identifier Arguments

--mc --message-count

在終止監視器之前要擷取的遙測訊息數目。如果未指定，監視會持續執行，直到達到未從中樞接收訊息的逾時閾值為止。

--module-id -m

目標模組識別碼。

--properties --props -p

指出要輸出的關鍵訊息屬性。 sys = 系統屬性，應用程式 = 應用程式屬性，anno = 註釋。

屬性	值
接受的值:	all, anno, app, sys

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

--timeout --to -t

維護連線而不接收訊息的秒數上限。使用 0 表示無限大。

屬性	值
預設值:	300

--yes -y

略過使用者提示。表示接受動作。主要用於自動化案例。預設：false。

屬性	值
預設值:	False
接受的值:	false, true

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub monitor-feedback

監視裝置所傳送的意見反應，以確認雲端到裝置 (C2D) 訊息。

此指令使用 azure-eventhub 的 AMQP 實作。

az iot hub monitor-feedback [--acquire-policy-token]
                            [--auth-type {key, login}]
                            [--change-reference]
                            [--device-id]
                            [--hub-name]
                            [--login]
                            [--resource-group]
                            [--wait-on-msg]
                            [--yes {false, true}]

範例

基本用法

az iot hub monitor-feedback -n {iothub_name}

基本用法IoT 中樞連接字串

az iot hub monitor-feedback -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

篩選目標裝置時的基本使用方式

az iot hub monitor-feedback -n {iothub_name} -d {device_id}

收到具有特定識別碼的訊息時結束意見反應監視器（uuid）

az iot hub monitor-feedback -n {iothub_name} -d {device_id} -w {message_id}

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--auth-type

屬性	值
參數群組:	Access Control Arguments
預設值:	key
接受的值:	key, login

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--device-id -d

目標裝置標識碼。

--hub-name -n

IoT 中樞名稱或主機名稱。如果未提供 --login，則為必要項。

屬性	值
參數群組:	IoT Hub Identifier Arguments

--login -l

屬性	值
參數群組:	IoT Hub Identifier Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

--wait-on-msg -w

意見反應監視器會封鎖，直到收到具有特定標識碼（uuid）的訊息為止。

--yes -y

略過使用者提示。表示接受動作。主要用於自動化案例。預設：false。

屬性	值
預設值:	False
接受的值:	false, true

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub query

使用強大的類 SQL 語言查詢 IoT 中樞。

擷取裝置和模組對應項、作業和訊息路由的相關信息。如需相關資訊，請參閱 https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language 。

az iot hub query --query-command
                 [--acquire-policy-token]
                 [--auth-type {key, login}]
                 [--change-reference]
                 [--hub-name]
                 [--login]
                 [--resource-group]
                 [--top]

範例

查詢 Azure IoT 中樞中的所有裝置雙生數據。

az iot hub query -n {iothub_name} -q "select * from devices"

查詢目標裝置上的所有模組對應項數據。

az iot hub query -n {iothub_name} -q "select * from devices.modules where devices.deviceId = '{device_id}'"

必要參數

--query-command -q

要執行的用戶查詢。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--auth-type

屬性	值
參數群組:	Access Control Arguments
預設值:	key
接受的值:	key, login

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--hub-name -n

IoT 中樞名稱或主機名稱。如果未提供 --login，則為必要項。

屬性	值
參數群組:	IoT Hub Identifier Arguments

--login -l

屬性	值
參數群組:	IoT Hub Identifier Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

--top

要傳回的項目數目上限。根據預設，查詢沒有上限。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub show

編輯

取得IoT中樞的詳細數據。

az iot hub show [--ids]
                [--name]
                [--resource-group]
                [--subscription]

範例

取得IoT中樞的詳細數據。 (autogenerated)

az iot hub show --name MyIoTHub

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub show (azure-iot 擴充功能)

取得IoT中樞的詳細數據。

az iot hub show [--ids]
                [--name]
                [--resource-group]
                [--subscription]

範例

取得IoT中樞的詳細數據。 (autogenerated)

az iot hub show --name MyIoTHub

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub show-quota-metrics

編輯

取得IoT中樞的配額計量。

az iot hub show-quota-metrics [--acquire-policy-token]
                              [--change-reference]
                              [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

範例

取得IoT中樞的配額計量。 (autogenerated)

az iot hub show-quota-metrics --ids {ids}

取得IoT中樞的配額計量。 (autogenerated)

az iot hub show-quota-metrics --name MyIoTHub

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub show-quota-metrics (azure-iot 擴充功能)

取得IoT中樞的配額計量。

az iot hub show-quota-metrics [--acquire-policy-token]
                              [--change-reference]
                              [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

範例

取得IoT中樞的配額計量。 (autogenerated)

az iot hub show-quota-metrics --ids {ids}

取得IoT中樞的配額計量。 (autogenerated)

az iot hub show-quota-metrics --name MyIoTHub

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub show-stats

編輯

取得IoT中樞的統計數據。

az iot hub show-stats [--acquire-policy-token]
                      [--change-reference]
                      [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

範例

取得IoT中樞的統計數據。 (autogenerated)

az iot hub show-stats --name MyIoTHub

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub show-stats (azure-iot 擴充功能)

取得IoT中樞的統計數據。

az iot hub show-stats [--acquire-policy-token]
                      [--change-reference]
                      [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

範例

取得IoT中樞的統計數據。 (autogenerated)

az iot hub show-stats --name MyIoTHub

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub update

編輯

更新IoT中樞的元數據。

az iot hub update [--acquire-policy-token]
                  [--add]
                  [--c2d-max-delivery-count --cdd]
                  [--c2d-ttl --ct]
                  [--change-reference]
                  [--dds --disable-device-sas {false, true}]
                  [--disable-local-auth --dla {false, true}]
                  [--disable-module-sas --dms {false, true}]
                  [--fc --fileupload-storage-container-name]
                  [--fcs --fileupload-storage-connectionstring]
                  [--fd --feedback-max-delivery-count]
                  [--feedback-lock-duration --fld]
                  [--feedback-ttl --ft]
                  [--fileupload-notification-lock-duration --fnld]
                  [--fileupload-notification-max-delivery-count --fnd]
                  [--fileupload-notification-ttl --fnt]
                  [--fileupload-notifications --fn {false, true}]
                  [--fileupload-sas-ttl --fst]
                  [--fileupload-storage-auth-type --fsa {identityBased, keyBased}]
                  [--fileupload-storage-identity --fsi]
                  [--force-string]
                  [--ids]
                  [--min-tls-version --mintls]
                  [--name]
                  [--rd --retention-day]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--subscription]
                  [--tags]
                  [--unit]

範例

將記憶體容器設定新增至檔案上傳

az iot hub update --name MyIotHub --fileupload-storage-connectionstring "connection-string" \ --fileupload-storage-container-name "container_name"

新增防火牆篩選規則以接受來自IP遮罩127.0.0.0/31的流量。

az iot hub update --name MyIotHub --add properties.ipFilterRules filter_name=test-rule action=Accept ip_mask=127.0.0.0/31

更新IoT中樞的元數據。 (autogenerated)

az iot hub update --name MyIotHub --set properties.allocationPolicy="GeoLatency"

將 IoT 中樞的單元更新為 2 並新增標籤

az iot hub update -n MyIotHub --unit 2 --tags a=b c=d

更新 IoT 中樞作為 S2 的定價層級

az iot hub update -n MyIotHub --sku S2

將 IoT 中樞裝置到雲端事件的保留天數更新為 3 天

az iot hub update -n MyIotHub --retention-day 3

更新 IoT 中樞雲端對裝置訊息設定

az iot hub update --name MyIotHub --c2d-max-delivery-count 30 --c2d-ttl 5

更新 IoT 中樞的回饋佇列設定

az iot hub update --name MyIoTHub --feedback-max-delivery-count 20 --feedback-lock-duration 100 --feedback-ttl 4

更新 IoT 中樞檔案上傳設定，並為使用者指派一個受管理身份以上傳檔案

az iot hub update -n MyIoTHub --fileupload-sas-ttl 5 --fileupload-storage-auth-type identityBased --fileupload-storage-identity [system]

更新 IoT 中樞檔案上傳通知設定及排隊鎖定時間

az iot hub update -n MyIoTHub --fileupload-notification-max-delivery-count 50 --fileupload-notification-ttl 48 --fileupload-notifications --fileupload-notification-lock-duration 10

更新 IoT 中樞的本地認證、裝置 SAS 及模組 SAS 設定

az iot hub update -n MyIoTHub --disable-local-auth --disable-device-sas false --disable-module-sas true

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。範例： --add property.listProperty <key=value, string or JSON string>.

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--c2d-max-delivery-count --cdd

IoT 中樞嘗試將雲端到裝置訊息傳遞至裝置的次數，介於 1 到 100 之間。

--c2d-ttl --ct

IoT 中樞對裝置來說，訊息可被消耗的時間長度介於 1 至 48 小時之間。

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--dds --disable-device-sas

布爾值，指出是否要停用所有裝置（包括 Edge 裝置，但不包括模組）限定範圍的 SAS 金鑰以進行驗證。

屬性	值
接受的值:	false, true

--disable-local-auth --dla

布爾值，指出是否要停用IoT中樞範圍的SAS金鑰以進行驗證。

屬性	值
接受的值:	false, true

--disable-module-sas --dms

布爾值，指出是否要停用模組範圍的SAS金鑰以進行驗證。

屬性	值
接受的值:	false, true

--fc --fileupload-storage-container-name

您上傳檔案的根容器名稱。容器不需要存在，但應該使用指定的 connectionString 來建立。

--fcs --fileupload-storage-connectionstring

就是檔案上傳到 Azure 儲存體帳號的連接字串。

--fd --feedback-max-delivery-count

IoT 中樞嘗試在意見反應佇列上傳遞訊息的次數，介於 1 到 100 之間。

--feedback-lock-duration --fld

意見反應佇列的鎖定持續時間，介於 5 到 300 秒之間。

--feedback-ttl --ft

IoT 中樞將在 1 到 48 小時內維護雲端到裝置訊息到期或傳遞意見反應的時間週期。

--fileupload-notification-lock-duration --fnld

檔案上傳通知佇列的鎖定持續時間，介於 5 到 300 秒之間。

--fileupload-notification-max-delivery-count --fnd

IoT 中樞嘗試在 1 到 100 之間傳遞檔案通知訊息的次數。

--fileupload-notification-ttl --fnt

檔案上傳通知在 IoT 中樞到期前可使用的時間長度介於 1 至 48 小時之間。

--fileupload-notifications --fn

一個布林值，表示是否要將上傳檔案的資訊記錄到 messages/servicebound/filenotifications IoT 中樞端點。

屬性	值
接受的值:	false, true

--fileupload-sas-ttl --fst

IoT 中樞產生的 SAS URI 有效期為 1 至 24 小時。

--fileupload-storage-auth-type --fsa

上傳檔案的 Azure 儲存體帳號的認證類型。

屬性	值
接受的值:	identityBased, keyBased

--fileupload-storage-identity --fsi

用於檔案上傳驗證的受控識別。使用 '[system]' 來參考系統指派的受控識別或資源標識符，以參考使用者指派的受控識別。

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

屬性	值
參數群組:	Generic Update Arguments
預設值:	False

--ids

屬性	值
參數群組:	Resource Id Arguments

--min-tls-version --mintls

指定要支援此中樞的最低 TLS 版本。可以設定為「1.0」或「1.2」。例如，設定為「1.2」的最低 TLS 版本會導致使用低於 1.2 的 TLS 版本拒絕的用戶端。

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--rd --retention-day

指定此 IoT 中樞將在 1 到 7 天之間維護裝置到雲端事件的時間長度。

--remove

從清單中移除屬性或專案。範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--set

指定要設定的屬性路徑和值，以更新物件。範例： --set property1.property2=<value>.

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--sku

Azure IoT 中樞嘅定價層。請注意，每個訂用帳戶中只允許一個免費的IoT中樞實例（F1）。如果免費實例超過一個，則會擲回例外狀況。

屬性	值
接受的值:	B1, B2, B3, F1, S1, S2, S3

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--unit

你的 IoT 中樞裡的單位。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub update (azure-iot 擴充功能)

更新IoT中樞的元數據。

az iot hub update [--acquire-policy-token]
                  [--add]
                  [--c2d-max-delivery-count --cdd]
                  [--c2d-ttl --ct]
                  [--change-reference]
                  [--dds --disable-device-sas {false, true}]
                  [--disable-local-auth --dla {false, true}]
                  [--disable-module-sas --dms {false, true}]
                  [--fc --fileupload-storage-container-name]
                  [--fcs --fileupload-storage-connectionstring]
                  [--fd --feedback-max-delivery-count]
                  [--feedback-lock-duration --fld]
                  [--feedback-ttl --ft]
                  [--fileupload-notification-lock-duration --fnld]
                  [--fileupload-notification-max-delivery-count --fnd]
                  [--fileupload-notification-ttl --fnt]
                  [--fileupload-notifications --fn {false, true}]
                  [--fileupload-sas-ttl --fst]
                  [--fileupload-storage-auth-type --fsa {identityBased, keyBased}]
                  [--fileupload-storage-identity --fsi]
                  [--force-string]
                  [--ids]
                  [--min-tls-version --mintls]
                  [--name]
                  [--ns-identity-id]
                  [--rd --retention-day]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--sku {B1, B2, B3, F1, GEN2, S1, S2, S3}]
                  [--subscription]
                  [--tags]
                  [--unit]

範例

將記憶體容器設定新增至檔案上傳

az iot hub update --name MyIotHub --fileupload-storage-connectionstring "connection-string" \ --fileupload-storage-container-name "container_name"

新增防火牆篩選規則以接受來自IP遮罩127.0.0.0/31的流量。

az iot hub update --name MyIotHub --add properties.ipFilterRules filter_name=test-rule action=Accept ip_mask=127.0.0.0/31

更新IoT中樞的元數據。 (autogenerated)

az iot hub update --name MyIotHub --set properties.allocationPolicy="GeoLatency"

將 IoT 中樞的單元更新為 2 並新增標籤

az iot hub update -n MyIotHub --unit 2 --tags a=b c=d

更新 IoT 中樞作為 S2 的定價層級

az iot hub update -n MyIotHub --sku S2

將 IoT 中樞裝置到雲端事件的保留天數更新為 3 天

az iot hub update -n MyIotHub --retention-day 3

更新 IoT 中樞雲端對裝置訊息設定

az iot hub update --name MyIotHub --c2d-max-delivery-count 30 --c2d-ttl 5

更新 IoT 中樞的回饋佇列設定

az iot hub update --name MyIoTHub --feedback-max-delivery-count 20 --feedback-lock-duration 100 --feedback-ttl 4

更新 IoT 中樞檔案上傳設定，並為使用者指派一個受管理身份以上傳檔案

az iot hub update -n MyIoTHub --fileupload-sas-ttl 5 --fileupload-storage-auth-type identityBased --fileupload-storage-identity [system]

更新 IoT 中樞檔案上傳通知設定及排隊鎖定時間

az iot hub update -n MyIoTHub --fileupload-notification-max-delivery-count 50 --fileupload-notification-ttl 48 --fileupload-notifications --fileupload-notification-lock-duration 10

更新 IoT 中樞的本地認證、裝置 SAS 及模組 SAS 設定

az iot hub update -n MyIoTHub --disable-local-auth --disable-device-sas false --disable-module-sas true

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。範例： --add property.listProperty <key=value, string or JSON string>.

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--c2d-max-delivery-count --cdd

IoT 中樞嘗試將雲端到裝置訊息傳遞至裝置的次數，介於 1 到 100 之間。

--c2d-ttl --ct

IoT 中樞對裝置來說，訊息可被消耗的時間長度介於 1 至 48 小時之間。

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--dds --disable-device-sas

布爾值，指出是否要停用所有裝置（包括 Edge 裝置，但不包括模組）限定範圍的 SAS 金鑰以進行驗證。

屬性	值
接受的值:	false, true

--disable-local-auth --dla

布爾值，指出是否要停用IoT中樞範圍的SAS金鑰以進行驗證。

屬性	值
接受的值:	false, true

--disable-module-sas --dms

布爾值，指出是否要停用模組範圍的SAS金鑰以進行驗證。

屬性	值
接受的值:	false, true

--fc --fileupload-storage-container-name

您上傳檔案的根容器名稱。容器不需要存在，但應該使用指定的 connectionString 來建立。

--fcs --fileupload-storage-connectionstring

就是檔案上傳到 Azure 儲存體帳號的連接字串。

--fd --feedback-max-delivery-count

IoT 中樞嘗試在意見反應佇列上傳遞訊息的次數，介於 1 到 100 之間。

--feedback-lock-duration --fld

意見反應佇列的鎖定持續時間，介於 5 到 300 秒之間。

--feedback-ttl --ft

IoT 中樞將在 1 到 48 小時內維護雲端到裝置訊息到期或傳遞意見反應的時間週期。

--fileupload-notification-lock-duration --fnld

檔案上傳通知佇列的鎖定持續時間，介於 5 到 300 秒之間。

--fileupload-notification-max-delivery-count --fnd

IoT 中樞嘗試在 1 到 100 之間傳遞檔案通知訊息的次數。

--fileupload-notification-ttl --fnt

檔案上傳通知在 IoT 中樞到期前可使用的時間長度介於 1 至 48 小時之間。

--fileupload-notifications --fn

一個布林值，表示是否要將上傳檔案的資訊記錄到 messages/servicebound/filenotifications IoT 中樞端點。

屬性	值
接受的值:	false, true

--fileupload-sas-ttl --fst

IoT 中樞產生的 SAS URI 有效期為 1 至 24 小時。

--fileupload-storage-auth-type --fsa

上傳檔案的 Azure 儲存體帳號的認證類型。

屬性	值
接受的值:	identityBased, keyBased

--fileupload-storage-identity --fsi

用於檔案上傳驗證的受控識別。使用 '[system]' 來參考系統指派的受控識別或資源標識符，以參考使用者指派的受控識別。

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

屬性	值
參數群組:	Generic Update Arguments
預設值:	False

--ids

屬性	值
參數群組:	Resource Id Arguments

--min-tls-version --mintls

指定要支援此中樞的最低 TLS 版本。可以設定為「1.0」或「1.2」。例如，設定為「1.2」的最低 TLS 版本會導致使用低於 1.2 的 TLS 版本拒絕的用戶端。

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--ns-identity-id

使用者受控識別資源識別碼，以存取裝置登錄命名空間。

--rd --retention-day

指定此 IoT 中樞將在 1 到 7 天之間維護裝置到雲端事件的時間長度。

--remove

從清單中移除屬性或專案。範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--set

指定要設定的屬性路徑和值，以更新物件。範例： --set property1.property2=<value>.

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--sku

Azure IoT 中樞嘅定價層。請注意，每個訂用帳戶中只允許一個免費的IoT中樞實例（F1）。如果免費實例超過一個，則會擲回例外狀況。

屬性	值
接受的值:	B1, B2, B3, F1, GEN2, S1, S2, S3

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--unit

你的 IoT 中樞裡的單位。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot hub wait

編輯

等 IoT 中樞實例的操作完成後再說。

az iot hub wait [--acquire-policy-token]
                [--change-reference]
                [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--ids]
                [--interval]
                [--name]
                [--resource-group]
                [--subscription]
                [--timeout]
                [--updated]

範例

等到建立一個現有的 IoT 中樞實例時再說

az iot hub wait -n MyIoTHub --created

等 IoT 中樞實例被刪除後再說

az iot hub wait -n MyIoTHub --deleted

等到現有的 IoT 中樞實例變成 Active 狀態

az iot hub wait -n MyIoTHub --custom "properties.state=='Active'"

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--custom

等到條件符合自定義 JMESPath 查詢為止。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

屬性	值
參數群組:	Wait Condition Arguments

--deleted

等到刪除為止。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--exists

等候資源存在。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--ids

屬性	值
參數群組:	Resource Id Arguments

--interval

輪詢間隔以秒為單位。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	30

--name -n

IoT 中樞名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--timeout

以秒為單位的等候上限。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	3600

--updated

等到 provisioningState 更新為 'Succeeded'。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

意見反應

此頁面對您有幫助嗎？

共用方式為

az iot hub

命令

az iot hub create

範例

必要參數

選擇性參數

az iot hub create (azure-iot 擴充功能)

範例

必要參數

選擇性參數

az iot hub delete

範例

選擇性參數

az iot hub delete (azure-iot 擴充功能)

範例

選擇性參數

az iot hub generate-sas-token

範例

選擇性參數

az iot hub invoke-device-method

範例

必要參數

選擇性參數

az iot hub invoke-module-method

範例

必要參數

選擇性參數

az iot hub list

範例

選擇性參數

az iot hub list (azure-iot 擴充功能)

範例

選擇性參數

az iot hub list-skus

範例

選擇性參數

az iot hub list-skus (azure-iot 擴充功能)

範例

選擇性參數

az iot hub manual-failover

範例

選擇性參數

az iot hub manual-failover (azure-iot 擴充功能)

範例

選擇性參數

az iot hub monitor-events

範例

選擇性參數

az iot hub monitor-feedback

範例

選擇性參數

az iot hub query

範例

必要參數

選擇性參數

az iot hub show

範例

選擇性參數

az iot hub show (azure-iot 擴充功能)

範例

選擇性參數

az iot hub show-quota-metrics

範例

選擇性參數

az iot hub show-quota-metrics (azure-iot 擴充功能)

範例

選擇性參數

az iot hub show-stats

範例

選擇性參數

az iot hub show-stats (azure-iot 擴充功能)

範例

選擇性參數

az iot hub update

範例

選擇性參數

az iot hub update (azure-iot 擴充功能)

範例

選擇性參數