az iot du device class

  • Referentie

Notitie

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

Apparaatklasse- en apparaatklassesubgroepbeheer.

Een apparaatklasse beschrijft een set apparaten die een gemeenschappelijke set kenmerken in groepen delen, terwijl een subgroep van een apparaatklasse een subset is van apparaten in een groep die dezelfde apparaatklasse-id delen. Apparaatklassen worden automatisch gemaakt wanneer apparaten met apparaatupdates zijn verbonden met de hub.

Opdracht

Name Description Type Status
az iot du device class delete

Een apparaatklasse of subgroep van apparaatklasse verwijderen.

 Toestel GA
az iot du device class list

Een lijst met apparaatklassen of subgroepen van apparaatklassen weergeven.

 Toestel GA
az iot du device class show

Geef details weer over een apparaatklasse of subgroep van apparaatklassen, waaronder installeerbare updates, de beste update- en updatecompatibiliteit.

 Toestel GA
az iot du device class update

Een apparaatklasse bijwerken.

 Toestel GA

az iot du device class delete

Een apparaatklasse of subgroep van apparaatklasse verwijderen.

Apparaatklassen worden automatisch gemaakt wanneer apparaten met apparaatupdates zijn verbonden met de hub, maar niet automatisch worden opgeschoond omdat er naar apparaatklassesubgroepen wordt verwezen. Als alle subgroepen van apparaatklassen voor een doelapparaatklasse worden verwijderd, kan de apparaatklasse zelf ook worden verwijderd om de records uit het systeem te verwijderen en de compatibiliteit van de apparaatklasse met nieuwe updates te stoppen. Als een apparaat ooit opnieuw verbinding maakt, wordt de apparaatklasse opnieuw gemaakt als het niet bestaat.

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

Voorbeelden

Een apparaatklasse verwijderen.

az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id}

Verwijder een apparaatklasse en sla de bevestigingsprompt over.

az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id} -y

Een subgroep van een apparaatklasse verwijderen.

az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_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.

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

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

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

Een lijst met apparaatklassen of subgroepen van apparaatklassen weergeven.

az iot du device class list --account
                            --instance
                            [--filter]
                            [--gid]
                            [--resource-group]

Voorbeelden

Apparaatklassen binnen een exemplaar weergeven.

az iot du device class list -n {account_name} -i {instance_name}

Apparaatklassen van exemplaren weergeven die zijn gefilterd op beschrijvende naam.

az iot du device class list -n {account_name} -i {instance_name} --filter "friendlyName eq 'my-favorite-class'"

Maak een lijst met subgroepen van apparaatklassen voor de groep.

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

Lijst met subgroepen van apparaatklassen voor de groep, gefilterd op compatProperties/fabrikant.

az iot du device class list -n {account_name} -i {instance_name} --group-id {device_group_id} --filter "compatProperties/manufacturer eq 'Contoso'"

Vereiste parameters

--account -n

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

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

Als deze wordt geleverd met --group-id, ondersteunt het filteren op basis van eigenschapsnamen en -waarden van apparaatklassecompatibiliteit. Bijvoorbeeld 'compatProperties/manufacturer eq 'Contoso'. Anders wordt het filteren op klassevriendelijke naam ondersteund.

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

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

Geef details weer over een apparaatklasse of subgroep van apparaatklassen, waaronder installeerbare updates, de beste update- en updatecompatibiliteit.

az iot du device class show --account
                            --cid
                            --instance
                            [--best-update {false, true}]
                            [--gid]
                            [--installable-updates {false, true}]
                            [--resource-group]
                            [--update-compliance {false, true}]

Voorbeelden

Een apparaatklasse weergeven.

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id}

Installeerbare updates voor de apparaatklasse weergeven. Met deze vlag wordt de opdracht gewijzigd om een lijst te retourneren.

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --installable-updates

Een subgroep voor apparaatklassen weergeven.

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

De beste update weergeven die beschikbaar is voor een subgroep van een apparaatklasse.

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

Updatecompatibiliteit weergeven voor een subgroep van een apparaatklasse.

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

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.

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

--best-update

Vlag die aangeeft dat de opdracht de best beschikbare update moet ophalen voor de subgroep van de apparaatklasse, inclusief het aantal apparaten dat de update nodig heeft. Groeps-id is vereist voor deze vlag. Een beste update is de nieuwste update die voldoet aan alle compatibiliteitsspecificaties van een apparaatklasse.

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

--installable-updates

Vlag die aangeeft dat de opdracht installeerbare updates voor de apparaatklasse moet ophalen.

geaccepteerde waarden: false, true
--resource-group -g

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

--update-compliance

Vlag die aangeeft dat de opdracht nalevingsinformatie voor apparaatklasse-subgroepen moet ophalen, zoals het aantal apparaten op de meest recente update, hoeveel nieuwe updates nodig zijn en hoeveel er worden uitgevoerd bij het ontvangen van een nieuwe update. Groeps-id is vereist voor deze vlag.

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

Een apparaatklasse bijwerken.

az iot du device class update --account
                              --cid
                              --instance
                              [--friendly-name]
                              [--resource-group]

Voorbeelden

Werk de beschrijvende naam van de apparaatklasse bij.

az iot du device class update -n {account_name} -i {instance_name} --class-id {device_class_id} --friendly-name "EU-region"

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.

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

--friendly-name

De beschrijvende naam van de apparaatklasse. De beschrijvende naam moet 1 tot 100 tekens zijn en ondersteunt alfanumerieke, punt- en streepjeswaarden.

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