az iot edge

Note

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

Správa řešení IoT v Edgi

Příkazy

Name Description Typ Stav
az iot edge deployment

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

Extension GA
az iot edge deployment create

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

Extension GA
az iot edge deployment delete

Odstraňte nasazení IoT Edge.

Extension GA
az iot edge deployment list

Vypište IoT Edge nasazení v IoT Hub.

Extension GA
az iot edge deployment show

Získejte podrobnosti o nasazení IoT Edge.

Extension GA
az iot edge deployment show-metric

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

Extension GA
az iot edge deployment update

Aktualizace zadaných vlastností nasazení IoT Edge

Extension GA
az iot edge devices

Příkazy pro správu IoT Edge zařízení

Extension GA
az iot edge devices create

Vytvořte a nakonfigurujte několik hraničních zařízení v IoT Hub.

Extension Experimental
az iot edge export-modules

Export konfigurace hraničních modulů na jednom hraničním zařízení.

Extension GA
az iot edge set-modules

Nastavte hraniční moduly na jednom zařízení.

Extension GA

az iot edge export-modules

Export konfigurace hraničních modulů na jednom hraničním zařízení.

Výstup konfigurace dvojčete modulu lze použít přímo jako obsah příkazu az iot edge set-modules.

az iot edge export-modules --device-id
                           [--acquire-policy-token]
                           [--auth-type {key, login}]
                           [--change-reference]
                           [--hub-name]
                           [--login]
                           [--resource-group]

Příklady

Export konfigurace dvojčete modulu na cílovém zařízení

az iot edge export-modules --hub-name {iothub_name} --device-id {device_id}

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--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}.

Vlastnost Hodnota
Skupina parametrů: Access Control Arguments
Default value: key
Přípustné hodnoty: key, login
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--hub-name -n

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

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--login -l

Tento příkaz podporuje entitu connection string 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 je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--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í.

Vlastnost Hodnota
Default value: False
--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Vlastnost Hodnota
Default value: False

az iot edge set-modules

Nastavte hraniční moduly na jednom zařízení.

Obsah modulů 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. To lze zakázat pomocí přepínače --no-validation.

Poznámka: Po spuštění příkaz vypíše kolekci modulů použitých na zařízení.

az iot edge set-modules --content
                        --device-id
                        [--acquire-policy-token]
                        [--auth-type {key, login}]
                        [--change-reference]
                        [--hub-name]
                        [--login]
                        [--resource-group]

Příklady

Otestujte hraniční moduly při vývoji nastavením modulů na cílovém zařízení.

az iot edge set-modules --hub-name {iothub_name} --device-id {device_id} --content ../modules_content.json

Povinné parametry

--content -k

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

--device-id -d

ID cílového zařízení.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--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}.

Vlastnost Hodnota
Skupina parametrů: Access Control Arguments
Default value: key
Přípustné hodnoty: key, login
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--hub-name -n

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

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--login -l

Tento příkaz podporuje entitu connection string 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 je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost Hodnota
Skupina parametrů: IoT Hub Identifier Arguments
--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í.

Vlastnost Hodnota
Default value: False
--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Vlastnost Hodnota
Default value: False