Dela via

az iot edge devices

  • 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 kommandot az iot edge devices . Läs mer om tillägg.

Kommandon för att hantera IoT Edge-enheter.

Kommandon

Name Description Typ Status
az iot edge devices create

Skapa och konfigurera flera gränsenheter i en IoT Hub.

 Anknytning Experimentell

az iot edge devices create

Experimentell

Det här kommandot är experimentellt och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Skapa och konfigurera flera gränsenheter i en IoT Hub.

Den här åtgärden accepterar interna enhetsargument eller en konfigurationsfil för gränsenheter i YAML- eller JSON-format. Infogade kommando args (till exempel "--device-auth") har företräde och åsidosätter konfigurationsfilegenskaper om de tillhandahålls. En exempelkonfigurationsfil finns här: https://aka.ms/aziotcli-edge-devices-config Granska exempel och parameterbeskrivningar för mer information om hur du använder den här åtgärden fullt ut.

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

Exempel

Skapa ett par gränsenheter med symmetrisk nyckelautentisering (standard)

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

Skapa en platt lista över gränsenheter med självsignerad certifikatautentisering med olika gränsegenskapskonfigurationer med hjälp av infogade argument.

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}

Ta bort alla befintliga enhetsidentiteter på en hubb och skapa nya enheter baserat på en konfigurationsfil (med förloppsstaplar och visualiseringsutdata).

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

Skapa en grupp kapslade gränsenheter med anpassade moduldistributioner – som innehåller 2 överordnade enheter med 1 underordnad enhet vardera med infogade argument. Anger även utdatasökvägen för enhetscertifikatpaket.

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

Skapa en enkel kapslad enhetskonfiguration med en befintlig rotcertifikatutfärdare med x509-autentisering och ange en anpassad utdatasökväg för enhetspaket.

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

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
--cfg --config --config-file

Sökväg till enhetskonfigurationsfilen. Exempelkonfigurationsfil: https://aka.ms/aziotcli-edge-devices-config.

--clean -c

Tar bort alla enheter i målhubben innan du skapar nya enheter.

Godkända värden: false, true
Standardvärde: False
--dct --device-config-template

Sökväg till filen IoT Edge config.toml som ska användas som grund för konfigurationer av gränsenheter.

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

Standard kantagent för skapade Edge-enheter om den inte anges individuellt.

--device -d

Blankstegsavgränsad nyckel=värdepar som motsvarar egenskaperna för gränsenheten som ska skapas. Följande nyckelvärden stöds: id (device_id), deployment (infogad json eller sökväg till fil), hostname, parent (device_id), edge_agent (bild-URL) och container_auth (infogad json eller sökväg till filen). --device kan användas 1 eller fler gånger. Granska hjälpexemplen för fullständig parameteranvändning – dessa parametrar refererar också till motsvarande värden i vår exempelkonfigurationsfil: https://aka.ms/aziotcli-edge-devices-config.

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

Mekanism för auktorisering från enhet till hubb.

Godkända värden: shared_private_key, x509_thumbprint
--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.

--out --output-path

Katalogsökväg till enhetskonfigurationspaket för utdata. Om det här värdet inte anges skapas inga filutdata.

--rc --root-cert

Sökväg till rotcertifikat för offentlig nyckel för att signera kapslade gränsenhetscertifikat.

--resource-group -g

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

--rk --root-key

Sökväg till den privata rotnyckeln för att signera kapslade gränsenhetscertifikat.

--root-pass --rp

Rotnyckellösenord.

--vis --visualize -v

Visar visualiseringar av enheter och förlopp för olika uppgifter (enhetsskapande, inställning av överordnade enheter, uppdatering av konfigurationer osv.).

Godkända värden: false, true
Standardvärde: False
--yes -y

Fråga inte efter bekräftelse när --clean-växeln används för att ta bort befintliga hubbenheter.

Godkända värden: false, true
Standardvärde: False
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.