Dela via


az iot edge

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). Tillägget installeras automatiskt första gången du kör ett kommandot az iot edge. Learn more about extensions.

Hantera IoT-lösningar på Gränsen.

Kommandon

Name Description Typ Status
az iot edge deployment

Hantera IoT Edge-distributioner i stor skala.

Extension GA
az iot edge deployment create

Skapa en IoT Edge-distribution i en mål-IoT Hub.

Extension GA
az iot edge deployment delete

Ta bort en IoT Edge-distribution.

Extension GA
az iot edge deployment list

Lista IoT Edge-distributioner i en IoT Hub.

Extension GA
az iot edge deployment show

Hämta information om en IoT Edge-distribution.

Extension GA
az iot edge deployment show-metric

Utvärdera ett målsystemmått som definierats i en IoT Edge-distribution.

Extension GA
az iot edge deployment update

Uppdatera angivna egenskaper för en IoT Edge-distribution.

Extension GA
az iot edge devices

Kommandon för att hantera IoT Edge-enheter.

Extension GA
az iot edge devices create

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

Extension Experimental
az iot edge export-modules

Exportera edge-modulernas konfiguration på en enhet med en enda kant.

Extension GA
az iot edge set-modules

Ange gränsmoduler på en enda enhet.

Extension GA

az iot edge export-modules

Exportera edge-modulernas konfiguration på en enhet med en enda kant.

Konfigurationsutdata för modultvillingar kan användas direkt som --content i "az iot edge set-modules".

az iot edge export-modules --device-id
                           [--auth-type {key, login}]
                           [--hub-name]
                           [--login]
                           [--resource-group]

Exempel

Exportera konfiguration av modultvillingar på en målenhet.

az iot edge export-modules --hub-name {iothub_name} --device-id {device_id}

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Egenskap Värde
Parameter group: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Output format.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az iot edge set-modules

Ange gränsmoduler på en enda enhet.

Modulinnehåll är json och i form av {"modulesContent":{...}} or {"content":{"modulesContent":{...}}}.

Som standard verifieras egenskaper för systemmoduler $edgeAgent och $edgeHub mot scheman som har installerats med IoT-tillägget. Detta kan inaktiveras med växeln --no-validation.

Obs! Vid körningen matar kommandot ut den samling moduler som tillämpas på enheten.

az iot edge set-modules --content
                        --device-id
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--resource-group]

Exempel

Testa edge-moduler under utveckling genom att ange moduler på en målenhet.

az iot edge set-modules --hub-name {iothub_name} --device-id {device_id} --content ../modules_content.json

Obligatoriska parametrar

--content -k

IoT Edge-distributionsinnehåll. Ange filsökväg eller rå json.

--device-id -d

Målenhets-ID.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Egenskap Värde
Parameter group: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Output format.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False