az iot edge deployment

  • 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 edge deployment . Přečtěte si další informace o rozšířeních.

Správa nasazení IoT Edge ve velkém měřítku

Příkazy

Name Description Typ Stav
az iot edge deployment create

Vytvořte nasazení IoT Edge v cílovém ioT Hubu.

 Rozšíření GA
az iot edge deployment delete

Odstraňte nasazení IoT Edge.

 Rozšíření GA
az iot edge deployment list

Vypište nasazení IoT Edge ve službě IoT Hub.

 Rozšíření GA
az iot edge deployment show

Získejte podrobnosti o nasazení IoT Edge.

 Rozšíření GA
az iot edge deployment show-metric

Vyhodnoťte metriku cílového systému definovanou v nasazení IoT Edge.

 Rozšíření GA
az iot edge deployment update

Aktualizace zadaných vlastností nasazení IoT Edge

 Rozšíření GA

az iot edge deployment create

Vytvořte nasazení IoT Edge v cílovém ioT Hubu.

Obsah nasazení je json a ve formě {"modulesContent":{...}} nebo {"content":{"modulesContent":{...}}}.

Ve výchozím nastavení se vlastnosti systémových modulů $edgeAgent a $edgeHub ověřují na schématech nainstalovaných s rozšířením IoT. Toto ověřování je určené pro základní nasazení. Pokud odpovídající schéma není k dispozici nebo se nerozpozná základní formát nasazení, tento krok se přeskočí. Ověření schématu je možné zakázat pomocí přepínače --no-validation.

Nasazení edge se klasifikuje jako vrstvené, pokud má modul definované vlastnosti.desired.*. Jakékoli hraniční zařízení, na které cílí vrstvené nasazení, musí nejprve použít základní nasazení.

Všechna vrstvené nasazení, která cílí na zařízení, musí mít vyšší prioritu než základní nasazení pro dané zařízení.

Poznámka: Pokud je pole properties.desired dvojčete modulu nastavené ve vrstveném nasazení, vlastnosti.desired přepíší požadované vlastnosti pro tento modul v jakémkoli nasazení s nižší prioritou.

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--cl]
                              [--cmq]
                              [--hub-name]
                              [--lab]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri]
                              [--resource-group]
                              [--target-condition]

Příklady

Vytvořte nasazení s popisky (příklad syntaxe Bash), která se vztahuje na zařízení v sestavení 9 a prostředí je "test".

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels '{"key0":"value0", "key1":"value1"}' --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Vytvořte nasazení s popisky (příklad syntaxe PowerShellu), která se vztahuje na zařízení označená prostředím dev.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels "{'key':'value'}" --target-condition "tags.environment='dev'"

Vytvořte vrstvené nasazení, které platí pro zařízení označená prostředím dev. Vložený obsah definovaný metrikami uživatelů i moduly (příklad syntaxe PowerShellu). Všimněte si, že tento formát je ve vrstveném formátu nasazení jako properties.desired.* byl definován.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content "{'modulesContent':{'`$edgeAgent':{
  'properties.desired.modules.mymodule0':{ }},'`$edgeHub':{'properties.desired.routes.myroute0':'FROM /messages/* INTO `$upstream'}}}"
--target-condition "tags.environment='dev'" --priority 10 --metrics "{'queries':{'mymetrik':'SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200'}}"

Vytvořte vrstvené nasazení, které se vztahuje na zařízení v sestavení 9 a testovacím prostředí. Vložený obsah definovaný metrikami uživatelů i moduly (příklad syntaxe Bash). Všimněte si, že tento formát je ve vrstveném formátu nasazení jako properties.desired.* byl definován.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content '{"modulesContent":{"$edgeAgent":{"properties.desired.modules.mymodule0":{ }},"$edgeHub":{"properties.desired.routes.myroute0":"FROM /messages/* INTO $upstream"}}}' --target-condition "tags.building=9 and tags.environment='test'" --metrics '{"queries":{"mymetrik":"SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200"}}'

Vytvořte nasazení, které se vztahuje na zařízení v sestavení 9 a testovacím prostředí. Uživatelská metrika i obsah modulů definovaný ze souboru

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics ./metrics_content.json

Vytvořte nasazení, jehož definice pochází ze souboru se vstupem popisků a metrik, které jsou nezávislé na prostředí.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --custom-labels key0=value0 key1=value1 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Povinné parametry

--content -k

Obsah nasazení IoT Edge Zadejte cestu k souboru nebo nezpracovaný kód JSON.

--deployment-id -d

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

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ílové nasazení Použijte následující formát: {"key0":"value0", "key1":"value1"}". Použití --custom-labels místo --labels se doporučuje.

--layered

Vrstvené nasazení umožňují definovat požadované vlastnosti v $edgeAgent, $edgeHub a uživatelských modulech, které budou vrstvit nad základní nasazení. Vlastnosti zadané ve vrstveném nasazení se sloučí s vlastnostmi základního nasazení. Vlastnosti se stejnou cestou se přepíšou na základě priority nasazení. Tato možnost je aliasem pro --no-validation.

Přípustné hodnoty: false, true
Default value: False
--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 uživatelských metrik nasazení IoT Edge Zadejte cestu k souboru nebo nezpracovaný kód JSON. Metriky uživatelů jsou ve formě {"dotazů":{...}} nebo {"metrics":{"queries":{...}}}. Použití dotazů --custom-metric-místo --metrics se doporučuje.

--no-validation

Zakáže ověření schématu na straně klienta pro vytvoření nasazení edge.

Přípustné hodnoty: false, true
Default value: False
--pri --priority

Váha nasazení v případě konkurenčních pravidel (nejvyšší výhra).

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 nasazení edge. Nasazení bez cílové podmínky nebudou cílit na žádné zařízení. 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 edge deployment delete

Odstraňte nasazení IoT Edge.

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

Povinné parametry

--deployment-id -d

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

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

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.

--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 edge deployment list

Vypište nasazení IoT Edge ve službě IoT Hub.

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

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
--hub-name -n

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

--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.

--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 nasazení, která se mají vrátit. Ve výchozím nastavení se vrátí všechna nasazení.

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 edge deployment show

Získejte podrobnosti o nasazení IoT Edge.

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

Povinné parametry

--deployment-id -d

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

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
--hub-name -n

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

--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.

--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 edge deployment show-metric

Vyhodnoťte metriku cílového systému definovanou v nasazení IoT Edge.

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

Příklady

Vyhodnocení systémové metriky appliedCount

az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system

Vyhodnocení metriky uživatele myCustomMetric

az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}

Povinné parametry

--deployment-id -d

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

--metric-id -m

Cílová metrika pro vyhodnocení

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
--hub-name -n

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

--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.

--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 edge deployment update

Aktualizace zadaných vlastností nasazení IoT Edge

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

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

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

Příklady

Změna popisků a cílové podmínky existujícího nasazení edge

az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'

Povinné parametry

--deployment-id -d

Název cílového nasazení 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

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

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.

--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.