az iot edge deployment

  • Referentie

Notitie

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

IoT Edge-implementaties op schaal beheren.

Opdracht

Name Description Type Status
az iot edge deployment create

Maak een IoT Edge-implementatie in een doel-IoT Hub.

 Toestel GA
az iot edge deployment delete

Een IoT Edge-implementatie verwijderen.

 Toestel GA
az iot edge deployment list

IoT Edge-implementaties weergeven in een IoT Hub.

 Toestel GA
az iot edge deployment show

De details van een IoT Edge-implementatie ophalen.

 Toestel GA
az iot edge deployment show-metric

Evalueer een metrische doelsysteemgegevens die zijn gedefinieerd in een IoT Edge-implementatie.

 Toestel GA
az iot edge deployment update

De opgegeven eigenschappen van een IoT Edge-implementatie bijwerken.

 Toestel GA

az iot edge deployment create

Maak een IoT Edge-implementatie in een doel-IoT Hub.

Implementatie-inhoud is json en in de vorm van {"modulesContent":{...}} of {"content":{"modulesContent":{...}}}.

Standaard worden eigenschappen van systeemmodules $edgeAgent en $edgeHub gevalideerd op basis van schema's die zijn geïnstalleerd met de IoT-extensie. Deze validatie is bedoeld voor basisimplementaties. Als het bijbehorende schema niet beschikbaar is of de basisimplementatie niet wordt gedetecteerd, wordt deze stap overgeslagen. Schemavalidatie kan worden uitgeschakeld met behulp van de schakeloptie --no-validation.

Een edge-implementatie wordt geclassificeerd als gelaagd als een module properties.desired.* heeft gedefinieerd. Elk edge-apparaat waarop een gelaagde implementatie is gericht, moet eerst een basisimplementatie hierop worden toegepast.

Gelaagde implementaties die gericht zijn op een apparaat, moeten een hogere prioriteit hebben dan de basisimplementatie voor dat apparaat.

Opmerking: Als het veld properties.desired van een moduledubbel is ingesteld in een gelaagde implementatie, overschrijft properties.desired de gewenste eigenschappen voor die module in eventuele implementaties met een lagere prioriteit.

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]

Voorbeelden

Maak een implementatie met labels (bash-syntaxisvoorbeeld) die van toepassing is op apparaten in 'gebouw 9' en de omgeving is '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

Maak een implementatie met labels (powershell-syntaxisvoorbeeld) die van toepassing is op apparaten die zijn getagd met omgeving 'dev'.

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

Maak een gelaagde implementatie die van toepassing is op apparaten die zijn getagd met omgeving 'dev'. Zowel metrische gegevens van gebruikers als modules die inline zijn gedefinieerd (powershell-syntaxisvoorbeeld). Houd er rekening mee dat dit de gelaagde implementatie-indeling heeft als properties.desired.* is gedefinieerd.

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'}}"

Maak een gelaagde implementatie die van toepassing is op apparaten in gebouw 9 en omgevingstest. Zowel metrische gegevens van gebruikers als modules die inline zijn gedefinieerd (voorbeeld van bash-syntaxis). Houd er rekening mee dat dit de gelaagde implementatie-indeling heeft als properties.desired.* is gedefinieerd.

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"}}'

Maak een implementatie die van toepassing is op apparaten in gebouw 9 en omgevingstest. Zowel metrische gegevens van gebruikers als modules die zijn gedefinieerd vanuit het bestand.

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

Maak een implementatie waarvan de definitie afkomstig is van een bestand met shellagnostische invoer van labels en metrische gegevens.

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

Vereiste parameters

--content -k

Inhoud van IoT Edge-implementatie. Geef bestandspad of onbewerkte json op.

--deployment-id -d

Naam van doelimplementatie. Kleine letters en de volgende speciale tekens zijn toegestaan: [-+%_*!].

Optionele parameters

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

geaccepteerde waarden: key, login
standaardwaarde: key
--cl --custom-labels

Een alternatieve invoerstijl (spatie gescheiden sleutel-waardeparen) voor --labels en bedoeld om deze in de toekomst te vervangen. Voorbeeld van indeling: key1=value1 key2="dit is mijn waarde".

--cmq --custom-metric-queries

Een alternatieve invoerstijl (spatie gescheiden sleutel-waardeparen) voor --metrische gegevens en bedoeld om deze in de toekomst te vervangen. Voorbeeld van indeling: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--hub-name -n

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

--lab --labels

Toewijzing van labels die moeten worden toegepast op doelimplementatie. Gebruik de volgende indeling: {"key0":"value0", "key1":"value1"}. Het gebruik van --custom-labels in plaats van --labels wordt aanbevolen.

--layered

Met gelaagde implementaties kunt u gewenste eigenschappen definiëren in $edgeAgent, $edgeHub en gebruikersmodules die boven op een basisimplementatie worden geplaatst. De eigenschappen die zijn opgegeven in een gelaagde implementatie, worden samengevoegd met eigenschappen van de basisimplementatie. Eigenschappen met hetzelfde pad worden overschreven op basis van implementatieprioriteit. Deze optie is een alias voor --no-validation.

geaccepteerde waarden: false, true
standaardwaarde: False
--login -l

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

--metrics -m

Metrische definities van ioT Edge-implementatiegebruikers. Geef bestandspad of onbewerkte json op. Metrische gegevens van gebruikers hebben de vorm van {"query's":{...}} of {"metrics":{"query's":{...}}}. Het gebruik van --custom-metric-query's in plaats van --metrics wordt aanbevolen.

--no-validation

Schakelt schemavalidatie aan de clientzijde uit voor het maken van edge-implementaties.

geaccepteerde waarden: false, true
standaardwaarde: False
--pri --priority

Gewicht van de implementatie in het geval van concurrerende regels (hoogste overwinningen).

standaardwaarde: 0
--resource-group -g

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

--target-condition --tc -t

Doelvoorwaarde waarop een edge-implementatie van toepassing is. Implementaties zonder doelvoorwaarde zijn gericht op geen apparaat. Gebruik de volgende indeling: 'tags.environment='test'.

Globale parameters
--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

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

--subscription

Naam of id van het 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.

az iot edge deployment delete

Een IoT Edge-implementatie verwijderen.

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

Vereiste parameters

--deployment-id -d

Naam van doelimplementatie. Kleine letters en de volgende speciale tekens zijn toegestaan: [-+%_*!].

Optionele parameters

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

geaccepteerde waarden: key, login
standaardwaarde: key
--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.

--hub-name -n

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

--login -l

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

--resource-group -g

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

Globale parameters
--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

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

--subscription

Naam of id van het 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.

az iot edge deployment list

IoT Edge-implementaties weergeven in een IoT Hub.

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

Optionele parameters

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

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

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

--login -l

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

--resource-group -g

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

--top

Maximum aantal te retourneren implementaties. Standaard worden alle implementaties geretourneerd.

Globale parameters
--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

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

--subscription

Naam of id van het 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.

az iot edge deployment show

De details van een IoT Edge-implementatie ophalen.

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

Vereiste parameters

--deployment-id -d

Naam van doelimplementatie. Kleine letters en de volgende speciale tekens zijn toegestaan: [-+%_*!].

Optionele parameters

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

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

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

--login -l

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

--resource-group -g

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

Globale parameters
--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

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

--subscription

Naam of id van het 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.

az iot edge deployment show-metric

Evalueer een metrische doelsysteemgegevens die zijn gedefinieerd in een IoT Edge-implementatie.

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

Voorbeelden

De metrische gegevens van het systeem 'appliedCount' evalueren

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

De metrische gegevens van de gebruiker 'myCustomMetric' evalueren

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

Vereiste parameters

--deployment-id -d

Naam van doelimplementatie. Kleine letters en de volgende speciale tekens zijn toegestaan: [-+%_*!].

--metric-id -m

Doelmetriek voor evaluatie.

Optionele parameters

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

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

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

--login -l

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

--metric-type --mt

Geeft aan welke verzameling metrische gegevens moet worden gebruikt om een metrische waarde op te zoeken.

geaccepteerde waarden: system, user
standaardwaarde: user
--resource-group -g

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

Globale parameters
--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

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

--subscription

Naam of id van het 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.

az iot edge deployment update

De opgegeven eigenschappen van een IoT Edge-implementatie bijwerken.

Gebruik --set gevolgd door eigenschapstoewijzingen voor het bijwerken van een implementatie.

Opmerking: IoT Edge-implementatie-inhoud is onveranderbaar. Implementatie-eigenschappen die kunnen worden bijgewerkt, zijn 'labels', 'metrische gegevens', 'prioriteit' en 'targetCondition'.

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

Voorbeelden

De labels en doelvoorwaarde van een bestaande randimplementatie wijzigen

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

Vereiste parameters

--deployment-id -d

Naam van doelimplementatie. Kleine letters en de volgende speciale tekens zijn toegestaan: [-+%_*!].

Optionele parameters

--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string or JSON string>.

standaardwaarde: []
--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>.

geaccepteerde waarden: key, login
standaardwaarde: key
--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.

--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

standaardwaarde: False
--hub-name -n

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

--login -l

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

--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

standaardwaarde: []
--resource-group -g

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

--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

standaardwaarde: []
Globale parameters
--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

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

--subscription

Naam of id van het 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.