az iot hub configuration

  • Referens

Kommentar

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.46.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot hub configuration-kommando . Läs mer om tillägg.

Hantera IoT-automatisk konfiguration av enhetshantering i stor skala.

Kommandon

Name Description Typ Status
az iot hub configuration create

Skapa en IoT-konfiguration för automatisk enhetshantering i en mål-IoT Hub.

 Anknytning Allmän tillgänglighet
az iot hub configuration delete

Ta bort en IoT-enhetskonfiguration.

 Anknytning Allmän tillgänglighet
az iot hub configuration list

Lista IoT-konfigurationer för automatisk enhetshantering i en IoT Hub.

 Anknytning Allmän tillgänglighet
az iot hub configuration show

Hämta information om en konfiguration för automatisk IoT-enhetshantering.

 Anknytning Allmän tillgänglighet
az iot hub configuration show-metric

Utvärdera en målanvändare eller ett systemmått som definierats i en IoT-enhetskonfiguration.

 Anknytning Allmän tillgänglighet
az iot hub configuration update

Uppdatera angivna egenskaper för en IoT-konfiguration för automatisk enhetshantering.

 Anknytning Allmän tillgänglighet

az iot hub configuration create

Skapa en IoT-konfiguration för automatisk enhetshantering i en mål-IoT Hub.

Konfigurationsinnehållet är json och varierar något beroende på enhetens eller modulens avsikt.

Enhetskonfigurationer är i form av {"deviceContent":{...}} eller {"content":{"deviceContent":{...}}}

Modulkonfigurationer är i form av {"moduleContent":{...}} eller {"content":{"moduleContent":{...}}}

Konfigurationer kan definieras med användardefinierade mått för utvärdering på begäran. Användarmått är json och i form av {"queries":{...}} eller {"metrics":{"queries":{...}}}.

Obs! Målvillkor för moduler måste börja med "från 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]

Exempel

Skapa en enhetskonfiguration med prioritet 3 som gäller på villkor när en enhet taggas i byggnad 9 och miljön är "test".

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

Skapa en enhetskonfiguration med etiketter och ange användarmått infogade (bash-syntaxexempel).

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'"}}}'

Skapa en modulkonfiguration med etiketter och ange användarmått infogade (exempel på cmd-syntax)

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'\"}}}"

Skapa en modulkonfiguration med innehålls- och användarmått infogade (powershell-syntaxexempel).

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''\"}}}'

Skapa en enhetskonfiguration med ett alternativt indataformat med etiketter och mått (skalagnostisk).

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 *"

Obligatoriska parametrar

--config-id -c

Målenhetskonfigurationsnamn. Gemener och följande specialtecken tillåts: [-+%_*!'].

--content -k

Enhetskonfigurationsinnehåll. Ange filsökväg eller rå json.

Valfria parametrar

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type=<auth-type-value>

Godkända värden: key, login
Standardvärde: key
--cl --custom-labels

Ett alternativt indataformat (blankstegsavgränsad nyckel=värdepar) för --labels och avsett att ersätta det i framtiden. Formatexempel: key1=value1 key2="this is my value".

--cmq --custom-metric-queries

Ett alternativt indataformat (blankstegsavgränsade nyckel=värdepar) för --metrics och avsett att ersätta det i framtiden. Formatexempel: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--lab --labels

Karta över etiketter som ska tillämpas på målkonfigurationen. Använd --custom-labels i stället för --labels rekommenderas. Formatexempel: {"key0":"value0", "key1":"value1"}.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--metrics -m

Måttdefinitioner för enhetskonfiguration. Ange filsökväg eller rå json. Användning av --custom-metric-queries i stället för --metrics rekommenderas.

--pri --priority

Enhetskonfigurationens vikt vid konkurrerande regler (högsta vinster).

Standardvärde: 0
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--target-condition --tc -t

Målvillkor där en enhets- eller modulkonfiguration gäller för. Konfigurationer utan målvillkor riktar sig inte mot någon enhet eller modul. Använd följande format: "tags.environment='test'".

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub configuration delete

Ta bort en IoT-enhetskonfiguration.

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

Obligatoriska parametrar

--config-id -c

Målenhetskonfigurationsnamn. Gemener och följande specialtecken tillåts: [-+%_*!'].

Valfria parametrar

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type=<auth-type-value>

Godkända värden: key, login
Standardvärde: key
--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub configuration list

Lista IoT-konfigurationer för automatisk enhetshantering i en IoT Hub.

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

Valfria parametrar

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type=<auth-type-value>

Godkända värden: key, login
Standardvärde: key
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--top

Maximalt antal konfigurationer som ska returneras. Som standard returneras alla konfigurationer.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub configuration show

Hämta information om en konfiguration för automatisk IoT-enhetshantering.

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

Obligatoriska parametrar

--config-id -c

Målenhetskonfigurationsnamn. Gemener och följande specialtecken tillåts: [-+%_*!'].

Valfria parametrar

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type=<auth-type-value>

Godkända värden: key, login
Standardvärde: key
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub configuration show-metric

Utvärdera en målanvändare eller ett systemmått som definierats i en IoT-enhetskonfiguration.

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

Exempel

Utvärdera det användardefinierade måttet "warningLimit"

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

Utvärdera systemets mått "appliedCount"

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

Obligatoriska parametrar

--config-id -c

Målenhetskonfigurationsnamn. Gemener och följande specialtecken tillåts: [-+%_*!'].

--metric-id -m

Målmått för utvärdering.

Valfria parametrar

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type=<auth-type-value>

Godkända värden: key, login
Standardvärde: key
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--metric-type --mt

Anger vilken måttsamling som ska användas för att söka efter ett mått.

Godkända värden: system, user
Standardvärde: user
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub configuration update

Uppdatera angivna egenskaper för en IoT-konfiguration för automatisk enhetshantering.

Använd --set följt av egenskapstilldelningar för uppdatering av en konfiguration.

Obs! Konfigurationsinnehållet är oföränderligt. Konfigurationsegenskaper som kan uppdateras är "etiketter", "mått", "prioritet" och "targetCondition".

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

Exempel

Ändra prioriteten för en enhetskonfiguration och uppdatera dess målvillkor

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

Obligatoriska parametrar

--config-id -c

Målenhetskonfigurationsnamn. Gemener och följande specialtecken tillåts: [-+%_*!'].

Valfria parametrar

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

Standardvärde: []
--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type=<auth-type-value>

Godkända värden: key, login
Standardvärde: key
--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

Standardvärde: False
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

Standardvärde: []
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

Standardvärde: []
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.