az iot hub state

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 state. Přečtěte si další informace o rozšířeních.

Tato skupina příkazů je experimentální a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Umožňuje spravovat stav IoT Hub.

Další informace najdete v tématu aka.ms/aziotcli-iot-hub-state.

Příkazy

Name	Description	Typ	Stav
az iot hub state export	Export stavu IoT Hub do souboru	Extension	Experimental
az iot hub state import	Importujte stav centra ze souboru do IoT Hub.	Extension	Experimental
az iot hub state migrate	Migrujte stav jednoho centra do jiného centra bez uložení do souboru.	Extension	Experimental

az iot hub state export

Experimentální

Skupina příkazů iot Hub state je experimentální a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Export stavu IoT Hub do souboru

Ve výchozím nastavení bude exportovaný stav zahrnovat: šablonu arm pro centrum, konfigurace centra (včetně konfigurací ADM a nasazení hraničních zařízení), informace o zařízení (včetně identit zařízení, dvojčat zařízení, identit modulů a dvojčat modulů).

Další informace najdete v tématu aka.ms/aziotcli-iot-hub-state.

az iot hub state export --state-file
                        [--acquire-policy-token]
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--change-reference]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Příklady

Exportujte podporovaný stav zadaného centra do zadaného souboru.

az iot hub state export -n {iothub_name} -f {state_filename}

Exportujte podporovaný stav zadaného centra do zadaného souboru a přepíšete obsah souboru.

az iot hub state export -n {iothub_name} -f {state_filename} -r

Exportujte pouze zařízení a konfigurace zadaného centra do zadaného souboru.

az iot hub state export -n {iothub_name} -f {state_filename} --aspects devices configurations

Povinné parametry

--state-file -f

Cesta k souboru, kde budou uloženy informace o stavu.

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

--aspects

Aspekty centra (oddělené mezerami)

Vlastnost	Hodnota
Přípustné hodnoty:	arm, configurations, devices

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

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

--replace -r

Pokud je tento příznak nastavený, příkaz přepíše obsah výstupního souboru.

Vlastnost	Hodnota
Default value:	False

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

Experimentální

Skupina příkazů iot Hub state je experimentální a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Importujte stav centra ze souboru do IoT Hub.

Pokud je zadaný aspekt arm, centrum se vytvoří, pokud neexistuje.

Ve výchozím nastavení bude importovaný stav zahrnovat: šablonu arm pro centrum, konfigurace centra (včetně konfigurací ADM a nasazení hraničních zařízení), informace o zařízení (včetně identit zařízení, dvojčat zařízení, identit modulů a dvojčat modulů).

Pro importované koncové body s ověřováním identit přiřazeným systémem musí mít zadané centrum správná oprávnění. Jinak příkaz selže.

Privátní koncové body budou v procesu importu ignorovány.

Další informace najdete v tématu aka.ms/aziotcli-iot-hub-state.

az iot hub state import --state-file
                        [--acquire-policy-token]
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--change-reference]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Příklady

Importujte podporovaný stav ze zadaného souboru do zadaného centra.

az iot hub state import -n {iothub_name} -f {state_filename}

Importuje podporovaný stav ze zadaného souboru do zadaného centra a přepíše předchozí stav centra. Před nahráním nového stavu se odstraní všechny certifikáty, konfigurace a zařízení.

az iot hub state import -n {iothub_name} -f {state_filename} -r

Importuje pouze šablonu arm ze zadaného souboru do zadaného centra. Upozorňujeme, že pokud neexistuje, vytvoří se nové centrum. Soubor může obsahovat zařízení a konfigurace, ale ty budou ignorovány.

az iot hub state import -n {iothub_name} -g {resource_group} -f {state_filename} --aspects arm

Importujte pouze zařízení a konfigurace ze zadaného souboru do zadaného centra. Všimněte si, že pokud neexistuje, nevytvoří se nové centrum a příkaz se nezdaří. Soubor může obsahovat šablonu arm, ale bude ignorován.

az iot hub state import -n {iothub_name} -f {state_filename} --aspects devices configurations

Povinné parametry

--state-file -f

Cesta k souboru, kde budou uloženy informace o stavu.

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

--aspects

Aspekty centra (oddělené mezerami)

Vlastnost	Hodnota
Přípustné hodnoty:	arm, configurations, devices

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

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

--replace -r

Pokud je tento příznak nastavený, příkaz odstraní aktuální zařízení, konfigurace a certifikáty cílového centra.

Vlastnost	Hodnota
Default value:	False

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

Experimentální

Skupina příkazů iot Hub state je experimentální a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Migrujte stav jednoho centra do jiného centra bez uložení do souboru.

Pokud je zadaný aspekt arm, centrum se vytvoří, pokud neexistuje.

Ve výchozím nastavení bude migrovaný stav zahrnovat: šablonu arm pro centrum, konfigurace centra (včetně konfigurací ADM a nasazení hraničních zařízení), informace o zařízení (včetně identit zařízení, dvojčat zařízení, identit modulů a dvojčat modulů).

U migrovaných koncových bodů s ověřováním identit přiřazeným systémem musí mít zadané centrum správná oprávnění. Jinak příkaz selže.

Privátní koncové body budou v procesu migrace ignorovány.

Pokud máte potíže s migrací, použijte příkazy pro export a import, abyste měli soubor jako zálohu.

Další informace najdete v tématu aka.ms/aziotcli-iot-hub-state.

az iot hub state migrate [--acquire-policy-token]
                         [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--change-reference]
                         [--destination-hub --dh]
                         [--destination-hub-login --dl]
                         [--destination-resource-group --dg]
                         [--og --origin-resource-group]
                         [--oh --origin-hub]
                         [--ol --origin-hub-login]
                         [--replace]

Příklady

Migrujte podporovaný stav původního centra do cílového centra.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name}

Migrujte podporovaný stav původního centra do cílového centra a přepíšete předchozí stav centra. Všechny certifikáty, konfigurace a zařízení v cílovém centru se odstraní před nahráním nového stavu.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} -r

Migrujte pouze šablonu arm z centra původu do cílového centra. Všimněte si, že pokud cílové centrum neexistuje, vytvoří se nové centrum. Centrum původu může obsahovat zařízení a konfigurace, ale ty budou ignorovány.

az iot hub state migrate --destination-hub {dest_hub_name} --destination-resource-group {dest_hub_resource_group} --origin-hub {orig_hub_name} --aspects arm

Migrujte pouze zařízení a konfigurace z centra původu do cílového centra. Všimněte si, že pokud cílové centrum neexistuje, nebude se tím vytvářet nové centrum a příkaz se nezdaří. Šablona arm pro centrum původu bude ignorována.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} --aspects devices configurations

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

--aspects

Aspekty centra (oddělené mezerami)

Vlastnost	Hodnota
Přípustné hodnoty:	arm, configurations, devices

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

--destination-hub --dh

Název IoT Hub, do kterého se zkopíruje stav původního centra.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--destination-hub-login --dl

Tento příkaz podporuje entitu connection string s právy k provedení akce v cílovém centru. Slouží k zabránění přihlášení k relaci prostřednictvím az login pro tuto instanci IoT Hub. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není zadaný --destination-hub.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--destination-resource-group --dg

Název skupiny prostředků IoT Hub, do které se zkopíruje stav původního centra. Pokud není k dispozici, použije zdrojovou skupinu prostředků IoT Hub.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--og --origin-resource-group

Název skupiny prostředků IoT Hub, která se zkopíruje.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--oh --origin-hub

Název IoT Hub, který se zkopíruje.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--ol --origin-hub-login

Tento příkaz podporuje entitu connection string s právy k provedení akce v centru původu. Slouží k zabránění přihlášení k relaci prostřednictvím az login pro tuto instanci IoT Hub. Pokud je connection string i název entity zadané connection string prioritu. Vyžaduje se, pokud není k dispozici --origin-hub.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--replace -r

Pokud je tento příznak nastavený, příkaz odstraní aktuální zařízení, konfigurace a certifikáty cílového centra.

Vlastnost	Hodnota
Default value:	False

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