az iot hub configuration

Reference

Poznámka:

Tento odkaz je součástí rozšíření azure-iot pro Azure CLI (verze 2.46.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az iot hub configuration . Přečtěte si další informace o rozšířeních.

Správa konfigurace automatické správy zařízení IoT ve velkém

Příkazy

Name	Description	Typ	Stav
az iot hub configuration create	Vytvořte v cílové službě IoT Hub konfiguraci automatické správy zařízení IoT.	Rozšíření	GA
az iot hub configuration delete	Odstraňte konfiguraci zařízení IoT.	Rozšíření	GA
az iot hub configuration list	Výpis konfigurací automatické správy zařízení IoT ve službě IoT Hub	Rozšíření	GA
az iot hub configuration show	Získejte podrobnosti o konfiguraci automatické správy zařízení IoT.	Rozšíření	GA
az iot hub configuration show-metric	Vyhodnoťte cílovou metriku uživatele nebo systému definovanou v konfiguraci zařízení IoT.	Rozšíření	GA
az iot hub configuration update	Aktualizujte zadané vlastnosti konfigurace automatické správy zařízení IoT.	Rozšíření	GA

az iot hub configuration create

Vytvořte v cílové službě IoT Hub konfiguraci automatické správy zařízení IoT.

Obsah konfigurace je json a mírně se liší podle záměru zařízení nebo modulu.

Konfigurace zařízení jsou ve formě {"deviceContent":{...}} nebo {"content":{"deviceContent":{...}}}

Konfigurace modulů jsou ve formě {"moduleContent":{...}} nebo {"content":{"moduleContent":{...}}}

Konfigurace je možné definovat pomocí metrik poskytovaných uživatelem pro vyhodnocení na vyžádání. Metriky uživatelů jsou json a ve formě {"dotazů":{...}} nebo {"metrics":{"queries":{...}}}.

Poznámka: Cílová podmínka pro moduly musí začínat na "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]

Příklady

Vytvořte konfiguraci zařízení s prioritou 3, která se vztahuje na podmínku, když je zařízení označené v budově 9 a prostředí je "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

Vytvořte konfiguraci zařízení s popisky a zadejte vložené metriky uživatelů (příklad syntaxe 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'"}}}'

Vytvoření konfigurace modulu s popisky a poskytnutí vložených metrik uživatelů (příklad syntaxe 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'\"}}}"

Vytvoření konfigurace modulu s vloženým obsahem a uživatelskými metrikami (příklad syntaxe PowerShellu)

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

Vytvořte konfiguraci zařízení s alternativním stylem popisků a metrik (nezávislý na prostředí).

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

Povinné parametry

--config-id -c

Název konfigurace cílového zařízení Jsou povolena malá a následující speciální znaky: [-+%_*!].

--content -k

Obsah konfigurace zařízení. Zadejte cestu k souboru nebo nezpracovaný kód JSON.

Volitelné parametry

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type=<auth-type-value>.

Přípustné hodnoty: key, login

Default value: key

--cl --custom-labels

Alternativní styl zadávání (mezera oddělená dvojice klíč=hodnota) pro --labels a jeho účelem je nahradit v budoucnu. Příklad formátu: key1=value1 key2="this is my value".

--cmq --custom-metric-queries

Alternativní styl zadávání (mezera oddělená dvojice klíč=hodnota) pro --metrics a jeho účelem je nahradit v budoucnu. Příklad formátu: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--lab --labels

Mapa popisků, které se mají použít pro cílovou konfiguraci Použití --custom-labels místo --labels se doporučuje. Příklad formátu: {"key0":"value0", "key1":"value1"}.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--metrics -m

Definice metrik konfigurace zařízení Zadejte cestu k souboru nebo nezpracovaný kód JSON. Použití dotazů --custom-metric-místo --metrics se doporučuje.

--pri --priority

Váha konfigurace zařízení v případě konkurenčních pravidel (nejvyšší vítězství)

Default value: 0

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--target-condition --tc -t

Cílová podmínka, na které se vztahuje konfigurace zařízení nebo modulu. Konfigurace bez cílové podmínky nebudou cílit na žádné zařízení ani modul. Použijte následující formát: tags.environment='test'.

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub configuration delete

Odstraňte konfiguraci zařízení IoT.

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

Povinné parametry

--config-id -c

Název konfigurace cílového zařízení Jsou povolena malá a následující speciální znaky: [-+%_*!].

Volitelné parametry

--auth-type

Přípustné hodnoty: key, login

Default value: key

--etag -e

Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub configuration list

Výpis konfigurací automatické správy zařízení IoT ve službě IoT Hub

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

Volitelné parametry

--auth-type

Přípustné hodnoty: key, login

Default value: key

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--top

Maximální počet konfigurací, které se mají vrátit. Ve výchozím nastavení se vrátí všechny konfigurace.

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub configuration show

Získejte podrobnosti o konfiguraci automatické správy zařízení IoT.

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

Povinné parametry

--config-id -c

Název konfigurace cílového zařízení Jsou povolena malá a následující speciální znaky: [-+%_*!].

Volitelné parametry

--auth-type

Přípustné hodnoty: key, login

Default value: key

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub configuration show-metric

Vyhodnoťte cílovou metriku uživatele nebo systému definovanou v konfiguraci zařízení IoT.

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

Příklady

Vyhodnocení metriky warningLimit definované uživatelem

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

Vyhodnocení metriky appliedCount systému

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

Povinné parametry

--config-id -c

Název konfigurace cílového zařízení Jsou povolena malá a následující speciální znaky: [-+%_*!].

--metric-id -m

Cílová metrika pro vyhodnocení

Volitelné parametry

--auth-type

Přípustné hodnoty: key, login

Default value: key

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

--metric-type --mt

Určuje, která kolekce metrik se má použít k vyhledání metriky.

Přípustné hodnoty: system, user

Default value: user

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub configuration update

Aktualizujte zadané vlastnosti konfigurace automatické správy zařízení IoT.

K aktualizaci konfigurace použijte parametr --set následovaný přiřazením vlastností.

Poznámka: Obsah konfigurace je neměnný. Vlastnosti konfigurace, které je možné aktualizovat, jsou popisky, metriky, priority a targetCondition.

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

Příklady

Změna priority konfigurace zařízení a aktualizace cílové podmínky

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

Povinné parametry

--config-id -c

Název konfigurace cílového zařízení Jsou povolena malá a následující speciální znaky: [-+%_*!].

Volitelné parametry

--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.

Default value: []

--auth-type

Přípustné hodnoty: key, login

Default value: key

--etag -e

Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.

--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

Default value: False

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.

Default value: []

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Sdílet prostřednictvím

az iot hub configuration

Příkazy

az iot hub configuration create

Příklady

Povinné parametry

Volitelné parametry

az iot hub configuration delete

Povinné parametry

Volitelné parametry

az iot hub configuration list

Volitelné parametry

az iot hub configuration show

Povinné parametry

Volitelné parametry

az iot hub configuration show-metric

Příklady

Povinné parametry

Volitelné parametry

az iot hub configuration update

Příklady

Povinné parametry

Volitelné parametry

Další materiály