az iot hub configuration

參考

注意

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

大規模管理 IoT 自動裝置管理設定。

命令

名稱	Description	類型	狀態
az iot hub configuration create	在目標 IoT 中樞中建立IoT自動裝置管理設定。	副檔名	GA
az iot hub configuration delete	刪除IoT裝置設定。	副檔名	GA
az iot hub configuration list	列出 IoT 中樞中的IoT自動裝置管理設定。	副檔名	GA
az iot hub configuration show	取得IoT自動裝置管理設定的詳細數據。	副檔名	GA
az iot hub configuration show-metric	評估IoT裝置組態中定義的目標使用者或系統計量。	副檔名	GA
az iot hub configuration update	更新IoT自動裝置管理設定的指定屬性。	副檔名	GA

az iot hub configuration create

在目標 IoT 中樞中建立IoT自動裝置管理設定。

設定內容是 json，而且會根據裝置或模組意圖而稍有不同。

裝置組態的格式為 {“deviceContent”：{...}} 或 {“content”：{“deviceContent”：{...}}}

模組組態的格式為 {“moduleContent”：{...}} 或 {“content”：{“moduleContent”：{...}}}

您可以使用使用者提供的計量來定義組態，以進行隨選評估。用戶計量為 json，格式為 {“query”：{...}} 或 {“metrics”：{“queries”：{...}}}。

注意：模組的目標條件必須以「from devices.modules where」開頭。

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--cl]
                                [--cmq]
                                [--hub-name]
                                [--lab]
                                [--login]
                                [--metrics]
                                [--pri]
                                [--resource-group]
                                [--target-condition]

範例

建立優先順序為 3 的裝置組態，該組態會在裝置在建築物 9 中標記且環境為「測試」時套用條件。

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9 and tags.environment='test'" --priority 3

使用標籤建立裝置組態，並提供使用者內嵌計量（bash 語法範例）。

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9" --labels '{"key0":"value0", "key1":"value1"}' --priority 10 --metrics '{"metrics": {"queries": {"mymetric": "select deviceId from devices where tags.location='US'"}}}'

使用標籤建立模組組態，並提供內嵌使用者計量（Cmd 語法範例）

az iot hub configuration create -c {config_name} -n {iothub_name} --content module_content.json --target-condition "from devices.modules where tags.building=9" --labels "{\"key0\":\"value0\", \"key1\":\"value1\"}" --metrics "{\"metrics\": {\"queries\": {\"mymetric\": \"select moduleId from devices.modules where tags.location='US'\"}}}"

使用內嵌內容和用戶計量建立模組組態（powershell 語法範例）。

az iot hub configuration create -c {config_name} -n {iothub_name} --content '{\"moduleContent\": {\"properties.desired.chillerWaterSettings\": {\"temperature\": 38, \"pressure\": 78}}}' --target-condition "from devices.modules where tags.building=9" --priority 1 --metrics '{\"metrics\": {\"queries\": {\"mymetric\":\"select moduleId from devices.modules where tags.location=''US''\"}}}'

使用標籤和計量的替代輸入樣式建立裝置組態（殼層無關）。

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "from devices.modules where tags.building=9" --custom-labels key0="value0" key1="value1" --priority 10 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

必要參數

--config-id -c

目標裝置組態名稱。允許小寫和下列特殊字元：[-+%_*！']。

--content -k

裝置設定內容。提供檔案路徑或原始 JSON。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則密鑰，或使用目前的 Azure AD 工作階段。如果驗證類型是登入，而且會提供資源主機名，除非需要，否則將會略過資源查閱。您可以使用來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value>。

接受的值: key, login

預設值: key

--cl --custom-labels

--labels 的替代輸入樣式（空格分隔的索引鍵=值組），並打算在未來取代它。格式範例：key1=value1 key2=“this is my value”。

--cmq --custom-metric-queries

--metrics 的替代輸入樣式（空格分隔索引鍵=值組），並打算在未來取代它。格式範例：metric1=“從 tags.location='US'” metric2=“select *” 的裝置選取 deviceId。

--hub-name -n

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

--lab --labels

要套用至目標組態的標籤對應。建議使用 --custom-labels 而非 --labels。格式範例：{“key0”：“value0”， “key1”：“value1”}。

--login -l

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

--metrics -m

裝置設定計量定義。提供檔案路徑或原始 JSON。建議使用 --custom-metric-queries 而非 --metrics。

--pri --priority

在競爭規則（最高獲勝）的情況下，裝置組態的權數。

預設值: 0

--resource-group -g

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

--target-condition --tc -t

裝置或模組組態套用的目標條件。沒有目標條件的設定不會以裝置或模組為目標。使用下列格式：“tags.environment='test'”。

全域參數

--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 hub configuration delete

刪除IoT裝置設定。

az iot hub configuration delete --config-id
                                [--auth-type {key, login}]
                                [--etag]
                                [--hub-name]
                                [--login]
                                [--resource-group]

必要參數

--config-id -c

目標裝置組態名稱。允許小寫和下列特殊字元：[-+%_*！']。

選擇性參數

--auth-type

接受的值: key, login

預設值: key

--etag -e

對應至資源最後狀態的 Etag 或實體標記。如果未提供任何 etag，則會使用『*』值。

--hub-name -n

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

--login -l

此命令支援具有執行動作許可權的實體連接字串。使用來避免透過「az login」的工作階段登入。如果提供實體連接字串和名稱，則連接字串優先。如果未提供 --hub-name，則為必要專案。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults 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 hub configuration list

列出 IoT 中樞中的IoT自動裝置管理設定。

az iot hub configuration list [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]
                              [--top]

選擇性參數

--auth-type

接受的值: key, login

預設值: key

--hub-name -n

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

--login -l

--resource-group -g

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

--top

要傳回的組態數目上限。根據預設，會傳回所有組態。

全域參數

--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 hub configuration show

取得IoT自動裝置管理設定的詳細數據。

az iot hub configuration show --config-id
                              [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]

必要參數

--config-id -c

目標裝置組態名稱。允許小寫和下列特殊字元：[-+%_*！']。

選擇性參數

--auth-type

接受的值: key, login

預設值: key

--hub-name -n

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

--login -l

此命令支援具有執行動作許可權的實體連接字串。使用來避免透過「az login」的工作階段登入。如果提供實體連接字串和名稱，則連接字串優先使用。如果未提供 --hub-name，則為必要專案。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults 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 hub configuration show-metric

評估IoT裝置組態中定義的目標使用者或系統計量。

az iot hub configuration show-metric --config-id
                                     --metric-id
                                     [--auth-type {key, login}]
                                     [--hub-name]
                                     [--login]
                                     [--metric-type {system, user}]
                                     [--resource-group]

範例

評估使用者定義的『warningLimit』計量

az iot hub configuration show-metric -m warningLimit -c {configuration_name} -n {iothub_name}

評估系統『appliedCount』計量

az iot hub configuration show-metric --metric-id appliedCount -c {configuration_name} -n {iothub_name} --metric-type system

必要參數

--config-id -c

目標裝置組態名稱。允許小寫和下列特殊字元：[-+%_*！']。

--metric-id -m

評估的目標計量。

選擇性參數

--auth-type

接受的值: key, login

預設值: key

--hub-name -n

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

--login -l

--metric-type --mt

指出應該使用哪一個計量集合來查閱計量。

接受的值: system, user

預設值: user

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults 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 hub configuration update

更新IoT自動裝置管理設定的指定屬性。

使用 --set 後面接著屬性指派來更新組態。

注意：設定內容是不可變的。可更新的組態屬性為 'labels'、'metrics'、'priority' 和 'targetCondition'。

az iot hub configuration update --config-id
                                [--add]
                                [--auth-type {key, login}]
                                [--etag]
                                [--force-string]
                                [--hub-name]
                                [--login]
                                [--remove]
                                [--resource-group]
                                [--set]

範例

改變裝置設定的優先順序，並更新其目標條件

az iot hub configuration update -c {configuration_name} -n {iothub_name} --set priority=10 targetCondition="tags.building=43 and tags.environment='dev'"

必要參數

--config-id -c

目標裝置組態名稱。允許小寫和下列特殊字元：[-+%_*！']。

選擇性參數

--add

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

預設值: []

--auth-type

接受的值: key, login

預設值: key

--etag -e

對應至資源最後狀態的 Etag 或實體標記。如果未提供任何 etag，則會使用『*』值。

--force-string

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

預設值: False

--hub-name -n

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

--login -l

--remove

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

預設值: []

--resource-group -g

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

--set

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

預設值: []

全域參數

--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 hub configuration

命令

az iot hub configuration create

範例

必要參數

選擇性參數

az iot hub configuration delete

必要參數

選擇性參數

az iot hub configuration list

選擇性參數

az iot hub configuration show

必要參數

選擇性參數

az iot hub configuration show-metric

範例

必要參數

選擇性參數

az iot hub configuration update

範例

必要參數

選擇性參數

其他資源