Dela via

az iot hub state

  • Experimentell

Note

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.59.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot hub state kommando. Läs mer om tillägg.

Den här kommandogruppen är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hantera tillståndet för en IoT Hub.

Mer information finns i aka.ms/aziotcli-iot-hub-state.

Kommandon

Name Description Typ Status
az iot hub state export

Exportera tillståndet för en IoT Hub till en fil.

 Extension Experimental
az iot hub state import

Importera ett hubbtillstånd från en fil till en IoT Hub.

 Extension Experimental
az iot hub state migrate

Migrera tillståndet för en hubb till en annan hubb utan att spara till en fil.

 Extension Experimental

az iot hub state export

Experimentell

Kommandogruppen "iot hub state" är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Exportera tillståndet för en IoT Hub till en fil.

Som standard omfattar det exporterade tillståndet: armmall för hubb, hubbkonfigurationer (inklusive ADM-konfigurationer och gränsdistributioner), enhetsinformation (inklusive enhetsidentiteter, enhetstvillingar, modulidentiteter och modultvillingar).

Mer information finns i aka.ms/aziotcli-iot-hub-state.

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

Exempel

Exportera tillståndet som stöds för den angivna hubben till den angivna filen.

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

Exportera tillståndet som stöds för den angivna hubben till den angivna filen och skriv över filinnehållet.

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

Exportera endast enheterna och konfigurationerna för den angivna hubben till den angivna filen.

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

Obligatoriska parametrar

--state-file -f

Sökvägen till filen där tillståndsinformationen ska lagras.

Valfria parametrar

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

--aspects

Hubbaspekter (utrymmesavgränsade).

Egenskap Värde
Godkända värden: arm, configurations, devices
--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type={auth-type-value}

Egenskap Värde
Parameter group: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--replace -r

Om den här flaggan anges skriver kommandot över innehållet i utdatafilen.

Egenskap Värde
Standardvärde: False
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

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

Utdataformat.

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

Experimentell

Kommandogruppen "iot hub state" är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Importera ett hubbtillstånd från en fil till en IoT Hub.

Om armaspekten anges skapas hubben om den inte finns.

Som standard innehåller det importerade tillståndet: armmall för hubb, hubbkonfigurationer (inklusive ADM-konfigurationer och gränsdistributioner), enhetsinformation (inklusive enhetsidentiteter, enhetstvillingar, modulidentiteter och modultvillingar).

För importerade slutpunkter med systemtilldelad identitetsautentisering måste den angivna hubben ha rätt behörigheter. Annars misslyckas kommandot.

Privata slutpunkter ignoreras i importprocessen.

Mer information finns i aka.ms/aziotcli-iot-hub-state.

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

Exempel

Importera tillståndet som stöds från den angivna filen till den angivna hubben.

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

Importera tillståndet som stöds från den angivna filen till den angivna hubben och skriv över hubbens tidigare tillstånd. Alla certifikat, konfigurationer och enheter tas bort innan det nya tillståndet laddas upp.

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

Importera endast armmallen från den angivna filen till den angivna hubben. Observera att detta skapar en ny hubb om den inte finns. Filen kan innehålla enheter och konfigurationer, men de ignoreras.

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

Importera endast enheterna och konfigurationerna från den angivna filen till den angivna hubben. Observera att detta INTE skapar en ny hubb om den inte finns och kommandot misslyckas. Filen kan innehålla armmallen, men den ignoreras.

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

Obligatoriska parametrar

--state-file -f

Sökvägen till filen där tillståndsinformationen ska lagras.

Valfria parametrar

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

--aspects

Hubbaspekter (utrymmesavgränsade).

Egenskap Värde
Godkända värden: arm, configurations, devices
--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type={auth-type-value}

Egenskap Värde
Parameter group: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--replace -r

Om den här flaggan anges tar kommandot bort de aktuella enheterna, konfigurationerna och certifikaten för målhubben.

Egenskap Värde
Standardvärde: False
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

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

Utdataformat.

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

Experimentell

Kommandogruppen "iot hub state" är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Migrera tillståndet för en hubb till en annan hubb utan att spara till en fil.

Om armaspekten anges skapas hubben om den inte finns.

Som standard omfattar det migrerade tillståndet: armmall för hubb, hubbkonfigurationer (inklusive ADM-konfigurationer och gränsdistributioner), enhetsinformation (inklusive enhetsidentiteter, enhetstvillingar, modulidentiteter och modultvillingar).

För migrerade slutpunkter med systemtilldelad identitetsautentisering måste den angivna hubben ha rätt behörigheter. Annars misslyckas kommandot.

Privata slutpunkter ignoreras i migreringsprocessen.

Om du har problem med att migrera använder du export- och importkommandona för att ha en fil som en säkerhetskopia.

Mer information finns i aka.ms/aziotcli-iot-hub-state.

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

Exempel

Migrera ursprungshubbens tillstånd som stöds till målhubben.

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

Migrera ursprungshubbens tillstånd som stöds till målhubben och skriv över hubbens tidigare tillstånd. Alla certifikat, konfigurationer och enheter i målhubben tas bort innan det nya tillståndet laddas upp.

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

Migrera endast armmallen från ursprungshubben till målhubben. Observera att detta skapar en ny hubb om målhubben inte finns. Ursprungshubben kan innehålla enheter och konfigurationer, men de ignoreras.

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

Migrera endast enheterna och konfigurationerna från ursprungshubben till målhubben. Observera att detta INTE skapar en ny hubb om målhubben inte finns och kommandot misslyckas. Armmallen för ursprungshubben ignoreras.

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

Valfria parametrar

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

--aspects

Hubbaspekter (utrymmesavgränsade).

Egenskap Värde
Godkända värden: arm, configurations, devices
--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type={auth-type-value}

Egenskap Värde
Parameter group: Access Control Arguments
Standardvärde: key
Godkända värden: key, login
--destination-hub --dh

Namnet på IoT Hub som ursprungshubbens tillstånd ska kopieras till.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--destination-hub-login --dl

Det här kommandot stöder en entitetsanslutningssträng med behörighet att utföra åtgärder på målhubben. Använd för att undvika sessionsinloggning via az login för den här IoT Hub-instansen. Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --destination-hub inte anges.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--destination-resource-group --dg

Namnet på resursgruppen för den IoT Hub som ursprungshubbens tillstånd ska kopieras till. Om det inte anges använder du ursprungs-IoT Hub-resursgruppen.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--og --origin-resource-group

Namnet på resursgruppen för IoT Hub som ska kopieras.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--oh --origin-hub

Namnet på IoT Hub som ska kopieras.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--ol --origin-hub-login

Det här kommandot stöder en entitetsanslutningssträng med behörighet att utföra åtgärder på ursprungshubben. Använd för att undvika sessionsinloggning via az login för den här IoT Hub-instansen. Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --origin-hub inte anges.

Egenskap Värde
Parameter group: IoT Hub Identifier Arguments
--replace -r

Om den här flaggan anges tar kommandot bort de aktuella enheterna, konfigurationerna och certifikaten för målhubben.

Egenskap Värde
Standardvärde: False
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

Utdataformat.

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