az iot hub
注意
此命令群組具有 Azure CLI 和至少一個擴充功能中定義的命令。 安裝每個擴充功能以受益於其擴充功能。 深入了解擴充功能。
管理 Azure IoT 中樞。
命令
az iot hub create
建立 Azure IoT 中樞。
如需 Azure IoT 中樞 簡介，請參閱 https://docs.microsoft.com/azure/iot-hub/。
az iot hub create --name
--resource-group
[--c2d-max-delivery-count]
[--c2d-ttl]
[--dds {false, true}]
[--disable-local-auth {false, true}]
[--disable-module-sas {false, true}]
[--edr {false, true}]
[--fc]
[--fcs]
[--fd]
[--feedback-lock-duration]
[--feedback-ttl]
[--fileupload-notification-lock-duration]
[--fileupload-notification-max-delivery-count]
[--fileupload-notification-ttl]
[--fileupload-notifications {false, true}]
[--fileupload-sas-ttl]
[--fileupload-storage-auth-type {identityBased, keyBased}]
[--fileupload-storage-identity]
[--location]
[--mi-system-assigned {false, true}]
[--mi-user-assigned]
[--min-tls-version]
[--no-wait]
[--partition-count]
[--rd]
[--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使用標準定價層 S1 和 4 個分割區，在 'westus' 區域中建立具有卷標的 IoT 中樞。
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}使用本機驗證、裝置SAS金鑰和模組 SAS 金鑰建立 IoT 中樞 全部停用
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必要參數
IoT 中樞 名稱。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
選擇性參數
IoT 中樞嘗試將雲端到裝置訊息傳遞至裝置的次數，介於 1 到 100 之間。
訊息在 1 到 48 小時之間，IoT 中樞 過期之前，裝置可以使用訊息的時間量。
布爾值，指出是否要停用所有裝置（包括 Edge 裝置，但不包括模組）限定範圍的 SAS 金鑰以進行驗證。
布爾值，指出是否要停用IoT中樞範圍的SAS金鑰以進行驗證。
布爾值，指出是否要停用模組範圍的SAS金鑰以進行驗證。
停用跨區域災害復原，以強制執行此 IoT 中樞 的數據落地。 在資源上設定此屬性后，這個屬性是不可變的。 僅適用於選取的區域。 請至https://aka.ms/iothubdisabledr，即可深入瞭解。
您上傳檔案的根容器名稱。 容器不需要存在，但應該使用指定的 connectionString 來建立。
上傳檔案之 Azure 儲存體 帳戶的 連接字串。
IoT 中樞嘗試在意見反應佇列上傳遞訊息的次數，介於 1 到 100 之間。
意見反應佇列的鎖定持續時間，介於 5 到 300 秒之間。
IoT 中樞將在 1 到 48 小時內維護雲端到裝置訊息到期或傳遞意見反應的時間週期。
檔案上傳通知佇列的鎖定持續時間，介於 5 到 300 秒之間。
IoT 中樞嘗試在 1 到 100 之間傳遞檔案通知訊息的次數。
檔案上傳通知可供服務在 1 到 48 小時之間過期之前取用的時間量，IoT 中樞。
布爾值，指出是否要將已上傳檔案的相關信息記錄到訊息/servicebound/filenotifications IoT 中樞 端點。
IoT 中樞 所產生的SAS URI 在到期前的時間長度，介於1到24小時之間。
上傳檔案之 Azure 儲存體 帳戶的驗證類型。
用於檔案上傳驗證的受控識別。 使用 '[system]' 來參考系統指派的受控識別或資源標識符，以參考使用者指派的受控識別。
您 IoT 中樞 的位置。 預設值為目標資源群組的位置。
為此中樞啟用系統指派的受控識別。
啟用此中樞的使用者指派受控識別。 接受以空格分隔的身分識別資源標識符清單。
指定要支援此中樞的最低 TLS 版本。 可以設定為 「1.2」 ，讓使用 1.2 以下 TLS 版本的用戶端遭到拒絕。
請勿等候長時間執行的作業完成。
裝置到雲端訊息支援事件中樞的數據分割數目。
指定此 IoT 中樞將在 1 到 7 天之間維護裝置到雲端事件的時間長度。
要指派給中樞系統指派受控識別的角色。
空間分隔的範圍清單，以指派系統指派受控識別的角色（--role）。
Azure IoT 中樞的定價層。 請注意，每個訂用帳戶中只允許一個免費的IoT中樞實例 （F1）。 如果免費實例超過一個，則會擲回例外狀況。
以空格分隔的標記：key[=value] [key[=value] ...]。使用 「清除現有的標記」。
您 IoT 中樞 中的單位。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub delete
刪除 IoT 中樞。
az iot hub delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]範例
刪除 IoT 中樞。 （ 自動產生 ）
az iot hub delete --name MyIoTHub --resource-group MyResourceGroup選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
IoT 中樞 名稱。
請勿等候長時間執行的作業完成。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub generate-sas-token
為目標 IoT 中樞、裝置或模組產生 SAS 令牌。
針對裝置 SAS 令牌，原則參數只會用來存取裝置登錄。 因此，原則應該具有登錄的讀取許可權。 對於 IoT 中樞 令牌，原則是 SAS 的一部分。
az iot hub generate-sas-token [--auth-type {key, login}]
[--connection-string]
[--device-id]
[--du]
[--hub-name]
[--key-type {primary, secondary}]
[--login]
[--module-id]
[--pn]
[--resource-group]範例
使用 iothubowner 原則和主鍵產生 IoT 中樞 SAS 令牌。
az iot hub generate-sas-token -n {iothub_name}使用登錄讀取原則和次要密鑰產生 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中樞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'使用模組 連接字串 產生模組 SAS 令牌
az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;ModuleId=mymodule;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'選擇性參數
指出作業是否應該自動衍生原則密鑰，或使用目前的 Azure AD 工作階段。 如果驗證類型是登入，而且會提供資源主機名，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>。
目標 連接字串。 這會略過 IoT 中樞 登錄，並直接從提供的對稱密鑰產生 SAS 令牌，而不需要進一步驗證。 除了持續時間之外，所有其他命令參數都會被忽略。 支援的 連接字串 類型：Iot 中樞、裝置、模組。
目標裝置標識碼。
有效的令牌持續時間，以秒為單位。
IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。
用於驗證的共用存取原則金鑰類型。
此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果提供實體 連接字串 和名稱，則 連接字串 優先。 如果未提供 --hub-name，則為必要專案。
目標模組識別碼。
具有目標 IoT 中樞 實體作業許可權的共用存取原則。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub invoke-device-method
叫用裝置方法。
az iot hub invoke-device-method --device-id
--method-name
[--auth-type {key, login}]
[--hub-name]
[--login]
[--method-payload]
[--resource-group]
[--timeout]範例
在裝置上叫用直接方法。
az iot hub invoke-device-method --hub-name {iothub_name} --device-id {device_id} --method-name Reboot --method-payload '{"version":"1.0"}'必要參數
目標裝置標識碼。
叫用的目標方法。
選擇性參數
指出作業是否應該自動衍生原則密鑰，或使用目前的 Azure AD 工作階段。 如果驗證類型是登入，而且會提供資源主機名，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>。
IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。
此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果提供實體 連接字串 和名稱，則 連接字串 優先。 如果未提供 --hub-name，則為必要專案。
要傳遞至 方法的 Json 承載。 必須是檔案路徑或原始 json。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
等候裝置方法結果的秒數上限。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub invoke-module-method
叫用模組方法。
此命令同時支援邊緣和非邊緣裝置模組。
az iot hub invoke-module-method --device-id
--method-name
--module-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--method-payload]
[--resource-group]
[--timeout]範例
在邊緣裝置模組上叫用直接方法。
az iot hub invoke-module-method -n {iothub_name} -d {device_id} -m '$edgeAgent' --method-name 'RestartModule' --method-payload '{"schemaVersion": "1.0"}'必要參數
目標裝置標識碼。
叫用的目標方法。
目標模組識別碼。
選擇性參數
指出作業是否應該自動衍生原則密鑰，或使用目前的 Azure AD 工作階段。 如果驗證類型是登入，而且會提供資源主機名，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>。
IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。
此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果提供實體 連接字串 和名稱，則 連接字串 優先。 如果未提供 --hub-name，則為必要專案。
要傳遞至 方法的 Json 承載。 必須是檔案路徑或原始 json。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
等候模組方法結果的秒數上限。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
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選擇性參數
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub list-skus
列出可用的定價層。
az iot hub list-skus [--ids]
[--name]
[--resource-group]
[--subscription]範例
列出可用的定價層。 （ 自動產生 ）
az iot hub list-skus --name MyIoTHub選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
IoT 中樞 名稱。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub manual-failover
起始 IoT 中樞到異地配對災害復原區域的手動容錯移轉。
az iot hub manual-failover [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]範例
起始從主要區域到次要區域的故障轉移 「myhub」。
az iot hub manual-failover -n myhub選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
IoT 中樞 名稱。
請勿等候長時間執行的作業完成。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub monitor-events
監視傳送至 IoT 中樞的裝置遙測和訊息。
此命令依賴 ，而且可能會在第一次執行時安裝相依的 Cython 套件 （uamqp）。 https://github.com/Azure/azure-uamqp-python
注意：即使訊息本文不可譯碼，也會顯示事件，在此情況下，事件承載部分會顯示為 {{不可譯碼的承載}}，其餘可用的事件屬性。
az iot hub monitor-events [--cg]
[--content-type]
[--device-id]
[--device-query]
[--enqueued-time]
[--hub-name]
[--interface]
[--login]
[--mc]
[--module-id]
[--properties {all, anno, app, sys}]
[--repair {false, true}]
[--resource-group]
[--timeout]
[--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}選擇性參數
指定連接到事件中樞端點時要使用的取用者群組。
指定訊息承載的 Content-Type，以自動將輸出格式化為該類型。
目標裝置標識碼。
指定要篩選裝置的自訂查詢。
指出應該作為從分割區讀取訊息的起點的時間。 單位是 unix epoch 之後的毫秒數。 如果未使用任何時間，表示「現在」。
IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。
要篩選的目標介面標識碼。 例如：dtmi：com：example：TemperatureController;1。
此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果提供實體 連接字串 和名稱，則 連接字串 優先。 如果未提供 --hub-name，則為必要專案。
在終止監視器之前要擷取的遙測訊息數目。 如果未指定，監視會持續執行，直到達到未從中樞接收訊息的逾時閾值為止。
目標模組識別碼。
指出要輸出的關鍵訊息屬性。 sys = 系統屬性，應用程式 = 應用程式屬性，anno = 註釋。
重新安裝與擴充功能版本相容的 uamqp 相依性。 預設：false。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
維護連線而不接收訊息的秒數上限。 使用 0 表示無限大。
略過使用者提示。 表示接受動作。 主要用於自動化案例。 預設：false。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub monitor-feedback
監視裝置所傳送的意見反應，以確認雲端到裝置 (C2D) 訊息。
此命令依賴 ，而且可能會在第一次執行時安裝相依的 Cython 套件 （uamqp）。 https://github.com/Azure/azure-uamqp-python.
az iot hub monitor-feedback [--auth-type {key, login}]
[--device-id]
[--hub-name]
[--login]
[--repair {false, true}]
[--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}選擇性參數
指出作業是否應該自動衍生原則密鑰，或使用目前的 Azure AD 工作階段。 如果驗證類型是登入，而且會提供資源主機名，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>。
目標裝置標識碼。
IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。
此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果同時提供實體 連接字串 和名稱，則 連接字串 優先。 如果未提供 --hub-name，則為必要專案。
重新安裝與擴充功能版本相容的 uamqp 相依性。 預設：false。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
意見反應監視器會封鎖，直到收到具有特定標識碼 （uuid） 的訊息為止。
略過使用者提示。 表示接受動作。 主要用於自動化案例。 預設：false。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub query
使用功能強大的 SQL 型語言來查詢 IoT 中樞。
擷取裝置和模組對應項、作業和訊息路由的相關信息。 如需相關資訊，請參閱 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language 。
az iot hub query --query-command
[--auth-type {key, login}]
[--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}'"必要參數
要執行的用戶查詢。
選擇性參數
指出作業是否應該自動衍生原則密鑰，或使用目前的 Azure AD 工作階段。 如果驗證類型是登入，而且會提供資源主機名，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>。
IoT 中樞 名稱或主機名。 如果未提供 --login，則為必要項。
此命令支援具有執行動作許可權的實體 連接字串。 使用來避免透過 「az login」 的工作階段登入。 如果提供實體 連接字串 和名稱，則 連接字串 優先使用。 如果未提供 --hub-name，則為必要專案。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
要傳回的項目數目上限。 根據預設，查詢沒有上限。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub show
取得IoT中樞的詳細數據。
az iot hub show [--ids]
[--name]
[--resource-group]
[--subscription]範例
取得IoT中樞的詳細數據。 （ 自動產生 ）
az iot hub show --name MyIoTHub選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
IoT 中樞 名稱。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub show-connection-string
此命令已被取代，並將在未來版本中移除。 請改用 'IoT Extension （azure-iot） connection-string 命令 （az iot hub connection-string show）'。
顯示 IoT 中樞的 連接字串。
az iot hub show-connection-string [--all]
[--hub-name]
[--ids]
[--key {primary, secondary}]
[--policy-name]
[--resource-group]
[--subscription]範例
使用預設原則和主鍵顯示IoT中樞 連接字串。
az iot hub show-connection-string --name MyIotHub使用原則 『service』 和次要密鑰顯示 IoT 中樞 連接字串。
az iot hub show-connection-string --name MyIotHub --policy-name service --key secondary顯示資源群組中所有IoT中樞的 連接字串。
az iot hub show-connection-string --resource-group MyResourceGroup顯示訂用帳戶中所有IoT中樞的 連接字串。
az iot hub show-connection-string顯示 IoT 中樞的 連接字串。 （ 自動產生 ）
az iot hub show-connection-string --key primary --policy-name MyPolicy選擇性參數
允許顯示所有共用存取原則。
IoT 中樞 名稱。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
要使用的金鑰。
要使用的共用存取原則。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub show-quota-metrics
取得IoT中樞的配額計量。
az iot hub show-quota-metrics [--ids]
[--name]
[--resource-group]
[--subscription]範例
取得IoT中樞的配額計量。 （ 自動產生 ）
az iot hub show-quota-metrics --ids {ids}取得IoT中樞的配額計量。 （ 自動產生 ）
az iot hub show-quota-metrics --name MyIoTHub選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
IoT 中樞 名稱。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub show-stats
取得IoT中樞的統計數據。
az iot hub show-stats [--ids]
[--name]
[--resource-group]
[--subscription]範例
取得IoT中樞的統計數據。 （ 自動產生 ）
az iot hub show-stats --name MyIoTHub選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
IoT 中樞 名稱。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub update
更新IoT中樞的元數據。
az iot hub update [--add]
[--c2d-max-delivery-count]
[--c2d-ttl]
[--dds {false, true}]
[--disable-local-auth {false, true}]
[--disable-module-sas {false, true}]
[--fc]
[--fcs]
[--fd]
[--feedback-lock-duration]
[--feedback-ttl]
[--fileupload-notification-lock-duration]
[--fileupload-notification-max-delivery-count]
[--fileupload-notification-ttl]
[--fileupload-notifications {false, true}]
[--fileupload-sas-ttl]
[--fileupload-storage-auth-type {identityBased, keyBased}]
[--fileupload-storage-identity]
[--force-string]
[--ids]
[--name]
[--rd]
[--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中樞的元數據。 （ 自動產生 ）
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選擇性參數
藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例：--add property.listProperty <key=value, string or JSON string>。
IoT 中樞嘗試將雲端到裝置訊息傳遞至裝置的次數，介於 1 到 100 之間。
訊息在 1 到 48 小時之間的 IoT 中樞 到期之前，可供裝置取用的時間量。
布爾值，指出是否要停用所有裝置（包括 Edge 裝置，但不包括模組）限定範圍的 SAS 金鑰以進行驗證。
布爾值，指出是否要停用IoT中樞範圍的SAS金鑰以進行驗證。
布爾值，指出是否要停用模組範圍的SAS金鑰以進行驗證。
您上傳檔案的根容器名稱。 容器不需要存在，但應該使用指定的 connectionString 來建立。
上傳檔案之 Azure 儲存體 帳戶的 連接字串。
IoT 中樞嘗試在意見反應佇列上傳遞訊息的次數，介於 1 到 100 之間。
意見反應佇列的鎖定持續時間，介於 5 到 300 秒之間。
IoT 中樞將在 1 到 48 小時內維護雲端到裝置訊息到期或傳遞意見反應的時間週期。
檔案上傳通知佇列的鎖定持續時間，介於 5 到 300 秒之間。
IoT 中樞嘗試在 1 到 100 之間傳遞檔案通知訊息的次數。
檔案上傳通知可供服務在 1 到 48 小時之間 IoT 中樞 到期之前取用的時間量。
布爾值，指出是否要將已上傳檔案的相關信息記錄至 messages/servicebound/filenotifications IoT 中樞 端點。
IoT 中樞 所產生的SAS URI 在到期前的時間長度，介於1到24小時之間。
上傳檔案之 Azure 儲存體 帳戶的驗證類型。
用於檔案上傳驗證的受控識別。 使用 '[system]' 來參考系統指派的受控識別或資源標識符，以參考使用者指派的受控識別。
使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
IoT 中樞 名稱。
指定此 IoT 中樞將在 1 到 7 天之間維護裝置到雲端事件的時間長度。
從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=<value>。
Azure IoT 中樞的定價層。 請注意，每個訂用帳戶中只允許一個免費的IoT中樞實例 （F1）。 如果免費實例超過一個，則會擲回例外狀況。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
以空格分隔的標記：key[=value] [key[=value] ...]。使用 「清除現有的標記」。
IoT 中樞 中的單位。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot hub wait
等到 IoT 中樞 實例上的作業完成為止。
az iot hub wait [--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 中樞 實例處於作用中狀態
az iot hub wait -n MyIoTHub --custom "properties.state=='Active'"選擇性參數
請等候在 'Succeeded' 使用 'provisioningState' 建立。
等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。
等到刪除為止。
等候資源存在。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
輪詢間隔以秒為單位。
IoT 中樞 名稱。
資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
以秒為單位的等候上限。
等到 provisioningState 更新為 'Succeeded'。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
