Dela via

az iot edge deployment

Note

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.59.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot edge-distribution kommando. Läs mer om tillägg.

Hantera IoT Edge-distributioner i stor skala.

Kommandon

Name Description Typ Status
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 deployment create

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

Distributionsinnehållet är json och i form av {"modulesContent":{...}} eller {"content":{"modulesContent":{...}}}.

Som standard verifieras egenskaper för systemmoduler $edgeAgent och $edgeHub mot scheman som har installerats med IoT-tillägget. Den här valideringen är avsedd för basdistributioner. Om motsvarande schema inte är tillgängligt eller om basdistributionsformatet inte identifieras hoppas det här steget över. Schemavalidering kan inaktiveras med växeln --no-validation.

En gränsdistribution klassificeras som skiktad om en modul har properties.desired.* definierat. Alla gränsenheter som är mål för en distribution i flera lager behöver först en basdistribution som tillämpas på den.

Alla distributioner i lager som riktar sig till en enhet måste ha högre prioritet än basdistributionen för den enheten.

Obs! Om fältet properties.desired för en modultvilling anges i en distribution i flera lager skriver properties.desired över de önskade egenskaperna för modulen i eventuella distributioner med lägre prioritet.

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--cl --custom-labels]
                              [--cmq --custom-metric-queries]
                              [--hub-name]
                              [--lab --labels]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri --priority]
                              [--resource-group]
                              [--target-condition --tc]

Exempel

Skapa en distribution med etiketter (bash-syntaxexempel) som gäller för enheter i "building 9" och miljön är "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

Skapa en distribution med etiketter (powershell-syntaxexempel) som gäller för enheter som är taggade med miljön dev.

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

Skapa en distribution i flera lager som gäller för enheter som är taggade med miljön dev. Innehåll för både användarmått och moduler som definierats infogat (powershell-syntaxexempel). Observera att detta är i lagerdistributionsformat som properties.desired.* har definierats.

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

Skapa en distribution i flera lager som gäller för enheter i "building 9" och miljötest. Innehåll för både användarmått och moduler som definierats infogat (bash-syntaxexempel). Observera att detta är i lagerdistributionsformat som properties.desired.* har definierats.

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

Skapa en distribution som gäller för enheter i "building 9" och miljö "test". Både användarmått och modulinnehåll som definierats från filen.

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

Skapa en distribution vars definition är från en fil med gränssnittsagnostiska indata för etiketter och mått.

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

Obligatoriska parametrar

--content -k

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

--deployment-id -d

Namn på måldistribution. Gemener och följande specialtecken tillåts: [-+%_*!'].

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
--cl --custom-labels

Ett alternativt indataformat (blankstegsavgränsad nyckel=värdepar) för --labels och avsett att ersätta det i framtiden. Formatexempel: key1=value1 key2="this is my value".

--cmq --custom-metric-queries

Ett alternativt indataformat (blankstegsavgränsade nyckel=värdepar) för --metrics och avsett att ersätta det i framtiden. Formatexempel: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--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
--lab --labels

Karta över etiketter som ska tillämpas på måldistributionen. Använd följande format: {"key0":"value0", "key1":"value1"}. Använd --custom-labels i stället för --labels rekommenderas.

--layered

Med lagerdistributioner kan du definiera önskade egenskaper i $edgeAgent, $edgeHub- och användarmoduler som läggs ovanpå en basdistribution. Egenskaperna som anges i en lagerdistribution sammanfogas med egenskaperna för basdistributionen. Egenskaper med samma sökväg skrivs över baserat på distributionsprioritet. Det här alternativet är ett alias för --no-validation.

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

Användarmåttdefinitioner för IoT Edge-distribution. Ange filsökväg eller rå json. Användarmått är i form av {"queries":{...}} eller {"metrics":{"queries":{...}}}. Användning av --custom-metric-queries i stället för --metrics rekommenderas.

--no-validation

Inaktiverar schemavalidering på klientsidan för skapande av gränsdistribution.

Egenskap Värde
Standardvärde: False
Godkända värden: false, true
--pri --priority

Distributionens vikt vid konkurrerande regler (högsta vinster).

Egenskap Värde
Standardvärde: 0
--resource-group -g

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

--target-condition --tc -t

Målvillkor där en gränsdistribution gäller för. Distributioner utan målvillkor kommer inte att rikta in sig på någon enhet. Använd följande format: "tags.environment='test'".

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

Utdataformat.

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 deployment delete

Ta bort en IoT Edge-distribution.

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

Obligatoriska parametrar

--deployment-id -d

Namn på måldistribution. Gemener och följande specialtecken tillåts: [-+%_*!'].

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
--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

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

Utdataformat.

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 deployment list

Lista IoT Edge-distributioner i en IoT Hub.

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

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

--top

Maximalt antal distributioner som ska returneras. Som standard returneras alla distributioner.

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

Utdataformat.

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 deployment show

Hämta information om en IoT Edge-distribution.

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

Obligatoriska parametrar

--deployment-id -d

Namn på måldistribution. Gemener och följande specialtecken tillåts: [-+%_*!'].

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

Utdataformat.

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 deployment show-metric

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

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

Exempel

Utvärdera systemmåttet "appliedCount"

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

Utvärdera användarmåttet "myCustomMetric"

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

Obligatoriska parametrar

--deployment-id -d

Namn på måldistribution. Gemener och följande specialtecken tillåts: [-+%_*!'].

--metric-id -m

Målmått för utvärdering.

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
--metric-type --mt

Anger vilken måttsamling som ska användas för att söka efter ett mått.

Egenskap Värde
Standardvärde: user
Godkända värden: system, user
--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

Utdataformat.

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 deployment update

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

Använd --set följt av egenskapstilldelningar för uppdatering av en distribution.

Obs! IoT Edge-distributionsinnehåll är oföränderligt. Distributionsegenskaper som kan uppdateras är "etiketter", "mått", "prioritet" och "targetCondition".

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

Exempel

Ändra etiketter och målvillkor för en befintlig gränsdistribution

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

Obligatoriska parametrar

--deployment-id -d

Namn på måldistribution. Gemener och följande specialtecken tillåts: [-+%_*!'].

Valfria parametrar

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

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

Egenskap Värde
Parameter group: Generic Update Arguments
Standardvärde: []
--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
--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

Egenskap Värde
Parameter group: Generic Update Arguments
Standardvärde: False
--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
--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

Egenskap Värde
Parameter group: Generic Update Arguments
Standardvärde: []
--resource-group -g

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

--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

Egenskap Värde
Parameter group: Generic Update Arguments
Standardvärde: []
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

Utdataformat.

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