az iot edge devices

  • Reference

Poznámka

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

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

Příkazy

Name Description Typ Stav
az iot edge devices create

Vytvoření a konfigurace několika hraničních zařízení v IoT Hubu

 Rozšíření Experimentální

az iot edge devices create

Experimentální

Tento příkaz je experimentální a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Vytvoření a konfigurace několika hraničních zařízení v IoT Hubu

Tato operace přijímá vložené argumenty zařízení nebo konfigurační soubor hraničních zařízení ve formátu YAML nebo JSON. Inline command args (like '--device-auth') budou mít přednost a přepsat vlastnosti konfiguračního souboru, pokud jsou k dispozici. Ukázkový konfigurační soubor najdete tady: https://aka.ms/aziotcli-edge-devices-config Projděte si příklady a popisy parametrů, kde najdete podrobnosti o tom, jak tuto operaci plně využít.

az iot edge devices create [--auth-type {key, login}]
                           [--cfg]
                           [--clean {false, true}]
                           [--dct]
                           [--dea]
                           [--device]
                           [--device-auth {shared_private_key, x509_thumbprint}]
                           [--hub-name]
                           [--login]
                           [--out]
                           [--rc]
                           [--resource-group]
                           [--rk]
                           [--root-pass]
                           [--vis {false, true}]
                           [--yes {false, true}]

Příklady

Vytvoření několika hraničních zařízení pomocí ověřování symetrického klíče (výchozí)

az iot edge devices create -n {hub_name} --device id=device_1 --device id=device_2

Pomocí vložených argumentů vytvořte plochý seznam hraničních zařízení pomocí ověřování certifikátů podepsaných svým držitelem s různými konfiguracemi vlastností hraničních zařízení.

az iot edge devices create -n {hub_name} --device-auth x509_thumbprint --default-edge-agent "mcr.microsoft.com/azureiotedge-agent:1.4"
--device id=device_1 hostname={FQDN}
--device id=device_2 edge_agent={agent_image}
--device id=parent hostname={FQDN} edge_agent={agent_image} container_auth={path_or_json_string}

Odstraňte všechny existující identity zařízení v centru a vytvořte nová zařízení na základě konfiguračního souboru (s indikátory průběhu a výstupem vizualizace).

az iot edge devices create -n {hub_name} --cfg path/to/config_yml_or_json -c -v

Vytvořte skupinu vnořených hraničních zařízení s vlastními nasazeními modulů , která obsahují 2 nadřazená zařízení s 1 podřízeným zařízením, a to pomocí vložených argumentů. Určuje také výstupní cestu pro sady certifikátů zařízení.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--device id=parent_1 deployment=/path/to/parentDeployment_1.json
--device id=child_1 parent=parent_1 deployment=/path/to/child_deployment_1.json
--device id=parent_2 deployment=/path/to/parentDeployment_2.json
--device id=child_2 parent=parent_2 deployment=/path/to/child_deployment_2.json

Vytvořte jednoduchou konfiguraci vnořeného hraničního zařízení s existující kořenovou certifikační autoritou pomocí ověřování x509 a zadejte vlastní výstupní cestu sady zařízení.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--root-cert "root_cert.pem" --root-key "root_key.pem" --device-auth x509_thumbprint
--device id=parent1
--device id=child1 parent=parent1

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řijímané hodnoty: key, login
výchozí hodnota: key
--cfg --config --config-file

Cesta ke konfiguračnímu souboru zařízení Ukázkový konfigurační soubor: https://aka.ms/aziotcli-edge-devices-config.

--clean -c

Před vytvořením nových zařízení odstraní všechna zařízení v cílovém centru.

přijímané hodnoty: false, true
výchozí hodnota: False
--dct --device-config-template

Cesta k souboru config.toml ioT Edge, který se má použít jako základ pro konfigurace hraničních zařízení.

--dea --default-agent --default-edge-agent

Výchozí agent Edge pro vytvořená zařízení Edge, pokud není zadaný jednotlivě.

--device -d

Pár klíč=hodnota oddělený mezerníkem odpovídající vlastnostem hraničního zařízení, které se mají vytvořit. Podporují se následující hodnoty klíče: id (device_id), deployment (vložený json nebo cesta k souboru), hostname, parent (device_id), edge_agent (adresa URL obrázku) a container_auth (vložený json nebo cesta k souboru). --zařízení lze použít 1 nebo vícekrát. Projděte si příklady nápovědy pro úplné použití parametrů – tyto parametry také odkazují na jejich odpovídající hodnoty v našem ukázkovém konfiguračním souboru: https://aka.ms/aziotcli-edge-devices-config.

--device-auth --device-auth-type

Mechanismus autorizace zařízení do centra

přijímané hodnoty: shared_private_key, x509_thumbprint
--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.

--out --output-path

Cesta k adresáři k výstupním sadám konfigurace zařízení Pokud tato hodnota není zadána, nebude vytvořen žádný výstup souboru.

--rc --root-cert

Cesta k certifikátu kořenového veřejného klíče pro podepsání vnořených certifikátů hraničních zařízení

--resource-group -g

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

--rk --root-key

Cesta ke kořenovému privátnímu klíči pro podepsání vnořených certifikátů hraničních zařízení

--root-pass --rp

Heslo kořenového klíče.

--vis --visualize -v

Zobrazuje vizualizace zařízení a průběh různých úloh (vytváření zařízení, nastavení nadřazených prvků, aktualizace konfigurací atd.).

přijímané hodnoty: false, true
výchozí hodnota: False
--yes -y

Při použití přepínače --clean k odstranění stávajících zařízení rozbočovače se nezobrazí výzva k potvrzení.

přijímané hodnoty: false, true
výchozí hodnota: False
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řijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: 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.