Freigeben über

az iot hub state

  • Experimentell

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). Die Erweiterung wird automatisch installiert, wenn Sie einen az iot hub state Befehl ausführen. Learn more about extensions.

Diese Befehlsgruppe ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Verwalten Sie den Status eines IoT-Hubs.

Weitere Informationen finden Sie unter aka.ms/aziotcli-iot-hub-state.

Befehle

Name Beschreibung Typ Status
az iot hub state export

Exportieren Sie den Status eines IoT Hub in eine Datei.

 Extension Experimental
az iot hub state import

Importieren Sie einen Hubstatus aus einer Datei in einen IoT Hub.

 Extension Experimental
az iot hub state migrate

Migrieren Sie den Status eines Hubs zu einem anderen Hub, ohne in einer Datei zu speichern.

 Extension Experimental

az iot hub state export

Experimentell

Die Befehlsgruppe "iot hub state" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Exportieren Sie den Status eines IoT Hub in eine Datei.

Standardmäßig enthält der exportierte Zustand: Arm-Vorlage für Hub-, Hubkonfigurationen (einschließlich ADM-Konfigurationen und Edgebereitstellungen), Geräteinformationen (einschließlich Geräteidentiten, Geräte twins, Modulidentitäten und Modul-Twins).

Weitere Informationen finden Sie unter 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]

Beispiele

Exportieren Sie den unterstützten Status des angegebenen Hubs in die angegebene Datei.

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

Exportieren Sie den unterstützten Status des angegebenen Hubs in die angegebene Datei, und überschreiben Sie den Dateiinhalt.

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

Exportieren Sie nur die Geräte und Konfigurationen des angegebenen Hubs in die angegebene Datei.

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

Erforderliche Parameter

--state-file -f

Der Pfad zur Datei, in der die Statusinformationen gespeichert werden.

Optionale Parameter

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

--aspects

Hubaspekte (durch Leerzeichen getrennt).

Eigenschaft Wert
Zulässige Werte: arm, configurations, devices
--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Wenn der Authentifizierungstyp login ist und der Ressourcenhost bereitgestellt wird, wird die Ressourcensuche übersprungen, es sei denn, dies ist erforderlich. Sie können die Standardeinstellung mithilfe von az configure --defaults iothub-data-auth-type={auth-type-value}.

Eigenschaft Wert
Parameter group: Access Control Arguments
Standardwert: key
Zulässige Werte: key, login
--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

Eigenschaft Wert
Parameter group: IoT Hub Identifier Arguments
--login -l

Dieser Befehl unterstützt eine Entität Verbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Wird verwendet, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entität Verbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --hub-name nicht angegeben wird.

Eigenschaft Wert
Parameter group: IoT Hub Identifier Arguments
--replace -r

Wenn dieses Flag festgelegt ist, überschreibt der Befehl den Inhalt der Ausgabedatei.

Eigenschaft Wert
Standardwert: False
--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot hub state import

Experimentell

Die Befehlsgruppe "iot hub state" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Importieren Sie einen Hubstatus aus einer Datei in einen IoT Hub.

Wenn der Arm-Aspekt angegeben ist, wird der Hub erstellt, wenn er nicht vorhanden ist.

Standardmäßig enthält der importierte Zustand: Arm-Vorlage für Hub-, Hubkonfigurationen (einschließlich ADM-Konfigurationen und Edgebereitstellungen), Geräteinformationen (einschließlich Geräteidentiten, Geräte twins, Modulidentitäten und Modul-Twins).

Für importierte Endpunkte mit der vom System zugewiesenen Identitätsauthentifizierung muss der angegebene Hub über die richtigen Berechtigungen verfügen. Andernfalls schlägt der Befehl fehl.

Private Endpunkte werden im Importvorgang ignoriert.

Weitere Informationen finden Sie unter 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]

Beispiele

Importieren Sie den unterstützten Zustand aus der angegebenen Datei in den angegebenen Hub.

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

Importieren Sie den unterstützten Zustand aus der angegebenen Datei in den angegebenen Hub, und überschreiben Sie den vorherigen Zustand des Hubs. Alle Zertifikate, Konfigurationen und Geräte werden gelöscht, bevor der neue Zustand hochgeladen wird.

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

Importieren Sie nur die Armvorlage aus der angegebenen Datei in den angegebenen Hub. Beachten Sie, dass dadurch ein neuer Hub erstellt wird, wenn er nicht vorhanden ist. Die Datei kann die Geräte und Konfigurationen enthalten, diese werden jedoch ignoriert.

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

Importieren Sie nur die Geräte und Konfigurationen aus der angegebenen Datei in den angegebenen Hub. Beachten Sie, dass dadurch KEIN neuer Hub erstellt wird, wenn er nicht vorhanden ist und der Befehl fehlschlägt. Die Datei kann die Armvorlage enthalten, die jedoch ignoriert wird.

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

Erforderliche Parameter

--state-file -f

Der Pfad zur Datei, in der die Statusinformationen gespeichert werden.

Optionale Parameter

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

--aspects

Hubaspekte (durch Leerzeichen getrennt).

Eigenschaft Wert
Zulässige Werte: arm, configurations, devices
--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Wenn der Authentifizierungstyp login ist und der Ressourcenhost bereitgestellt wird, wird die Ressourcensuche übersprungen, es sei denn, dies ist erforderlich. Sie können die Standardeinstellung mithilfe von az configure --defaults iothub-data-auth-type={auth-type-value}.

Eigenschaft Wert
Parameter group: Access Control Arguments
Standardwert: key
Zulässige Werte: key, login
--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

Eigenschaft Wert
Parameter group: IoT Hub Identifier Arguments
--login -l

Dieser Befehl unterstützt eine Entität Verbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Wird verwendet, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entität Verbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --hub-name nicht angegeben wird.

Eigenschaft Wert
Parameter group: IoT Hub Identifier Arguments
--replace -r

Wenn dieses Kennzeichen festgelegt ist, löscht der Befehl die aktuellen Geräte, Konfigurationen und Zertifikate des Zielhubs.

Eigenschaft Wert
Standardwert: False
--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot hub state migrate

Experimentell

Die Befehlsgruppe "iot hub state" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Migrieren Sie den Status eines Hubs zu einem anderen Hub, ohne in einer Datei zu speichern.

Wenn der Arm-Aspekt angegeben ist, wird der Hub erstellt, wenn er nicht vorhanden ist.

Standardmäßig enthält der migrierte Zustand: Arm-Vorlage für Hub-, Hubkonfigurationen (einschließlich ADM-Konfigurationen und Edgebereitstellungen), Geräteinformationen (einschließlich Geräteidentiten, Geräte twins, Modulidentitäten und Modul-Twins).

Für migrierte Endpunkte mit der vom System zugewiesenen Identitätsauthentifizierung muss der angegebene Hub über die richtigen Berechtigungen verfügen. Andernfalls schlägt der Befehl fehl.

Private Endpunkte werden im Migrationsprozess ignoriert.

Wenn Sie Probleme beim Migrieren haben, verwenden Sie die Export- und Importbefehle, um eine Datei als Sicherung zu verwenden.

Weitere Informationen finden Sie unter 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]

Beispiele

Migrieren Sie den unterstützten Status des Ursprungshubs zum Zielhub.

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

Migrieren Sie den unterstützten Status des Ursprungshubs zum Zielhub, und überschreiben Sie den vorherigen Zustand des Hubs. Alle Zertifikate, Konfigurationen und Geräte im Zielhub werden gelöscht, bevor der neue Zustand hochgeladen wird.

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

Migrieren Sie nur die Armvorlage vom Ursprungshub zum Zielhub. Beachten Sie, dass dadurch ein neuer Hub erstellt wird, wenn der Zielhub nicht vorhanden ist. Der Origin Hub kann die Geräte und Konfigurationen enthalten, diese werden jedoch ignoriert.

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

Migrieren Sie nur die Geräte und Konfigurationen vom Ursprungshub zum Zielhub. Beachten Sie, dass dadurch KEIN neuer Hub erstellt wird, wenn der Zielhub nicht vorhanden ist und der Befehl fehlschlägt. Die Armvorlage für den Origin Hub wird ignoriert.

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

Optionale Parameter

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

--aspects

Hubaspekte (durch Leerzeichen getrennt).

Eigenschaft Wert
Zulässige Werte: arm, configurations, devices
--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Wenn der Authentifizierungstyp login ist und der Ressourcenhost bereitgestellt wird, wird die Ressourcensuche übersprungen, es sei denn, dies ist erforderlich. Sie können die Standardeinstellung mithilfe von az configure --defaults iothub-data-auth-type={auth-type-value}.

Eigenschaft Wert
Parameter group: Access Control Arguments
Standardwert: key
Zulässige Werte: key, login
--destination-hub --dh

Der Name des IoT-Hubs, in den der Ursprungshubstatus kopiert wird.

Eigenschaft Wert
Parameter group: IoT Hub Identifier Arguments
--destination-hub-login --dl

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen von Aktionen auf dem Zielhub. Wird verwendet, um die Sitzungsanmeldung über az login für diese IoT Hub-Instanz zu vermeiden. Wenn sowohl eine Entität Verbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --destination-hub nicht angegeben wird.

Eigenschaft Wert
Parameter group: IoT Hub Identifier Arguments
--destination-resource-group --dg

Name der Ressourcengruppe des IoT Hub, in den der Ursprungshubstatus kopiert wird. Wenn nicht angegeben, verwendet die IoT Hub-Ressourcengruppe des Ursprungs.

Eigenschaft Wert
Parameter group: IoT Hub Identifier Arguments
--og --origin-resource-group

Name der Ressourcengruppe des IoT Hub, der kopiert wird.

Eigenschaft Wert
Parameter group: IoT Hub Identifier Arguments
--oh --origin-hub

Der Name des IoT Hub, der kopiert wird.

Eigenschaft Wert
Parameter group: IoT Hub Identifier Arguments
--ol --origin-hub-login

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen von Aktionen auf dem Origin Hub. Wird verwendet, um die Sitzungsanmeldung über az login für diese IoT Hub-Instanz zu vermeiden. Wenn sowohl eine Entität Verbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --origin-hub nicht angegeben wird.

Eigenschaft Wert
Parameter group: IoT Hub Identifier Arguments
--replace -r

Wenn dieses Kennzeichen festgelegt ist, löscht der Befehl die aktuellen Geräte, Konfigurationen und Zertifikate des Zielhubs.

Eigenschaft Wert
Standardwert: False
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False