az iot hub device-twin

Note

Tento odkaz je součástí rozšíření azure-iot pro Azure CLI (verze 2.67.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az iot hub device-twin. Přečtěte si další informace o rozšířeních.

Správa konfigurace dvojčete zařízení IoT

Příkazy

Name	Description	Typ	Stav
az iot hub device-twin list	Zobrazení seznamu dvojčat zařízení v IoT Hub	Extension	GA
az iot hub device-twin replace	Nahraďte definici dvojčete zařízení cílovým kódem JSON.	Extension	GA
az iot hub device-twin show	Získejte definici dvojčete zařízení.	Extension	GA
az iot hub device-twin update	Aktualizujte požadované vlastnosti a značky dvojčete zařízení.	Extension	GA

az iot hub device-twin list

Zobrazení seznamu dvojčat zařízení v IoT Hub

Tento příkaz je stejný jako dotaz iot Hubu s dotazem "select * from devices" pro všechna zařízení a "select * from devices where capabilities.iotEdge = true" pro hraniční zařízení. Slouží az iot hub query k výkonnějším dotazům na zařízeních.

az iot hub device-twin list [--auth-type {key, login}]
                            [--edge-enabled --ee {false, true}]
                            [--hub-name]
                            [--login]
                            [--resource-group]
                            [--top]

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type={auth-type-value}.

Vlastnost	Hodnota
Skupina parametrů:	Access Control Arguments
Default value:	key
Přípustné hodnoty:	key, login

--edge-enabled --ee

Příznak označující povolení hraničních zařízení

Vlastnost	Hodnota
Default value:	False
Přípustné hodnoty:	false, true

--hub-name -n

IoT Hub název nebo název hostitele. Vyžaduje se, pokud není zadané --login.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--login -l

Tento příkaz podporuje entitu connection string s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--top

Maximální počet prvků, které se mají vrátit. Použijte -1 pro neomezenou dobu.

Vlastnost	Hodnota
Default value:	1000

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost	Hodnota
Default value:	False

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost	Hodnota
Default value:	False

az iot hub device-twin replace

Nahraďte definici dvojčete zařízení cílovým kódem JSON.

Vstup json přímo nebo použijte cestu k souboru.

az iot hub device-twin replace --device-id
                               --json
                               [--acquire-policy-token]
                               [--auth-type {key, login}]
                               [--change-reference]
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Příklady

Nahraďte dvojče zařízení obsahem souboru.

az iot hub device-twin replace -d {device_id} -n {iothub_name} -j ../mydevicetwin.json

Povinné parametry

--device-id -d

ID cílového zařízení.

--json -j

Json pro nahrazení existujícího dvojčete. Zadejte cestu k souboru nebo nezpracovaný kód JSON.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost	Hodnota
Skupina parametrů:	Global Policy Arguments

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type={auth-type-value}.

Vlastnost	Hodnota
Skupina parametrů:	Access Control Arguments
Default value:	key
Přípustné hodnoty:	key, login

--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost	Hodnota
Skupina parametrů:	Global Policy Arguments

--etag -e

Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.

--hub-name -n

IoT Hub název nebo název hostitele. Vyžaduje se, pokud není zadané --login.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--login -l

Tento příkaz podporuje entitu connection string s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost	Hodnota
Default value:	False

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost	Hodnota
Default value:	False

az iot hub device-twin show

Získejte definici dvojčete zařízení.

az iot hub device-twin show --device-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type={auth-type-value}.

Vlastnost	Hodnota
Skupina parametrů:	Access Control Arguments
Default value:	key
Přípustné hodnoty:	key, login

--hub-name -n

IoT Hub název nebo název hostitele. Vyžaduje se, pokud není zadané --login.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--login -l

Tento příkaz podporuje entitu connection string s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost	Hodnota
Default value:	False

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost	Hodnota
Default value:	False

az iot hub device-twin update

Aktualizujte požadované vlastnosti a značky dvojčete zařízení.

Zadejte argumenty --desired nebo --tags pro chování funkce PATCH. Oba parametry podporují vložený json nebo cestu k souboru k obsahu JSON. Použití obecných aktualizačních args (tj. --set) bude odrážet chování PUT a je zastaralé.

az iot hub device-twin update --device-id
                              [--acquire-policy-token]
                              [--add]
                              [--auth-type {key, login}]
                              [--change-reference]
                              [--desired]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--tags]

Příklady

Opravte požadované vlastnosti dvojčete zařízení.

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'

Opravte značky dvojčat zařízení.

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags '{"country": "USA"}'

Opravte značky dvojčete zařízení s obsahem souboru JSON.

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags /path/to/file

Odebrání opravy požadované vlastnosti z nadřazené hodnoty temperature

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"condition":{"temperature":{"critical": null}}}'

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost	Hodnota
Skupina parametrů:	Global Policy Arguments

--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments
Default value:	[]

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type={auth-type-value}.

Vlastnost	Hodnota
Skupina parametrů:	Access Control Arguments
Default value:	key
Přípustné hodnoty:	key, login

--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost	Hodnota
Skupina parametrů:	Global Policy Arguments

--desired

Požadované vlastnosti dvojčete.

Vlastnost	Hodnota
Skupina parametrů:	Twin Patch Arguments

--etag -e

Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.

--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments
Default value:	False

--hub-name -n

IoT Hub název nebo název hostitele. Vyžaduje se, pokud není zadané --login.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--login -l

Tento příkaz podporuje entitu connection string s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments
Default value:	[]

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments
Default value:	[]

--tags

Značky dvojčat.

Vlastnost	Hodnota
Skupina parametrů:	Twin Patch Arguments

Globální parametry

--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost	Hodnota
Default value:	False

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost	Hodnota
Default value:	False