az iot edge devices

Note

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.67.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az iot edge devices opdracht uitvoert. Meer informatie over uitbreidingen.

Opdrachten voor het beheren van IoT Edge-apparaten.

Opdracht

Name	Description	Type	Status
az iot edge devices create	Meerdere edge-apparaten maken en configureren in een IoT Hub.	Extension	Experimental

az iot edge devices create

Experimenteel

Deze opdracht is experimenteel en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Meerdere edge-apparaten maken en configureren in een IoT Hub.

Deze bewerking accepteert inline-apparaatargumenten of een edge-apparaatconfiguratiebestand in YAML- of JSON-indeling. Inline-opdrachtargumenten (zoals '--device-auth') hebben voorrang en overschrijven eigenschappen van configuratiebestanden als ze worden opgegeven. Hier vindt u een voorbeeldconfiguratiebestand: https://aka.ms/aziotcli-edge-devices-config Bekijk voorbeelden en parameterbeschrijvingen voor meer informatie over hoe u deze bewerking volledig kunt gebruiken.

az iot edge devices create [--auth-type {key, login}]
                           [--cfg --config --config-file]
                           [--clean {false, true}]
                           [--dct --device-config-template]
                           [--dea --default-agent --default-edge-agent]
                           [--device]
                           [--device-auth --device-auth-type {shared_private_key, x509_thumbprint}]
                           [--hub-name]
                           [--login]
                           [--out --output-path]
                           [--rc --root-cert]
                           [--resource-group]
                           [--rk --root-key]
                           [--root-pass --rp]
                           [--vis --visualize {false, true}]
                           [--yes {false, true}]

Voorbeelden

Een aantal edge-apparaten maken met behulp van verificatie met symmetrische sleutels (standaard)

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

Maak een platte lijst met edge-apparaten met behulp van zelfondertekende certificaatverificatie met verschillende configuraties van edge-eigenschappen, met behulp van inlineargumenten.

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}

Verwijder alle bestaande apparaat-id's op een hub en maak nieuwe apparaten op basis van een configuratiebestand (met voortgangsbalken en visualisatie-uitvoer).

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

Maak een groep geneste edge-apparaten met aangepaste module-implementaties, die twee bovenliggende apparaten met elk één onderliggend apparaat bevatten, met behulp van inlineargumenten. Hiermee geeft u ook het uitvoerpad voor apparaatcertificaatbundels op.

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

Maak een eenvoudige geneste edge-apparaatconfiguratie met een bestaande basis-CA, met behulp van x509-verificatie en geef een aangepast uitvoerpad voor apparaatbundel op.

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

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type={auth-type-value}.

Eigenschap	Waarde
Parametergroep:	Access Control Arguments
Default value:	key
Geaccepteerde waarden:	key, login

--cfg --config --config-file

Pad naar het configuratiebestand voor apparaten. Voorbeeldconfiguratiebestand: https://aka.ms/aziotcli-edge-devices-config.

--clean -c

Hiermee verwijdert u alle apparaten in de doelhub voordat u nieuwe apparaten maakt.

Eigenschap	Waarde
Default value:	False
Geaccepteerde waarden:	false, true

--dct --device-config-template

Pad naar ioT Edge config.toml-bestand dat moet worden gebruikt als basis voor edge-apparaatconfiguraties.

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

Standaardrandagent voor gemaakte Edge-apparaten als deze niet afzonderlijk zijn opgegeven.

--device -d

Door spaties gescheiden sleutelparen=waardeparen die overeenkomen met eigenschappen van het edge-apparaat dat moet worden gemaakt. De volgende sleutelwaarden worden ondersteund: id (device_id), deployment (inline json of pad naar bestand), hostname, parent (device_id), edge_agent (afbeeldings-URL) en container_auth (inline json of pad naar bestand). --apparaat kan 1 of meer keer worden gebruikt. Bekijk help-voorbeelden voor volledig parametergebruik. Deze parameters verwijzen ook naar de bijbehorende waarden in ons voorbeeldconfiguratiebestand: https://aka.ms/aziotcli-edge-devices-config.

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

Mechanisme voor apparaat-naar-hubautorisatie.

Eigenschap	Waarde
Geaccepteerde waarden:	shared_private_key, x509_thumbprint

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

Eigenschap	Waarde
Parametergroep:	IoT Hub Identifier Arguments

--login -l

Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

Eigenschap	Waarde
Parametergroep:	IoT Hub Identifier Arguments

--out --output-path

Pad naar uitvoer van apparaatconfiguratiebundels. Als deze waarde niet is opgegeven, wordt er geen bestandsuitvoer gemaakt.

--rc --root-cert

Pad naar het basiscertificaat van de openbare sleutel om geneste edge-apparaatcertificaten te ondertekenen.

Eigenschap	Waarde
Parametergroep:	Root Certificate Arguments

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--rk --root-key

Pad naar de persoonlijke hoofdsleutel om geneste edge-apparaatcertificaten te ondertekenen.

Eigenschap	Waarde
Parametergroep:	Root Certificate Arguments

--root-pass --rp

Hoofdsleutelwachtwoord.

Eigenschap	Waarde
Parametergroep:	Root Certificate Arguments

--vis --visualize -v

Toont visualisaties van apparaten en voortgang van verschillende taken (apparaat maken, ouders instellen, configuraties bijwerken, enzovoort).

Eigenschap	Waarde
Default value:	False
Geaccepteerde waarden:	false, true

--yes -y

Vraag niet om bevestiging wanneer --clean switch wordt gebruikt om bestaande hubapparaten te verwijderen.

Eigenschap	Waarde
Default value:	False
Geaccepteerde waarden:	false, true

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap	Waarde
Default value:	False

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap	Waarde
Default value:	False

--output -o

Uitvoerindeling.

Eigenschap	Waarde
Default value:	json
Geaccepteerde waarden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap	Waarde
Default value:	False

Feedback

Is deze pagina nuttig?