az iot du device class

  • 參考

注意

此參考是 Azure CLI 的 azure-iot 延伸模組的一部分 （2.37.0 版或更高版本）。 擴充功能會在您第一次執行 az iot du device class 命令時自動安裝。 深入了解擴充功能。

裝置類別和裝置類別子群組管理。

裝置類別描述一組裝置，這些裝置會跨群組共用一組通用屬性，而裝置類別子群組是共用相同裝置類別識別碼之群組中的裝置子集。當啟用裝置更新的裝置連線到中樞時，會自動建立裝置類別。

命令

名稱 Description 類型 狀態
az iot du device class delete

刪除裝置類別或裝置類別子群組。

 擴充 GA
az iot du device class list

列出裝置類別或裝置類別子群組。

 擴充 GA
az iot du device class show

顯示裝置類別或裝置類別子群組的詳細資料，包括可安裝的更新、最佳更新和更新合規性。

 擴充 GA
az iot du device class update

更新裝置類別。

 擴充 GA

az iot du device class delete

刪除裝置類別或裝置類別子群組。

當啟用裝置更新的裝置連線到中樞，但不會自動清除裝置類別時，裝置類別會自動建立，因為它們是由裝置類別子群組參考。 如果刪除目標裝置類別的所有裝置類別子群組，也可以刪除裝置類別本身，以從系統移除記錄，並停止檢查裝置類別與新更新的相容性。 如果裝置曾經重新連線，則會在裝置不存在時重新建立其裝置類別。

az iot du device class delete --account
                              --cid
                              --instance
                              [--gid]
                              [--resource-group]
                              [--yes {false, true}]

範例

刪除裝置類別。

az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id}

刪除裝置類別並略過確認提示。

az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id} -y

刪除裝置類別子群組。

az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id}

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name> 。

--cid --class-id

裝置類別識別碼。這會從模型識別碼和裝置更新代理程式在 IoT 中樞 中的裝置更新代理程式所報告的相容性屬性產生。 這是十六進位編碼的 SHA1 雜湊。

--instance -i

裝置更新實例名稱。 您可以使用 來設定預設實例名稱 az config set defaults.adu_instance=<name> 。

選擇性參數

--gid --group-id

裝置群組識別碼。這會從連線IoT 中樞裝置/模組對應項中的 ADUGroup 標籤值建立，或針對沒有標記的裝置建立$default。

--resource-group -g

裝置更新帳戶資源組名。 您可以使用 來設定預設群組 az config set defaults.adu_group=<name> 。

--yes -y

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

接受的值: false, true
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot du device class list

列出裝置類別或裝置類別子群組。

az iot du device class list --account
                            --instance
                            [--filter]
                            [--gid]
                            [--resource-group]

範例

列出實例內的裝置類別。

az iot du device class list -n {account_name} -i {instance_name}

列出依易記名稱篩選的實例裝置類別。

az iot du device class list -n {account_name} -i {instance_name} --filter "friendlyName eq 'my-favorite-class'"

列出群組的裝置類別子群組。

az iot du device class list -n {account_name} -i {instance_name} --group-id {device_group_id}

列出群組的裝置類別子群組，依 compatProperties/manufacturer 篩選。

az iot du device class list -n {account_name} -i {instance_name} --group-id {device_group_id} --filter "compatProperties/manufacturer eq 'Contoso'"

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name> 。

--instance -i

裝置更新實例名稱。 您可以使用 來設定預設實例名稱 az config set defaults.adu_instance=<name> 。

選擇性參數

--filter

如果提供 --group-id，則支援根據裝置類別的相容性屬性名稱和值進行篩選。 例如「compatProperties/manufacturer eq 'Contoso'」。 否則支援依類別易記名稱進行篩選。

--gid --group-id

裝置群組識別碼。這會從連線IoT 中樞裝置/模組對應項中的 ADUGroup 標籤值建立，或針對沒有標記的裝置建立$default。

--resource-group -g

裝置更新帳戶資源組名。 您可以使用 來設定預設群組 az config set defaults.adu_group=<name> 。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot du device class show

顯示裝置類別或裝置類別子群組的詳細資料，包括可安裝的更新、最佳更新和更新合規性。

az iot du device class show --account
                            --cid
                            --instance
                            [--best-update {false, true}]
                            [--gid]
                            [--installable-updates {false, true}]
                            [--resource-group]
                            [--update-compliance {false, true}]

範例

顯示裝置類別。

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id}

顯示裝置類別的可安裝更新。 此旗標會修改 命令以傳回清單。

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --installable-updates

顯示裝置類別子群組。

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id}

顯示裝置類別子群組可用的最佳更新。

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id} --best-update

顯示裝置類別子群組的更新合規性。

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id} --update-compliance

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name> 。

--cid --class-id

裝置類別識別碼。這會從模型識別碼和裝置更新代理程式在 IoT 中樞 中的裝置更新代理程式所報告的相容性屬性產生。 這是十六進位編碼的 SHA1 雜湊。

--instance -i

裝置更新實例名稱。 您可以使用 來設定預設實例名稱 az config set defaults.adu_instance=<name> 。

選擇性參數

--best-update

指出命令的旗標應該擷取裝置類別子群組的最佳可用更新，包括需要更新的裝置數目計數。 此旗標需要群組識別碼。 最佳更新是符合裝置類別所有相容性規格的最新更新。

接受的值: false, true
--gid --group-id

裝置群組識別碼。這會從連線IoT 中樞裝置/模組對應項中的 ADUGroup 標籤值建立，或針對沒有標記的裝置建立$default。

--installable-updates

旗標，指出命令應該擷取裝置類別的可安裝更新。

接受的值: false, true
--resource-group -g

裝置更新帳戶資源組名。 您可以使用 來設定預設群組 az config set defaults.adu_group=<name> 。

--update-compliance

指出命令應擷取裝置類別子群組更新合規性資訊的旗標，例如其最新更新上有多少裝置、需要多少新更新，以及接收新更新時有多少裝置正在進行中。 此旗標需要群組識別碼。

接受的值: false, true
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot du device class update

更新裝置類別。

az iot du device class update --account
                              --cid
                              --instance
                              [--friendly-name]
                              [--resource-group]

範例

更新裝置類別易記名稱。

az iot du device class update -n {account_name} -i {instance_name} --class-id {device_class_id} --friendly-name "EU-region"

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name> 。

--cid --class-id

裝置類別識別碼。這會從模型識別碼和裝置更新代理程式在 IoT 中樞 中的裝置更新代理程式所報告的相容性屬性產生。 這是十六進位編碼的 SHA1 雜湊。

--instance -i

裝置更新實例名稱。 您可以使用 來設定預設實例名稱 az config set defaults.adu_instance=<name> 。

選擇性參數

--friendly-name

裝置類別易記名稱。 易記名稱必須是 1 - 100 個字元，且支援英數位元、點和虛線值。

--resource-group -g

裝置更新帳戶資源組名。 您可以使用 來設定預設群組 az config set defaults.adu_group=<name> 。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。