az iot edge deployment
Notitie
Deze verwijzing maakt deel uit van de azure-iot-extensie voor Azure CLI en vereist versie 2.17.1 of hoger. De extensie wordt automatisch geïnstalleerd wanneer u de eerste keer een opdracht az iot edge deployment hebt uitgevoerd. Meer informatie over extensies.
Beheer IoT Edge implementaties op schaal.
Opdracht
| az iot edge deployment create |
Maak een IoT Edge in een doelimplementatie IoT Hub. |
| az iot edge deployment delete |
Een IoT Edge verwijderen. |
| az iot edge deployment list |
Lijst IoT Edge implementaties in een IoT Hub. |
| az iot edge deployment show |
Haal de details op van een IoT Edge implementatie. |
| az iot edge deployment show-metric |
Evalueer de metrische gegevens van een doelsysteem die zijn gedefinieerd in IoT Edge implementatie. |
| az iot edge deployment update |
De opgegeven eigenschappen van een IoT Edge bijgewerkt. 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 create
Maak een IoT Edge in een doelimplementatie IoT Hub.
Implementatie-inhoud is json en heeft de vorm {"modulesContent":{...}} of {"content":{"modulesContent":{...}}}.
Standaard worden eigenschappen van systeemmodules $edgeAgent en $edgeHub gevalideerd op schema's die zijn geïnstalleerd met de IoT-extensie. Dit kan worden uitgeschakeld met behulp van de schakelknop --no-validation.
Edge-implementaties kunnen worden gemaakt met door de gebruiker gedefinieerde metrische gegevens voor evaluatie op aanvraag. Metrische gegevens van gebruikers zijn json en in de vorm van {"query's":{...}} of {"metrics":{"queries":{...}}}.
az iot edge deployment create --content
--deployment-id
[--auth-type {key, login}]
[--hub-name]
[--lab]
[--layered {false, true}]
[--login]
[--metrics]
[--no-validation {false, true}]
[--pri]
[--resource-group]
[--target-condition]
Voorbeelden
Maak een implementatie met labels (voorbeeld van bash-syntaxis) die van toepassing is op apparaten in 'building 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 met de 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 met de omgeving 'dev'. Zowel metrische gegevens van gebruikers als inhoud van modules die inline zijn gedefinieerd (powershell-syntaxisvoorbeeld).
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'}}" --layered
Maak een gelaagde implementatie die van toepassing is op apparaten in 'building 9' en omgeving 'test'. Zowel metrische gegevens van gebruikers als inhoud van modules die inline zijn gedefinieerd (voorbeeld van bash-syntaxis).
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"}}' --layered
Maak een gelaagde implementatie die van toepassing is op apparaten in 'building 9' en omgeving 'test'. Zowel metrische gegevens van gebruikers als inhoud van modules die zijn gedefinieerd vanuit een bestand.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content layered_modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics metrics_content.json --layered
Vereiste parameters
IoT Edge implementatie-inhoud. Geef het bestandspad of de onbewerkte json op.
Naam van doelimplementatie.
Optionele parameters
Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .
IoT Hub naam.
Kaart van labels die moeten worden toegepast op de doelimplementatie. Gebruik de volgende indeling: {"key0":"value0", "key1":"value1"}".
Met gelaagde implementaties kunt u gewenste eigenschappen definiëren in $edgeAgent-, $edgeHub- en gebruikersmodules die een laag boven op een basisimplementatie zullen plaatsen. De routes die zijn opgegeven in een gelaagde implementatie worden bijvoorbeeld samengevoegd met routes van de basisimplementatie. Routes met dezelfde naam worden overschreven op basis van de implementatieprioriteit.
Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.
IoT Edge metrische definities voor implementatie. Geef het bestandspad of de onbewerkte json op.
Schakelt schemavalidatie aan clientzijde uit voor het maken van edge-implementaties.
Het gewicht van de implementatie in het geval van concurrerende regels (hoogste winst).
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Doelvoorwaarde waarop een Edge-implementatie van toepassing is.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot edge deployment delete
Een IoT Edge verwijderen.
az iot edge deployment delete --deployment-id
[--auth-type {key, login}]
[--etag]
[--hub-name]
[--login]
[--resource-group]
Vereiste parameters
Naam van doelimplementatie.
Optionele parameters
Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde * ' ' gebruikt.
IoT Hub naam.
Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot edge deployment list
Lijst IoT Edge implementaties in een IoT Hub.
az iot edge deployment list [--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
[--top]
Optionele parameters
Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .
IoT Hub naam.
Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Maximum aantal te retourneren implementaties. Standaard worden alle implementaties geretourneerd.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot edge deployment show
Haal de details op van een IoT Edge implementatie.
az iot edge deployment show --deployment-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
Vereiste parameters
Naam van doelimplementatie.
Optionele parameters
Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .
IoT Hub naam.
Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot edge deployment show-metric
Evalueer de metrische gegevens van een doelsysteem die zijn gedefinieerd in 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 systeemmetrische gegevens '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
Naam van doelimplementatie.
Doelmetrische gegevens voor evaluatie.
Optionele parameters
Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .
IoT Hub naam.
Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.
Geeft aan welke metrische verzameling moet worden gebruikt om een metrische gegevens op te zoeken.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot edge deployment update
De opgegeven eigenschappen van een IoT Edge bijgewerkt.
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 edge-implementatie wijzigen
az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'
Vereiste parameters
Naam van doelimplementatie.
Optionele parameters
Voeg een -object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string of JSON string>.
Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde * ' ' gebruikt.
Wanneer u 'set' of 'add' gebruikt, moet u letterlijke tekenreeksen bewaren in plaats van te proberen te converteren naar JSON.
IoT Hub naam.
Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.
Verwijder een eigenschap of een element uit een lijst. Voorbeeld: --remove property.list OR --remove propertyToRemove.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .
Werk een object bij door een eigenschapspad en waarde op te geven die moeten worden ingesteld. Voorbeeld: --set property1.property2=.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.