az iot central device-group
注意
此參考是 Azure CLI 的 azure-iot 延伸模組的一部分(2.46.0 版或更高版本)。 擴充功能會在您第一次執行 az iot central device-group 命令時自動安裝。 深入了解擴充功能。
管理及設定IoT Central裝置群組。
命令
名稱 | Description | 類型 | 狀態 |
---|---|---|---|
az iot central device-group create |
建立裝置群組。 |
副檔名 | GA |
az iot central device-group delete |
刪除裝置群組。 |
副檔名 | GA |
az iot central device-group list |
取得IoT Central應用程式的裝置群組清單。 |
副檔名 | GA |
az iot central device-group show |
依標識碼取得裝置群組。 |
副檔名 | GA |
az iot central device-group update |
更新現有的裝置群組。 |
副檔名 | GA |
az iot central device-group create
建立裝置群組。
注意:目前僅支援一個組織,很快就會支援多個組織。
az iot central device-group create --app-id
--device-group-id
--display-name
--filter
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--description]
[--organizations]
[--token]
範例
建立裝置群組。
az iot central device-group create --app-id {appid} --device-group-id {devicegroupid} --display-name "DeviceGroup1" --filter "SELECT * FROM devices WHERE $provisioned = true" --description "This is a default device group." --organizations {organization}
必要參數
您要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。
裝置群組的唯一標識碼。
裝置群組的顯示名稱。
查詢,定義此群組中應有哪些裝置。[查詢篩選範例:SELECT * FROM devices WHERE $template = “dtmi:modelDefinition:dtdlv2”]。
選擇性參數
自變數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的IoT Central DNS後綴。
裝置群組的簡短摘要。
裝置群組的組織標識碼清單。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者令牌來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot central device-group delete
刪除裝置群組。
az iot central device-group delete --app-id
--device-group-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
範例
刪除裝置群組
az iot central device-group delete --app-id {appid} --device-group-id {devicegroupid}
必要參數
您要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。
裝置群組的唯一標識碼。
選擇性參數
自變數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的IoT Central DNS後綴。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者令牌來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot central device-group list
取得IoT Central應用程式的裝置群組清單。
az iot central device-group list --app-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
範例
列出應用程式中的裝置群組
az iot central device-group list --app-id {appid}
必要參數
您要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。
選擇性參數
自變數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的IoT Central DNS後綴。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者令牌來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot central device-group show
依標識碼取得裝置群組。
az iot central device-group show --app-id
--device-group-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
範例
依標識碼取得裝置群組。
az iot central device-group show --app-id {appid} --device-group-id {devicegroupid}
必要參數
您要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。
裝置群組的唯一標識碼。
選擇性參數
自變數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的IoT Central DNS後綴。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者令牌來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az iot central device-group update
更新現有的裝置群組。
注意:目前僅支援一個組織,很快就會支援多個組織。
az iot central device-group update --app-id
--device-group-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--description]
[--display-name]
[--filter]
[--organizations]
[--token]
範例
透過修補程式更新裝置群組
az iot central device-group update --app-id {appid} --device-group-id {devicegroupid} --display-name {displayname} --filter {filter} --description {description} --organizations {organization}
必要參數
您要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。
裝置群組的唯一標識碼。
選擇性參數
自變數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的IoT Central DNS後綴。
裝置群組的簡短摘要。
裝置群組的顯示名稱。
查詢,定義此群組中應有哪些裝置。[查詢篩選範例:SELECT * FROM devices WHERE $template = “dtmi:modelDefinition:dtdlv2”]。
裝置群組的組織標識碼清單。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者令牌來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應