az iot hub state

Notitie

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.46.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az iot hub state command uitvoert. Meer informatie over extensies.

Deze opdrachtgroep is experimenteel en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

De status van een IoT Hub beheren.

Zie aka.ms/aziotcli-iot-hub-state voor meer informatie.

Opdracht

Name	Description	Type	Status
az iot hub state export	Exporteer de status van een IoT Hub naar een bestand.	Toestel	Experimenteel
az iot hub state import	Importeer een hubstatus van een bestand naar een IoT Hub.	Toestel	Experimenteel
az iot hub state migrate	Migreer de status van de ene hub naar een andere hub zonder op te slaan in een bestand.	Toestel	Experimenteel

az iot hub state export

Experimenteel

Opdrachtgroep 'iot-hubstatus' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Exporteer de status van een IoT Hub naar een bestand.

Standaard bevat de geëxporteerde status: arm-sjabloon voor hub- en hubconfiguraties (inclusief ADM-configuraties en edge-implementaties), apparaatgegevens (inclusief apparaatidentites, apparaatdubbels, module-id's en moduledubbels).

Zie aka.ms/aziotcli-iot-hub-state voor meer informatie.

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

Voorbeelden

Exporteer de ondersteunde status van de opgegeven hub naar het opgegeven bestand.

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

Exporteer de ondersteunde status van de opgegeven hub naar het opgegeven bestand en overschrijft de bestandsinhoud.

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

Exporteer alleen de apparaten en configuraties van de opgegeven hub naar het opgegeven bestand.

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

Vereiste parameters

--state-file -f

Het pad naar het bestand waarin de statusgegevens worden opgeslagen.

Optionele parameters

--aspects

Hubaspecten (door spaties gescheiden).

Geaccepteerde waarden: arm, configurations, devices

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login

Default value: key

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--replace -r

Als deze vlag is ingesteld, overschrijft de opdracht de inhoud van het uitvoerbestand.

Default value: False

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults 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

Default value: 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 hub state import

Experimenteel

Opdrachtgroep 'iot-hubstatus' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Importeer een hubstatus van een bestand naar een IoT Hub.

Als het arm-aspect is opgegeven, wordt de hub gemaakt als deze niet bestaat.

Standaard bevat de geïmporteerde status: arm-sjabloon voor hub- en hubconfiguraties (inclusief ADM-configuraties en edge-implementaties), apparaatgegevens (inclusief apparaatidentites, apparaatdubbels, module-id's en moduledubbels).

Voor geïmporteerde eindpunten met door het systeem toegewezen identiteitsverificatie moet de opgegeven hub over de juiste machtigingen beschikken. Anders mislukt de opdracht.

Privé-eindpunten worden genegeerd in het importproces.

Zie aka.ms/aziotcli-iot-hub-state voor meer informatie.

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

Voorbeelden

Importeer de ondersteunde status uit het opgegeven bestand naar de opgegeven hub.

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

Importeer de ondersteunde status van het opgegeven bestand naar de opgegeven hub en overschrijft de vorige status van de hub. Alle certificaten, configuraties en apparaten worden verwijderd voordat de nieuwe status wordt geüpload.

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

Importeer alleen de arm-sjabloon uit het opgegeven bestand naar de opgegeven hub. Houd er rekening mee dat hiermee een nieuwe hub wordt gemaakt als deze niet bestaat. Het bestand kan de apparaten en configuraties bevatten, maar deze worden genegeerd.

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

Importeer alleen de apparaten en configuraties uit het opgegeven bestand naar de opgegeven hub. Houd er rekening mee dat er geen nieuwe hub wordt gemaakt als deze niet bestaat en de opdracht mislukt. Het bestand kan de arm-sjabloon bevatten, maar dat wordt genegeerd.

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

Vereiste parameters

--state-file -f

Het pad naar het bestand waarin de statusgegevens worden opgeslagen.

Optionele parameters

--aspects

Hubaspecten (door spaties gescheiden).

Geaccepteerde waarden: arm, configurations, devices

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login

Default value: key

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--replace -r

Als deze vlag is ingesteld, verwijdert de opdracht de huidige apparaten, configuraties en certificaten van de doelhub.

Default value: False

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults 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

Default value: 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 hub state migrate

Experimenteel

Opdrachtgroep 'iot-hubstatus' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Migreer de status van de ene hub naar een andere hub zonder op te slaan in een bestand.

Als het arm-aspect is opgegeven, wordt de hub gemaakt als deze niet bestaat.

Standaard bevat de gemigreerde status: arm-sjabloon voor hub, hubconfiguraties (inclusief ADM-configuraties en edge-implementaties), apparaatgegevens (inclusief apparaatidentites, apparaatdubbels, module-id's en moduledubbels).

Voor gemigreerde eindpunten met door het systeem toegewezen identiteitsverificatie moet de opgegeven hub over de juiste machtigingen beschikken. Anders mislukt de opdracht.

Privé-eindpunten worden genegeerd in het migratieproces.

Als u problemen ondervindt bij het migreren, gebruikt u de opdrachten voor exporteren en importeren om een bestand als back-up te maken.

Zie aka.ms/aziotcli-iot-hub-state voor meer informatie.

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

Voorbeelden

Migreer de ondersteunde status van de oorspronkelijke hub naar de doelhub.

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

Migreer de ondersteunde status van de oorspronkelijke hub naar de doelhub, en overschrijft de vorige status van de hub. Alle certificaten, configuraties en apparaten in de doelhub worden verwijderd voordat de nieuwe status wordt geüpload.

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

Migreer alleen de arm-sjabloon van de oorspronkelijke hub naar de doelhub. Houd er rekening mee dat hiermee een nieuwe hub wordt gemaakt als de doelhub niet bestaat. De origin-hub kan de apparaten en configuraties bevatten, maar deze worden genegeerd.

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

Migreer alleen de apparaten en configuraties van de oorspronkelijke hub naar de doelhub. Houd er rekening mee dat hiermee GEEN nieuwe hub wordt gemaakt als de doelhub niet bestaat en de opdracht mislukt. De arm-sjabloon voor de oorspronkelijke hub wordt genegeerd.

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

Optionele parameters

--aspects

Hubaspecten (door spaties gescheiden).

Geaccepteerde waarden: arm, configurations, devices

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login

Default value: key

--destination-hub --dh

Naam van IoT Hub waarnaar de status van de oorspronkelijke hub wordt gekopieerd.

--destination-hub-login --dl

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren op de doelhub. Gebruik dit om sessieaanmelding via az login dit IoT Hub-exemplaar te voorkomen. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --destination-hub niet is opgegeven.

--destination-resource-group --dg

Naam van de resourcegroep van de IoT Hub waarnaar de status van de oorspronkelijke hub wordt gekopieerd. Als dit niet is opgegeven, wordt de resourcegroep van de ioT Hub van oorsprong gebruikt.

--og --origin-resource-group

De naam van de resourcegroep van de IoT Hub die wordt gekopieerd.

--oh --origin-hub

Naam van IoT Hub die wordt gekopieerd.

--ol --origin-hub-login

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren op de origin-hub. Gebruik dit om sessieaanmelding via az login dit IoT Hub-exemplaar te voorkomen. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --origin-hub niet is opgegeven.

--replace -r

Als deze vlag is ingesteld, verwijdert de opdracht de huidige apparaten, configuraties en certificaten van de doelhub.

Default value: False

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

Default value: 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.