az iot du device class

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). Tillägget installeras automatiskt första gången du kör ett kommandot az iot du device class. Learn more about extensions.

Undergruppshantering för enhetsklass och enhetsklass.

En enhetsklass beskriver en uppsättning enheter som delar en gemensam uppsättning attribut mellan grupper medan en undergrupp för enhetsklass är en delmängd av enheter i en grupp som delar samma enhetsklass-ID. Enhetsklasser skapas automatiskt när Enheter som är aktiverade för enhetsuppdatering är anslutna till hubben.

Kommandon

Name	Description	Typ	Status
az iot du device class delete	Ta bort en undergrupp för enhetsklass eller enhetsklass.	Extension	GA
az iot du device class list	Visa en lista över enhetsklasser eller undergrupper för enhetsklasser.	Extension	GA
az iot du device class show	Visa information om en undergrupp för enhetsklass eller enhetsklass, inklusive installationsbara uppdateringar, bästa uppdaterings- och uppdateringsefterlevnad.	Extension	GA
az iot du device class update	Uppdatera en enhetsklass.	Extension	GA

az iot du device class delete

Ta bort en undergrupp för enhetsklass eller enhetsklass.

Enhetsklasser skapas automatiskt när Enheter med enhetsuppdatering är anslutna till hubben, men rensas inte automatiskt eftersom de refereras till av undergrupper för enhetsklass. Om alla enhetsklassundergrupper för en målenhetsklass tas bort kan även själva enhetsklassen tas bort för att ta bort posterna från systemet och för att sluta kontrollera enhetsklassens kompatibilitet med nya uppdateringar. Om en enhet någonsin återansluts skapas enhetsklassen igen om den inte finns.

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

Exempel

Ta bort en enhetsklass.

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

Ta bort en enhetsklass och hoppa över bekräftelseprompten.

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

Ta bort en undergrupp för enhetsklass.

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

Obligatoriska parametrar

--account -n

Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med hjälp av az config set defaults.adu_account={name}.

Egenskap	Värde
Parameter group:	Account Identifier Arguments

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

--instance -i

Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med hjälp av az config set defaults.adu_instance={name}.

Egenskap	Värde
Parameter group:	Account Identifier Arguments

Valfria parametrar

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

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

--resource-group -g

Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med hjälp av az config set defaults.adu_group={name}.

Egenskap	Värde
Parameter group:	Account Identifier Arguments

--yes -y

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

Egenskap	Värde
Godkända värden:	false, true

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

Output format.

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

Visa en lista över enhetsklasser eller undergrupper för enhetsklasser.

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

Exempel

Lista enhetsklasser i en instans.

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

Lista enhetsklasser för instanser filtrerade efter eget namn.

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

Lista undergrupper för enhetsklass för gruppen.

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

Lista undergrupper för enhetsklass för gruppen, filtrerade efter kompatibilitet/tillverkare.

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

Obligatoriska parametrar

--account -n

Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med hjälp av az config set defaults.adu_account={name}.

Egenskap	Värde
Parameter group:	Account Identifier Arguments

--instance -i

Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med hjälp av az config set defaults.adu_instance={name}.

Egenskap	Värde
Parameter group:	Account Identifier Arguments

Valfria parametrar

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

--filter

Om det tillhandahålls med --group-id, stöder filtrering baserat på enhetsklassens kompatibilitetsegenskapsnamn och värden. Till exempel "compatProperties/manufacturer eq 'Contoso'". Annars har stöd för filtrering efter klassvänligt namn.

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

--resource-group -g

Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med hjälp av az config set defaults.adu_group={name}.

Egenskap	Värde
Parameter group:	Account Identifier Arguments

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

Output format.

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

Visa information om en undergrupp för enhetsklass eller enhetsklass, inklusive installationsbara uppdateringar, bästa uppdaterings- och uppdateringsefterlevnad.

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

Exempel

Visa en enhetsklass.

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

Visa installationsbara uppdateringar för enhetsklassen. Den här flaggan ändrar kommandot till att returnera en lista.

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

Visa en undergrupp för enhetsklass.

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

Visa den bästa tillgängliga uppdateringen för en undergrupp för enhetsklass.

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

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

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

Obligatoriska parametrar

--account -n

Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med hjälp av az config set defaults.adu_account={name}.

Egenskap	Värde
Parameter group:	Account Identifier Arguments

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

--instance -i

Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med hjälp av az config set defaults.adu_instance={name}.

Egenskap	Värde
Parameter group:	Account Identifier Arguments

Valfria parametrar

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

--best-update

Flagga som anger att kommandot ska hämta den bästa tillgängliga uppdateringen för undergruppen enhetsklass, inklusive antalet enheter som behöver uppdateringen. Grupp-ID krävs för den här flaggan. En bästa uppdatering är den senaste uppdateringen som uppfyller alla kompatibilitetsspecifikationer för en enhetsklass.

Egenskap	Värde
Parameter group:	Update Arguments
Godkända värden:	false, true

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

--installable-updates

Flagga som anger att kommandot ska hämta installationsbara uppdateringar för enhetsklassen.

Egenskap	Värde
Parameter group:	Update Arguments
Godkända värden:	false, true

--resource-group -g

Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med hjälp av az config set defaults.adu_group={name}.

Egenskap	Värde
Parameter group:	Account Identifier Arguments

--update-compliance

Flagga som anger att kommandot ska hämta information om uppdateringsefterlevnad för enhetsklass, till exempel hur många enheter som har den senaste uppdateringen, hur många som behöver nya uppdateringar och hur många som pågår när en ny uppdatering tas emot. Grupp-ID krävs för den här flaggan.

Egenskap	Värde
Parameter group:	Update Arguments
Godkända värden:	false, true

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

Output format.

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

Uppdatera en enhetsklass.

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

Exempel

Uppdatera det egna namnet på enhetsklassen.

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

Obligatoriska parametrar

--account -n

Namn på enhetsuppdateringskonto. Du kan konfigurera standardkontonamnet med hjälp av az config set defaults.adu_account={name}.

Egenskap	Värde
Parameter group:	Account Identifier Arguments

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

--instance -i

Namnet på enhetsuppdateringsinstansen. Du kan konfigurera standardinstansnamnet med hjälp av az config set defaults.adu_instance={name}.

Egenskap	Värde
Parameter group:	Account Identifier Arguments

Valfria parametrar

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

--friendly-name

Det egna namnet på enhetsklassen. Det egna namnet måste vara mellan 1 och 100 tecken och har stöd för alfanumeriska värden, punkt- och streckvärden.

--resource-group -g

Namn på resursgrupp för enhetsuppdateringskonto. Du kan konfigurera standardgruppen med hjälp av az config set defaults.adu_group={name}.

Egenskap	Värde
Parameter group:	Account Identifier Arguments

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

Output format.

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