az iot du device deployment

  • Referens

Kommentar

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

Hantering av enhetsdistribution.

Distributioner tillämpar en önskad kompatibel uppdatering mot en målenhetsgrupp som distribuerar uppdateringen mellan enhetsklasser i gruppen. Molninitierad återställningsprincip kan konfigureras valfritt.

Kommandon

Name Description Typ Status
az iot du device deployment cancel

Avbryt en distribution av enhetsklassundergrupper.

 Anknytning Allmän tillgänglighet
az iot du device deployment create

Skapa en distribution för en enhetsgrupp. Distributionen kommer att vara multi-cast mot varje enhet klass undergrupp inom målgruppen.

 Anknytning Allmän tillgänglighet
az iot du device deployment delete

Ta bort en distribution efter enhetsgrupp eller undergrupp för enhetsklass.

 Anknytning Allmän tillgänglighet
az iot du device deployment list

Visa en lista över distributioner för en undergrupp för enhetsgrupper eller enhetsklasser.

 Anknytning Allmän tillgänglighet
az iot du device deployment list-devices

Lista enheter i en undergruppsdistribution för enhetsklass tillsammans med deras tillstånd. Användbart för att hämta en lista över misslyckade enheter.

 Anknytning Allmän tillgänglighet
az iot du device deployment retry

Försök igen med en undergruppsdistribution av enhetsklassen.

 Anknytning Allmän tillgänglighet
az iot du device deployment show

Visa en distribution för en enhetsgrupp eller enhetsklassundergrupp, inklusive status som beskriver en uppdelning av hur många enheter i distributionen som pågår, slutförs eller misslyckas.

 Anknytning Allmän tillgänglighet

az iot du device deployment cancel

Avbryt en distribution av enhetsklassundergrupper.

az iot du device deployment cancel --account
                                   --cid
                                   --deployment-id
                                   --gid
                                   --instance
                                   [--resource-group]

Exempel

Avbryt undergruppsdistributionen för målenhetens klass.

az iot du device deployment cancel -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

Obligatoriska parametrar

--account -n

Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med .az config set defaults.adu_account=<name>

--cid --class-id

Enhetsklass-ID. Detta genereras från modell-ID och de kompatibilitetsegenskaper som rapporteras av enhetsuppdateringsagenten i PnP-gränssnittet för enhetsuppdatering i IoT Hub. Det är en hexkodad SHA1-hash.

--deployment-id --did

Distributions-ID:t som tillhandahålls av anroparen. Det får inte vara längre än 73 tecken, det måste vara gemener och får inte innehålla '&', '^', '[', ']', '{', '}', '|', '<', '>', snedstreck, omvänt snedstreck eller dubbla citattecken.

--gid --group-id

Enhetsgrupp-ID. Detta skapas från värdet för taggen ADUGroup i den anslutna IoT Hub-enhets-/modultvillingen eller $default för enheter utan tagg.

--instance -i

Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med .az config set defaults.adu_instance=<name>

Valfria parametrar

--resource-group -g

Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med .az config set defaults.adu_group=<name>

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot du device deployment create

Skapa en distribution för en enhetsgrupp. Distributionen kommer att vara multi-cast mot varje enhet klass undergrupp inom målgruppen.

az iot du device deployment create --account
                                   --deployment-id
                                   --gid
                                   --instance
                                   --un
                                   --up
                                   --update-version
                                   [--failed-count]
                                   [--failed-percentage]
                                   [--rbun]
                                   [--rbup]
                                   [--rbuv]
                                   [--resource-group]
                                   [--start-time]

Exempel

Skapa en enhetsgruppsdistribution som är schemalagd att starta omedelbart (med avseende på UTC-tid).

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version}

Skapa en enhetsgruppsdistribution som är schemalagd för att starta på en önskad iso-8601-kompatibel datetime.

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --start-time "2022-12-20T01:00:00"

Skapa en enhetsgruppsdistribution som är schemalagd att starta omedelbart med en definierad molninitierad återställningsprincip. Molnåterställningen initieras när antalet misslyckade eller misslyckade procentmål uppfylls.

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --failed-count 10 --failed-percentage 5 --rollback-update-name {rollback_update_name} --rollback-update-provider {rollback_update_provider} --rollback-update-version {rollback_update_version}

Obligatoriska parametrar

--account -n

Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med .az config set defaults.adu_account=<name>

--deployment-id --did

Distributions-ID:t som tillhandahålls av anroparen. Det får inte vara längre än 73 tecken, det måste vara gemener och får inte innehålla '&', '^', '[', ']', '{', '}', '|', '<', '>', snedstreck, omvänt snedstreck eller dubbla citattecken.

--gid --group-id

Enhetsgrupp-ID. Detta skapas från värdet för taggen ADUGroup i den anslutna IoT Hub-enhets-/modultvillingen eller $default för enheter utan tagg.

--instance -i

Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med .az config set defaults.adu_instance=<name>

--un --update-name

Uppdateringsnamnet.

--up --update-provider

Uppdateringsprovidern.

--update-version --uv

Uppdateringsversionen.

Valfria parametrar

--failed-count --fc

Heltal som representerar antalet misslyckade enheter i en distribution innan en molnbaserad återställning inträffar. Krävs vid definition av återställningsprincip.

--failed-percentage --fp

Heltal som representerar procentandelen misslyckade enheter i en distribution innan en molnbaserad återställning sker. Krävs vid definition av återställningsprincip.

--rbun --rollback-update-name

Återställningsuppdateringens namn.

--rbup --rollback-update-provider

Återställningsuppdateringsprovidern.

--rbuv --rollback-update-version

Återställningsuppdateringsversionen.

--resource-group -g

Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med .az config set defaults.adu_group=<name>

--start-time

Iso-8601-kompatibel starttid för distribution. Om inget värde anges används motsvarande värde för UTC "nu".

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot du device deployment delete

Ta bort en distribution efter enhetsgrupp eller undergrupp för enhetsklass.

az iot du device deployment delete --account
                                   --deployment-id
                                   --gid
                                   --instance
                                   [--cid]
                                   [--resource-group]
                                   [--yes {false, true}]

Exempel

Ta bort distributionen av målenhetsgruppen.

az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id}

Ta bort undergruppsdistributionen för målenhetens klass.

az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

Obligatoriska parametrar

--account -n

Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med .az config set defaults.adu_account=<name>

--deployment-id --did

Distributions-ID:t som tillhandahålls av anroparen. Det får inte vara längre än 73 tecken, det måste vara gemener och får inte innehålla '&', '^', '[', ']', '{', '}', '|', '<', '>', snedstreck, omvänt snedstreck eller dubbla citattecken.

--gid --group-id

Enhetsgrupp-ID. Detta skapas från värdet för taggen ADUGroup i den anslutna IoT Hub-enhets-/modultvillingen eller $default för enheter utan tagg.

--instance -i

Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med .az config set defaults.adu_instance=<name>

Valfria parametrar

--cid --class-id

Enhetsklass-ID. Detta genereras från modell-ID och de kompatibilitetsegenskaper som rapporteras av enhetsuppdateringsagenten i PnP-gränssnittet för enhetsuppdatering i IoT Hub. Det är en hexkodad SHA1-hash.

--resource-group -g

Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med .az config set defaults.adu_group=<name>

--yes -y

Hoppa över användarprompter. Anger godkännande av åtgärd. Används främst för automatiseringsscenarier. Standard: falskt.

accepterade värden: false, true
Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot du device deployment list

Visa en lista över distributioner för en undergrupp för enhetsgrupper eller enhetsklasser.

az iot du device deployment list --account
                                 --gid
                                 --instance
                                 [--cid]
                                 [--order-by]
                                 [--resource-group]

Exempel

Lista distributioner för en enhetsgrupp.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id}

Visa en lista över distributioner för en enhetsgrupp som beställer resultat efter startDateTime-fallande.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --order-by "startDateTime desc"

Lista distributioner för en undergrupp för enhetsklass.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id}

Obligatoriska parametrar

--account -n

Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med .az config set defaults.adu_account=<name>

--gid --group-id

Enhetsgrupp-ID. Detta skapas från värdet för taggen ADUGroup i den anslutna IoT Hub-enhets-/modultvillingen eller $default för enheter utan tagg.

--instance -i

Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med .az config set defaults.adu_instance=<name>

Valfria parametrar

--cid --class-id

Enhetsklass-ID. Detta genereras från modell-ID och de kompatibilitetsegenskaper som rapporteras av enhetsuppdateringsagenten i PnP-gränssnittet för enhetsuppdatering i IoT Hub. Det är en hexkodad SHA1-hash.

--order-by

Beställer den uppsättning distributioner som returneras. Du kan beställa efter startDateTime [desc/asc].

--resource-group -g

Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med .az config set defaults.adu_group=<name>

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot du device deployment list-devices

Lista enheter i en undergruppsdistribution för enhetsklass tillsammans med deras tillstånd. Användbart för att hämta en lista över misslyckade enheter.

az iot du device deployment list-devices --account
                                         --cid
                                         --deployment-id
                                         --gid
                                         --instance
                                         [--filter]
                                         [--resource-group]

Exempel

Lista enheter i en undergruppsdistribution för enhetsklass.

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

Lista enheter i en undergruppsdistributionsfiltrering för enhetsklass efter deviceId och deviceState.

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --filter "deviceId eq 'd0' and deviceState eq 'InProgress'"

Obligatoriska parametrar

--account -n

Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med .az config set defaults.adu_account=<name>

--cid --class-id

Enhetsklass-ID. Detta genereras från modell-ID och de kompatibilitetsegenskaper som rapporteras av enhetsuppdateringsagenten i PnP-gränssnittet för enhetsuppdatering i IoT Hub. Det är en hexkodad SHA1-hash.

--deployment-id --did

Distributions-ID:t som tillhandahålls av anroparen. Det får inte vara längre än 73 tecken, det måste vara gemener och får inte innehålla '&', '^', '[', ']', '{', '}', '|', '<', '>', snedstreck, omvänt snedstreck eller dubbla citattecken.

--gid --group-id

Enhetsgrupp-ID. Detta skapas från värdet för taggen ADUGroup i den anslutna IoT Hub-enhets-/modultvillingen eller $default för enheter utan tagg.

--instance -i

Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med .az config set defaults.adu_instance=<name>

Valfria parametrar

--filter

Begränsar den uppsättning tillstånd för distributionsenheter som returneras. Du kan filtrera på deviceId och moduleId och/eller deviceState.

--resource-group -g

Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med .az config set defaults.adu_group=<name>

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot du device deployment retry

Försök igen med en undergruppsdistribution av enhetsklassen.

az iot du device deployment retry --account
                                  --cid
                                  --deployment-id
                                  --gid
                                  --instance
                                  [--resource-group]

Exempel

Försök att distribuera undergruppsdistributionen för målenhetsklassen igen.

az iot du device deployment retry -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

Obligatoriska parametrar

--account -n

Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med .az config set defaults.adu_account=<name>

--cid --class-id

Enhetsklass-ID. Detta genereras från modell-ID och de kompatibilitetsegenskaper som rapporteras av enhetsuppdateringsagenten i PnP-gränssnittet för enhetsuppdatering i IoT Hub. Det är en hexkodad SHA1-hash.

--deployment-id --did

Distributions-ID:t som tillhandahålls av anroparen. Det får inte vara längre än 73 tecken, det måste vara gemener och får inte innehålla '&', '^', '[', ']', '{', '}', '|', '<', '>', snedstreck, omvänt snedstreck eller dubbla citattecken.

--gid --group-id

Enhetsgrupp-ID. Detta skapas från värdet för taggen ADUGroup i den anslutna IoT Hub-enhets-/modultvillingen eller $default för enheter utan tagg.

--instance -i

Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med .az config set defaults.adu_instance=<name>

Valfria parametrar

--resource-group -g

Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med .az config set defaults.adu_group=<name>

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot du device deployment show

Visa en distribution för en enhetsgrupp eller enhetsklassundergrupp, inklusive status som beskriver en uppdelning av hur många enheter i distributionen som pågår, slutförs eller misslyckas.

az iot du device deployment show --account
                                 --deployment-id
                                 --gid
                                 --instance
                                 [--cid]
                                 [--resource-group]
                                 [--status {false, true}]

Exempel

Visa en distribution för en enhetsgrupp.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id}

Visa status för en enhetsgruppsdistribution.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --status

Visa en distribution för en undergrupp för enhetsklass.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

Visa status för en undergruppsdistribution för enhetsklass.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --status

Obligatoriska parametrar

--account -n

Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med .az config set defaults.adu_account=<name>

--deployment-id --did

Distributions-ID:t som tillhandahålls av anroparen. Det får inte vara längre än 73 tecken, det måste vara gemener och får inte innehålla '&', '^', '[', ']', '{', '}', '|', '<', '>', snedstreck, omvänt snedstreck eller dubbla citattecken.

--gid --group-id

Enhetsgrupp-ID. Detta skapas från värdet för taggen ADUGroup i den anslutna IoT Hub-enhets-/modultvillingen eller $default för enheter utan tagg.

--instance -i

Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med .az config set defaults.adu_instance=<name>

Valfria parametrar

--cid --class-id

Enhetsklass-ID. Detta genereras från modell-ID och de kompatibilitetsegenskaper som rapporteras av enhetsuppdateringsagenten i PnP-gränssnittet för enhetsuppdatering i IoT Hub. Det är en hexkodad SHA1-hash.

--resource-group -g

Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med .az config set defaults.adu_group=<name>

--status

Hämtar status för en distribution, inklusive en uppdelning av hur många enheter i distributionen som pågår, slutförs eller misslyckas.

accepterade värden: false, true
Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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