az iot central device-group

注意

此參考是 Azure CLI (2.30.0 版或更新版本的 azure-iot 擴充功能的一部分) 。 當您第一次執行 az iot central device-group 命令時,擴充功能會自動安裝。 深入了解延伸模組。

管理和設定 IoT Central 裝置群組。

命令

az iot central device-group create

建立裝置群組。

az iot central device-group delete

刪除裝置群組。

az iot central device-group list

取得 IoT Central 應用程式的裝置群組清單。

az iot central device-group show

依識別碼取得裝置群組。

az iot central device-group update

更新現有的裝置群組。

az iot central device-group create

建立裝置群組。

注意:目前僅支援一個組織,很快就會支援多個組織。

az iot central device-group create --app-id
                                   --device-group-id
                                   --display-name
                                   --filter
                                   [--api-version {1.0, 1.1-preview, 2022-05-31, preview}]
                                   [--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}

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式的說明功能表下的 [關於] 頁面中找到應用程式識別碼。

--device-group-id

裝置群組的唯一識別碼。

--display-name

裝置群組的顯示名稱。

--filter

查詢,定義哪些裝置應該在此群組中。[查詢篩選範例: SELECT * FROM devices WHERE $template = 「dtmi:modelDefinition:dtdlv2」]。

選擇性參數

--api-version --av

所要求作業的 API 版本。

接受的值: 1.0, 1.1-preview, 2022-05-31, preview
預設值: 2022-05-31
--central-api-uri --central-dns-suffix

與應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com
--description

裝置群組的簡短摘要。

--organizations

裝置群組的組織識別碼清單。

--token

如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 深入了解:https://aka.ms/iotcentraldocsapi

az iot central device-group delete

刪除裝置群組。

az iot central device-group delete --app-id
                                   --device-group-id
                                   [--api-version {1.0, 1.1-preview, 2022-05-31, preview}]
                                   [--central-api-uri]
                                   [--token]

範例

刪除裝置群組

az iot central device-group delete --app-id {appid} --device-group-id {devicegroupid}

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式的說明功能表下的 [關於] 頁面中找到應用程式識別碼。

--device-group-id

裝置群組的唯一識別碼。

選擇性參數

--api-version --av

所要求作業的 API 版本。

接受的值: 1.0, 1.1-preview, 2022-05-31, preview
預設值: 2022-05-31
--central-api-uri --central-dns-suffix

與應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com
--token

如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 深入了解:https://aka.ms/iotcentraldocsapi

az iot central device-group list

取得 IoT Central 應用程式的裝置群組清單。

az iot central device-group list --app-id
                                 [--api-version {1.0, 1.1-preview, 2022-05-31, preview}]
                                 [--central-api-uri]
                                 [--token]

範例

列出應用程式中的裝置群組

az iot central device-group list --app-id {appid}

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式的說明功能表下的 [關於] 頁面中找到應用程式識別碼。

選擇性參數

--api-version --av

所要求作業的 API 版本。

接受的值: 1.0, 1.1-preview, 2022-05-31, preview
預設值: 2022-05-31
--central-api-uri --central-dns-suffix

與應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com
--token

如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 深入了解:https://aka.ms/iotcentraldocsapi

az iot central device-group show

依識別碼取得裝置群組。

az iot central device-group show --app-id
                                 --device-group-id
                                 [--api-version {1.0, 1.1-preview, 2022-05-31, preview}]
                                 [--central-api-uri]
                                 [--token]

範例

依識別碼取得裝置群組。

az iot central device-group show --app-id {appid} --device-group-id {devicegroupid}

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式的說明功能表下的 [關於] 頁面中找到應用程式識別碼。

--device-group-id

裝置群組的唯一識別碼。

選擇性參數

--api-version --av

所要求作業的 API 版本。

接受的值: 1.0, 1.1-preview, 2022-05-31, preview
預設值: 2022-05-31
--central-api-uri --central-dns-suffix

與應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com
--token

如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 深入了解:https://aka.ms/iotcentraldocsapi

az iot central device-group update

更新現有的裝置群組。

注意:目前僅支援一個組織,很快就會支援多個組織。

az iot central device-group update --app-id
                                   --device-group-id
                                   [--api-version {1.0, 1.1-preview, 2022-05-31, preview}]
                                   [--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}

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式的說明功能表下的 [關於] 頁面中找到應用程式識別碼。

--device-group-id

裝置群組的唯一識別碼。

選擇性參數

--api-version --av

所要求作業的 API 版本。

接受的值: 1.0, 1.1-preview, 2022-05-31, preview
預設值: 2022-05-31
--central-api-uri --central-dns-suffix

與應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com
--description

裝置群組的簡短摘要。

--display-name

裝置群組的顯示名稱。

--filter

查詢,定義哪些裝置應該在此群組中。[查詢篩選範例: SELECT * FROM devices WHERE $template = 「dtmi:modelDefinition:dtdlv2」]。

--organizations

裝置群組的組織識別碼清單。

--token

如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 深入了解:https://aka.ms/iotcentraldocsapi