Delen via

az iot du device deployment

  • Referentie

Notitie

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

Beheer van apparaatimplementatie.

Implementaties passen een gewenste compatibele update toe op basis van een doelapparaatgroep die de update over apparaatklassen binnen de groep distribueert. Door de cloud geïnitieerd terugdraaibeleid kan eventueel worden geconfigureerd.

Opdracht

Name Description Type Status
az iot du device deployment cancel

Annuleer een subgroepimplementatie van een apparaatklasse.

 Toestel GA
az iot du device deployment create

Maak een implementatie voor een apparaatgroep. De implementatie wordt multicast voor elke subgroep van apparaatklassen binnen de doelgroep.

 Toestel GA
az iot du device deployment delete

Een implementatie verwijderen per apparaatgroep of subgroep van apparaatklasse.

 Toestel GA
az iot du device deployment list

Lijst met implementaties voor een apparaatgroep of subgroep van apparaatklassen.

 Toestel GA
az iot du device deployment list-devices

Apparaten weergeven in een subgroepimplementatie van een apparaatklasse, samen met hun status. Handig voor het ophalen van een lijst met mislukte apparaten.

 Toestel GA
az iot du device deployment retry

Voer een subgroepimplementatie van een apparaatklasse opnieuw uit.

 Toestel GA
az iot du device deployment show

Een implementatie weergeven voor een apparaatgroep of subgroep van apparaatklasse, inclusief de status waarin wordt uitgesplitst hoeveel apparaten in de implementatie worden uitgevoerd, voltooid of mislukt.

 Toestel GA

az iot du device deployment cancel

Annuleer een subgroepimplementatie van een apparaatklasse.

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

Voorbeelden

Annuleer de subgroepimplementatie van de doelapparaatklasse.

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}

Vereiste parameters

--account -n

Accountnaam voor apparaatupdate. U kunt de standaardaccountnaam configureren met behulp van az config set defaults.adu_account=<name>.

--cid --class-id

Apparaatklasse-id. Dit wordt gegenereerd op basis van de model-id en de compatibiliteitseigenschappen die worden gerapporteerd door de apparaatupdateagent in de PnP-interface van Device Update in IoT Hub. Het is een hex-gecodeerde SHA1-hash.

--deployment-id --did

De door de aanroeper verstrekte implementatie-id. Dit mag niet langer zijn dan 73 tekens, moet allemaal kleine letters bevatten en mag geen '&', '^', '[', ']', '{', '}', '|', '', '<', '' bevatten>, slash, backslash of dubbele aanhalingstekens.

--gid --group-id

Apparaatgroep-id. Dit wordt gemaakt op basis van de waarde van de ADUGroup-tag in de apparaat-/moduledubbel van de verbonden IoT Hub of $default voor apparaten zonder tag.

--instance -i

De naam van het apparaatupdate-exemplaar. U kunt de naam van het standaardexemplaren configureren met behulp van az config set defaults.adu_instance=<name>.

Optionele parameters

--resource-group -g

Resourcegroepnaam voor apparaatupdate-account. U kunt de standaardgroep configureren met behulp van az config set defaults.adu_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 du device deployment create

Maak een implementatie voor een apparaatgroep. De implementatie wordt multicast voor elke subgroep van apparaatklassen binnen de doelgroep.

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]

Voorbeelden

Maak een implementatie van een apparaatgroep die onmiddellijk moet worden gestart (met betrekking tot UTC-tijd).

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}

Maak een implementatie van een apparaatgroep die is gepland om te beginnen op een gewenste iso-8601-compatibele datum/tijd.

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"

Maak een implementatie van een apparaatgroep die is gepland om onmiddellijk te beginnen met een gedefinieerd door de cloud geïnitieerd terugdraaibeleid. Het terugdraaien van de cloud wordt gestart wanneer is voldaan aan het aantal mislukte of mislukte percentagedoelen.

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}

Vereiste parameters

--account -n

Accountnaam voor apparaatupdate. U kunt de standaardaccountnaam configureren met behulp van az config set defaults.adu_account=<name>.

--deployment-id --did

De door de aanroeper verstrekte implementatie-id. Dit mag niet langer zijn dan 73 tekens, moet allemaal kleine letters bevatten en mag geen '&', '^', '[', ']', '{', '}', '|', '', '<', '' bevatten>, slash, backslash of dubbele aanhalingstekens.

--gid --group-id

Apparaatgroep-id. Dit wordt gemaakt op basis van de waarde van de ADUGroup-tag in de apparaat-/moduledubbel van de verbonden IoT Hub of $default voor apparaten zonder tag.

--instance -i

De naam van het apparaatupdate-exemplaar. U kunt de naam van het standaardexemplaren configureren met behulp van az config set defaults.adu_instance=<name>.

--un --update-name

De naam van de update.

--up --update-provider

De updateprovider.

--update-version --uv

De updateversie.

Optionele parameters

--failed-count --fc

Geheel getal dat het aantal mislukte apparaten in een implementatie vertegenwoordigt voordat een terugdraaiactie in de cloud plaatsvindt. Vereist bij het definiëren van beleid voor terugdraaien.

--failed-percentage --fp

Geheel getal dat het percentage mislukte apparaten in een implementatie vertegenwoordigt voordat een terugdraaiactie in de cloud plaatsvindt. Vereist bij het definiëren van beleid voor terugdraaien.

--rbun --rollback-update-name

De naam van de update voor terugdraaien.

--rbup --rollback-update-provider

De updateprovider voor terugdraaien.

--rbuv --rollback-update-version

De updateversie voor terugdraaien.

--resource-group -g

Resourcegroepnaam voor apparaatupdate-account. U kunt de standaardgroep configureren met behulp van az config set defaults.adu_group=<name>.

--start-time

De iso-8601-compatibele begintijd voor implementatie. Als er geen waarde is opgegeven, wordt de bijbehorende waarde voor UTC 'nu' gebruikt.

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

Een implementatie verwijderen per apparaatgroep of subgroep van apparaatklasse.

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

Voorbeelden

Verwijder de implementatie van de doelapparaatgroep.

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

Verwijder de subgroepimplementatie van de doelapparaatklasse.

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}

Vereiste parameters

--account -n

Accountnaam voor apparaatupdate. U kunt de standaardaccountnaam configureren met behulp van az config set defaults.adu_account=<name>.

--deployment-id --did

De door de aanroeper verstrekte implementatie-id. Dit mag niet langer zijn dan 73 tekens, moet allemaal kleine letters bevatten en mag geen '&', '^', '[', ']', '{', '}', '|', '', '<', '' bevatten>, slash, backslash of dubbele aanhalingstekens.

--gid --group-id

Apparaatgroep-id. Dit wordt gemaakt op basis van de waarde van de ADUGroup-tag in de apparaat-/moduledubbel van de verbonden IoT Hub of $default voor apparaten zonder tag.

--instance -i

De naam van het apparaatupdate-exemplaar. U kunt de naam van het standaardexemplaren configureren met behulp van az config set defaults.adu_instance=<name>.

Optionele parameters

--cid --class-id

Apparaatklasse-id. Dit wordt gegenereerd op basis van de model-id en de compatibiliteitseigenschappen die worden gerapporteerd door de apparaatupdateagent in de PnP-interface van Device Update in IoT Hub. Het is een hex-gecodeerde SHA1-hash.

--resource-group -g

Resourcegroepnaam voor apparaatupdate-account. U kunt de standaardgroep configureren met behulp van az config set defaults.adu_group=<name>.

--yes -y

Gebruikersprompts overslaan. Geeft de acceptatie van de actie aan. Wordt voornamelijk gebruikt voor automatiseringsscenario's. Standaard: onwaar.

geaccepteerde waarden: false, true
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 du device deployment list

Lijst met implementaties voor een apparaatgroep of subgroep van apparaatklassen.

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

Voorbeelden

Implementaties voor een apparaatgroep weergeven.

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

Lijst met implementaties voor een apparaatgroepvolgorderesultaten door aflopend te beginnenDateTime.

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

Implementaties voor een subgroep van een apparaatklasse weergeven.

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

Vereiste parameters

--account -n

Accountnaam voor apparaatupdate. U kunt de standaardaccountnaam configureren met behulp van az config set defaults.adu_account=<name>.

--gid --group-id

Apparaatgroep-id. Dit wordt gemaakt op basis van de waarde van de ADUGroup-tag in de apparaat-/moduledubbel van de verbonden IoT Hub of $default voor apparaten zonder tag.

--instance -i

De naam van het apparaatupdate-exemplaar. U kunt de naam van het standaardexemplaren configureren met behulp van az config set defaults.adu_instance=<name>.

Optionele parameters

--cid --class-id

Apparaatklasse-id. Dit wordt gegenereerd op basis van de model-id en de compatibiliteitseigenschappen die worden gerapporteerd door de apparaatupdateagent in de PnP-interface van Device Update in IoT Hub. Het is een hex-gecodeerde SHA1-hash.

--order-by

Hiermee wordt de set implementaties besteld die zijn geretourneerd. U kunt bestellen door startDateTime [desc/asc].

--resource-group -g

Resourcegroepnaam voor apparaatupdate-account. U kunt de standaardgroep configureren met behulp van az config set defaults.adu_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 du device deployment list-devices

Apparaten weergeven in een subgroepimplementatie van een apparaatklasse, samen met hun status. Handig voor het ophalen van een lijst met mislukte apparaten.

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

Voorbeelden

Apparaten weergeven in een subgroepimplementatie van een apparaatklasse.

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}

Apparaten in een subgroepsimplementatie van een apparaatklasse weergeven op basis van deviceId en 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'"

Vereiste parameters

--account -n

Accountnaam voor apparaatupdate. U kunt de standaardaccountnaam configureren met behulp van az config set defaults.adu_account=<name>.

--cid --class-id

Apparaatklasse-id. Dit wordt gegenereerd op basis van de model-id en de compatibiliteitseigenschappen die worden gerapporteerd door de apparaatupdateagent in de PnP-interface van Device Update in IoT Hub. Het is een hex-gecodeerde SHA1-hash.

--deployment-id --did

De door de aanroeper verstrekte implementatie-id. Dit mag niet langer zijn dan 73 tekens, moet allemaal kleine letters bevatten en mag geen '&', '^', '[', ']', '{', '}', '|', '', '<', '' bevatten>, slash, backslash of dubbele aanhalingstekens.

--gid --group-id

Apparaatgroep-id. Dit wordt gemaakt op basis van de waarde van de ADUGroup-tag in de apparaat-/moduledubbel van de verbonden IoT Hub of $default voor apparaten zonder tag.

--instance -i

De naam van het apparaatupdate-exemplaar. U kunt de naam van het standaardexemplaren configureren met behulp van az config set defaults.adu_instance=<name>.

Optionele parameters

--filter

Hiermee beperkt u de set implementatieapparaatstatussen die worden geretourneerd. U kunt filteren op deviceId en moduleId en/of deviceState.

--resource-group -g

Resourcegroepnaam voor apparaatupdate-account. U kunt de standaardgroep configureren met behulp van az config set defaults.adu_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 du device deployment retry

Voer een subgroepimplementatie van een apparaatklasse opnieuw uit.

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

Voorbeelden

Voer de subgroepimplementatie van de doelapparaatklasse opnieuw uit.

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}

Vereiste parameters

--account -n

Accountnaam voor apparaatupdate. U kunt de standaardaccountnaam configureren met behulp van az config set defaults.adu_account=<name>.

--cid --class-id

Apparaatklasse-id. Dit wordt gegenereerd op basis van de model-id en de compatibiliteitseigenschappen die worden gerapporteerd door de apparaatupdateagent in de PnP-interface van Device Update in IoT Hub. Het is een hex-gecodeerde SHA1-hash.

--deployment-id --did

De door de aanroeper verstrekte implementatie-id. Dit mag niet langer zijn dan 73 tekens, moet allemaal kleine letters bevatten en mag geen '&', '^', '[', ']', '{', '}', '|', '', '<', '' bevatten>, slash, backslash of dubbele aanhalingstekens.

--gid --group-id

Apparaatgroep-id. Dit wordt gemaakt op basis van de waarde van de ADUGroup-tag in de apparaat-/moduledubbel van de verbonden IoT Hub of $default voor apparaten zonder tag.

--instance -i

De naam van het apparaatupdate-exemplaar. U kunt de naam van het standaardexemplaren configureren met behulp van az config set defaults.adu_instance=<name>.

Optionele parameters

--resource-group -g

Resourcegroepnaam voor apparaatupdate-account. U kunt de standaardgroep configureren met behulp van az config set defaults.adu_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 du device deployment show

Een implementatie weergeven voor een apparaatgroep of subgroep van apparaatklasse, inclusief de status waarin wordt uitgesplitst hoeveel apparaten in de implementatie worden uitgevoerd, voltooid of mislukt.

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

Voorbeelden

Een implementatie voor een apparaatgroep weergeven.

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

De status van een implementatie van een apparaatgroep weergeven.

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

Een implementatie voor een subgroep van een apparaatklasse weergeven.

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}

De status van een subgroepimplementatie van een apparaatklasse weergeven.

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

Vereiste parameters

--account -n

Accountnaam voor apparaatupdate. U kunt de standaardaccountnaam configureren met behulp van az config set defaults.adu_account=<name>.

--deployment-id --did

De door de aanroeper verstrekte implementatie-id. Dit mag niet langer zijn dan 73 tekens, moet allemaal kleine letters bevatten en mag geen '&', '^', '[', ']', '{', '}', '|', '', '<', '' bevatten>, slash, backslash of dubbele aanhalingstekens.

--gid --group-id

Apparaatgroep-id. Dit wordt gemaakt op basis van de waarde van de ADUGroup-tag in de apparaat-/moduledubbel van de verbonden IoT Hub of $default voor apparaten zonder tag.

--instance -i

De naam van het apparaatupdate-exemplaar. U kunt de naam van het standaardexemplaren configureren met behulp van az config set defaults.adu_instance=<name>.

Optionele parameters

--cid --class-id

Apparaatklasse-id. Dit wordt gegenereerd op basis van de model-id en de compatibiliteitseigenschappen die worden gerapporteerd door de apparaatupdateagent in de PnP-interface van Device Update in IoT Hub. Het is een hex-gecodeerde SHA1-hash.

--resource-group -g

Resourcegroepnaam voor apparaatupdate-account. U kunt de standaardgroep configureren met behulp van az config set defaults.adu_group=<name>.

--status

Haalt de status van een implementatie op, inclusief een uitsplitsing van het aantal apparaten in de implementatie dat wordt uitgevoerd, voltooid of mislukt.

geaccepteerde waarden: false, true
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.