Delen via


az iot du instance

Note

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.67.0 of hoger). De extensie wordt automatisch geïnstalleerd wanneer u een az iot du instance opdracht uitvoert. Meer informatie over uitbreidingen.

Beheer van het apparaatupdate-exemplaar.

Opdracht

Name Description Type Status
az iot du instance create

Maak een Device Update-exemplaar.

Extension GA
az iot du instance delete

Een device update-exemplaar verwijderen.

Extension GA
az iot du instance list

Geef exemplaren van Device Update weer.

Extension GA
az iot du instance show

Een device update-exemplaar weergeven.

Extension GA
az iot du instance update

Een device update-exemplaar bijwerken.

Extension GA
az iot du instance wait

Blokkeren totdat aan de resourcestatus van een gewenst exemplaar is voldaan.

Extension GA

az iot du instance create

Maak een Device Update-exemplaar.

Deze opdracht kan ook worden gebruikt om de status van een bestaand exemplaar bij te werken.

az iot du instance create --account
                          --instance
                          --iothub-ids
                          [--diagnostics-storage-id]
                          [--enable-diagnostics {false, true}]
                          [--no-wait]
                          [--resource-group]
                          [--tags]

Voorbeelden

Maak een exemplaar met minimale configuratie.

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id}

Maak een exemplaar waarvoor diagnostische gegevens zijn ingeschakeld, gekoppeld aan een door de gebruiker opgegeven opslagaccount. Labels opnemen.

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id} --enable-diagnostics --diagnostics-storage-id {storage_account_resource_id} --tags a=b

Vereiste parameters

--account -n

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments
--instance -i

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments
--iothub-ids

Door ruimte gescheiden IoT Hub-resource-id's.

Eigenschap Waarde
Parametergroep: IoT Hub Arguments

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--diagnostics-storage-id

De gebruiker heeft de resource-id van het opslagaccount opgegeven voor gebruik in de verzameling diagnostische logboeken.

Eigenschap Waarde
Parametergroep: Storage Arguments
--enable-diagnostics

Hiermee schakelt u verzameling diagnostische logboeken in.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Default value: False
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments
--tags

Resourcetags. Eigenschapsverzameling in sleutel-waardeparen met de volgende indeling: a=b c=d.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot du instance delete

Een device update-exemplaar verwijderen.

az iot du instance delete --account
                          --instance
                          [--no-wait]
                          [--resource-group]
                          [--yes {false, true}]

Voorbeelden

Verwijder een exemplaar dat is gekoppeld aan het doelaccount.

az iot du instance delete -n {account_name} -i {instance_name}

Verwijder een exemplaar dat is gekoppeld aan het doelaccount en sla de bevestigingsprompt over.

az iot du instance delete -n {account_name} -i {instance_name} -y

Vereiste parameters

--account -n

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments
--instance -i

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Default value: False
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments
--yes -y

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

Eigenschap Waarde
Geaccepteerde waarden: false, true
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot du instance list

Geef exemplaren van Device Update weer.

az iot du instance list --account
                        [--resource-group]

Voorbeelden

Geef exemplaren weer die zijn gekoppeld aan het doelaccount.

az iot du instance list -n {account_name}

Vereiste parameters

--account -n

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--resource-group -g

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot du instance show

Een device update-exemplaar weergeven.

az iot du instance show --account
                        --instance
                        [--resource-group]

Voorbeelden

Geef de details weer van een exemplaar dat is gekoppeld aan het doelaccount.

az iot du instance show -n {account_name} -i {instance_name}

Vereiste parameters

--account -n

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments
--instance -i

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--resource-group -g

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot du instance update

Een device update-exemplaar bijwerken.

Momenteel kunnen de volgende exemplaareigenschappen worden bijgewerkt: iotHubs, enableDiagnostics, diagnosticStorageProperties en tags.

az iot du instance update --account
                          --instance
                          [--add]
                          [--force-string]
                          [--no-wait]
                          [--remove]
                          [--resource-group]
                          [--set]

Voorbeelden

Stel een specifiek kenmerk voor exemplaartags in.

az iot du instance update -n {account_name} -i {instance_name} --set tags.env='test'

Schakel diagnostische gegevens in en configureer een opslagaccount voor logboekverzameling.

az iot du instance update -n {account_name} -i {instance_name} --set enableDiagnostics=true diagnosticStorageProperties.resourceId={storage_account_resource_id}

Vereiste parameters

--account -n

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments
--instance -i

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string or JSON string>.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: False
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Default value: False
--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments
--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot du instance wait

Blokkeren totdat aan de resourcestatus van een gewenst exemplaar is voldaan.

az iot du instance wait --account
                        --instance
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--resource-group]
                        [--timeout]
                        [--updated]

Voorbeelden

Blokkeren totdat het doelexemplaren zijn verwijderd.

az iot du instance wait -n {account_name} -i {instance_name} --deleted

Vereiste parameters

--account -n

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments
--instance -i

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--created

Wacht totdat u 'provisioningState' hebt gemaakt bij 'Succeeded'.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
--custom

Wacht tot de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
--deleted

Wacht totdat deze is verwijderd.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
--exists

Wacht tot de resource bestaat.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
--interval

Polling-interval in seconden.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: 30
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Account Identifier Arguments
--timeout

Maximale wachttijd in seconden.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: 3600
--updated

Wacht totdat deze is bijgewerkt met provisioningState op 'Succeeded'.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False