az iot hub device-identity

  • Referenz

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.46.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen Az iot Hub-Geräteidentitätsbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Verwalten von IoT-Geräten.

Befehle

Name Beschreibung Typ Status
az iot hub device-identity children

Verwalten von untergeordneten Gerätebeziehungen für IoT-Edgegeräte.

 Erweiterung Allgemein verfügbar
az iot hub device-identity children add

Fügen Sie Geräte als untergeordnete Geräte zu einem Ziel-Edgegerät hinzu.

 Erweiterung Allgemein verfügbar
az iot hub device-identity children list

Gibt die Auflistung der zugewiesenen untergeordneten Geräte aus.

 Erweiterung Allgemein verfügbar
az iot hub device-identity children remove

Entfernen sie untergeordnete Geräte von einem Ziel-Edgegerät.

 Erweiterung Allgemein verfügbar
az iot hub device-identity connection-string

Verwalten sie die Verbindungszeichenfolge des IoT-Geräts.

 Erweiterung Allgemein verfügbar
az iot hub device-identity connection-string show

Anzeigen eines bestimmten IoT Hub-Geräts Verbindungszeichenfolge.

 Erweiterung Allgemein verfügbar
az iot hub device-identity create

Erstellen Sie ein Gerät in einem IoT Hub.

 Erweiterung Allgemein verfügbar
az iot hub device-identity delete

Löschen Sie ein IoT Hub-Gerät.

 Erweiterung Allgemein verfügbar
az iot hub device-identity export

Exportieren Sie alle Geräteidentitäten aus einem IoT Hub in einen Azure Storage-BLOB-Container.

 Erweiterung Allgemein verfügbar
az iot hub device-identity import

Importieren von Geräteidentitäten in einen IoT Hub aus einem Speichercontainer-BLOB.

 Erweiterung Allgemein verfügbar
az iot hub device-identity list

Auflisten von Geräten in einem IoT Hub.

 Erweiterung Allgemein verfügbar
az iot hub device-identity parent

Verwalten sie übergeordnete Gerätebeziehungen für IoT-Geräte.

 Erweiterung Allgemein verfügbar
az iot hub device-identity parent set

Legen Sie das übergeordnete Gerät eines Zielgeräts fest.

 Erweiterung Allgemein verfügbar
az iot hub device-identity parent show

Rufen Sie das übergeordnete Gerät eines Zielgeräts ab.

 Erweiterung Allgemein verfügbar
az iot hub device-identity renew-key

Verlängern Sie Zielschlüssel eines IoT Hub-Geräts mit sas-Authentifizierung.

 Erweiterung Allgemein verfügbar
az iot hub device-identity show

Rufen Sie die Details eines IoT Hub-Geräts ab.

 Erweiterung Allgemein verfügbar
az iot hub device-identity update

Aktualisieren sie ein IoT Hub-Gerät.

 Erweiterung Allgemein verfügbar

az iot hub device-identity create

Erstellen Sie ein Gerät in einem IoT Hub.

Bei Verwendung der Authentifizierungsmethode von shared_private_key (auch als symmetrische Schlüssel bezeichnet) wird der Dienst für das Gerät generiert, wenn keine benutzerdefinierten Schlüssel bereitgestellt werden.

Wenn ein Gerätebereich für ein Edgegerät bereitgestellt wird, wird der Wert automatisch in einen übergeordneten Bereich konvertiert.

az iot hub device-identity create --device-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--device-scope]
                                  [--edge-enabled {false, true}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--sta {disabled, enabled}]
                                  [--star]
                                  [--valid-days]

Beispiele

Erstellen Sie ein Edge-fähiges IoT-Gerät mit Standardautorisierung (gemeinsam genutzter privater Schlüssel).

az iot hub device-identity create -n {iothub_name} -d {device_id} --ee

Erstellen Sie ein IoT-Gerät mit selbstsignierter Zertifikatautorisierung, generieren Sie ein Zertifikat, das 10 Tage lang gültig ist, und verwenden Sie dann den Fingerabdruck.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --valid-days 10

Erstellen Sie ein IoT-Gerät mit selbstsignierter Zertifikatautorisierung, generieren Sie ein Zertifikat des Standardablaufs (365 Tage) und die Ausgabe in das Zielverzeichnis.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --output-dir /path/to/output

Erstellen Sie ein IoT-Gerät mit selbstsignierter Zertifikatautorisierung und stellen explizit primäre und sekundäre Fingerabdrucke bereit.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --ptp {thumbprint_1} --stp {thumbprint_2}

Erstellen Sie ein IoT-Gerät mit Stammzertifizierungsstelle-Autorisierung mit deaktivierten Status und Grund.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_ca --status disabled --status-reason 'for reasons'

Erstellen Sie ein IoT-Gerät mit einem Gerätebereich.

az iot hub device-identity create -n {iothub_name} -d {device_id} --device-scope 'ms-azure-iot-edge://edge0-123456789123456789'

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

--am --auth-method

Die Autorisierungsmethode, mit der eine Entität erstellt werden soll.

Zulässige Werte: shared_private_key, x509_ca, x509_thumbprint
Standardwert: shared_private_key
--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>.

Zulässige Werte: key, login
Standardwert: key
--device-scope

Der Bereich des Geräts. Bei Edgegeräten wird dies automatisch generiert und unveränderlich. Legen Sie dies für Blattgeräte fest, um eine untergeordnete/übergeordnete Beziehung zu erstellen.

--edge-enabled --ee

Flag, das die Randaktivierung angibt.

Zulässige Werte: false, true
Standardwert: False
--hub-name -n

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

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

--od --output-dir

Generieren Sie selbstsignierte Zertifikate, und verwenden Sie den Fingerabdruck. Ausgabe in angegebenes Zielverzeichnis.

--pk --primary-key

Der primäre symmetrische gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.

--primary-thumbprint --ptp

Selbstsignierter Zertifikatfingerabdruck, der für den primären Fingerabdruck verwendet werden soll.

--resource-group -g

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

--secondary-key --sk

Der sekundäre symmetrische gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.

--secondary-thumbprint --stp

Selbstsignierter Zertifikatfingerabdruck, der für den sekundären Fingerabdruck verwendet werden soll.

--sta --status

Legen Sie den Gerätestatus beim Erstellen fest.

Zulässige Werte: disabled, enabled
Standardwert: enabled
--star --status-reason

Beschreibung für den Gerätestatus.

--valid-days --vd

Generieren Sie selbstsignierte Zertifikate, und verwenden Sie den Fingerabdruck. Gültig für die angegebene Anzahl von Tagen. Standard: 365.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot hub device-identity delete

Löschen Sie ein IoT Hub-Gerät.

az iot hub device-identity delete --device-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

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

Zulässige Werte: key, login
Standardwert: key
--etag -e

Etag oder Entitätstag, das dem letzten Status der Ressource entspricht. Wenn kein Etag angegeben wird, wird der Wert '*' verwendet.

--hub-name -n

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

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

--resource-group -g

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

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot hub device-identity export

Exportieren Sie alle Geräteidentitäten aus einem IoT Hub in einen Azure Storage-BLOB-Container.

Das Ausgabe-BLOB, das Geräteidentitäten enthält, ist eine Textdatei mit dem Namen "devices.txt".

Erforderliche Berechtigungen – Entweder ioT Hub shared access policy supporting 'Registry Read & Registry Write' OR a principal with 'IoT Hub Data Contributor' role on the IoT Hub.

Parameter für speicherkontoname und blob container name can only be used when the storage account is in the same subscription as the input IoT Hub. Informationen zu INLINE-BLOB-Container-SAS-URI-Eingaben finden Sie in den Eingaberegeln Ihrer Umgebung.

Weitere Informationen finden Sie unter https://aka.ms/iothub-device-exportimport.

az iot hub device-identity export [--auth-type {key, login}]
                                  [--bc]
                                  [--bcu]
                                  [--hub-name]
                                  [--identity]
                                  [--ik {false, true}]
                                  [--login]
                                  [--resource-group]
                                  [--sa]

Beispiele

Exportieren Sie alle Geräteidentitäten in einen konfigurierten BLOB-Container und schließen Sie Geräteschlüssel ein. Der Blobcontainername und der Speicherkontoname werden als Parameter für den Befehl bereitgestellt.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name}

Exportieren Sie alle Geräteidentitäten in einen konfigurierten BLOB-Container und schließen Sie Geräteschlüssel ein. Verwendet ein Inline-SAS-URI-Beispiel.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices?sv=2019-02-02&st=2020-08-23T22%3A35%3A00Z&se=2020-08-24T22%3A35%3A00Z&sr=c&sp=rwd&sig=VrmJ5sQtW3kLzYg10VqmALGCp4vtYKSLNjZDDJBSh9s%3D'

Exportieren Sie alle Geräteidentitäten mithilfe eines Dateipfads, der den SAS-URI enthält, in einen konfigurierten BLOB-Container.

az iot hub device-identity export -n {iothub_name} --bcu {sas_uri_filepath}

Exportieren Sie alle Geräteidentitäten in einen konfigurierten BLOB-Container und schließen Sie Geräteschlüssel ein. Verwendet die vom System zugewiesene Identität, die über Rollen des Mitwirkenden von Speicher-BLOB-Daten für das Speicherkonto verfügt. Der Blobcontainername und der Speicherkontoname werden als Parameter für den Befehl bereitgestellt.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity [system]

Exportieren Sie alle Geräteidentitäten in einen konfigurierten BLOB-Container und schließen Sie Geräteschlüssel ein. Verwendet die vom System zugewiesene Identität, die über Rollen des Mitwirkenden von Speicher-BLOB-Daten für das Speicherkonto verfügt. Der BLOB-Container-URI benötigt nicht das BLOB-SAS-Token.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity [system]

Exportieren Sie alle Geräteidentitäten in einen konfigurierten BLOB-Container und schließen Sie Geräteschlüssel ein. Verwendet die vom Benutzer zugewiesene verwaltete Identität, die die Rolle "Storage Blob Data Contributor" für das Speicherkonto besitzt. Der Blobcontainername und der Speicherkontoname werden als Parameter für den Befehl bereitgestellt.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity {managed_identity_resource_id}

Exportieren Sie alle Geräteidentitäten in einen konfigurierten BLOB-Container und schließen Sie Geräteschlüssel ein. Verwendet die vom Benutzer zugewiesene verwaltete Identität, die die Rolle "Storage Blob Data Contributor" für das Speicherkonto besitzt. Der BLOB-Container-URI benötigt nicht das BLOB-SAS-Token.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity {managed_identity_resource_id}

Optionale Parameter

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

Zulässige Werte: key, login
Standardwert: key
--bc --blob-container

Dieser BLOB-Container wird verwendet, um den Status des Geräteidentitätsimportauftrags und der Ergebnisse auszugeben. Der Parameter wird ignoriert, wenn blob_container_uri bereitgestellt wird. Schreib-, Lese- und Löschzugriff ist für diesen BLOB-Container erforderlich.

--bcu --blob-container-uri

Blob Shared Access Signature URI mit Schreib-, Lese- und Löschzugriff auf einen BLOB-Container. Dies wird verwendet, um den Status des Auftrags und die Ergebnisse auszugeben. Hinweis: Bei Verwendung der identitätsbasierten Authentifizierung ist weiterhin ein https://-URI erforderlich , aber kein SAS-Token erforderlich. Eingaben für dieses Argument können inline oder aus einem Dateipfad stammen.

--hub-name -n

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

--identity

Verwalteter Identitätstyp, um zu ermitteln, ob vom System zugewiesene verwaltete Identität oder vom Benutzer zugewiesene verwaltete Identität verwendet wird. Verwenden Sie für vom System zugewiesene verwaltete Identität [system]. Geben Sie für vom Benutzer zugewiesene verwaltete Identität die Ressourcen-ID der vom Benutzer zugewiesenen verwalteten Identität an. Für diese Identität ist eine Rollen für "Storage Blob Data Contributor" für das Speicherkonto erforderlich.

--ik --include-keys

Wenn festgelegt, werden Schlüssel normal exportiert. Andernfalls werden Schlüssel in der Exportausgabe auf NULL festgelegt.

Zulässige Werte: false, true
Standardwert: False
--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.

--resource-group -g

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

--sa --storage-account

Name des Azure Storage-Kontos, das den Ausgabe-BLOB-Container enthält. Der Parameter wird ignoriert, wenn blob_container_uri bereitgestellt wird. Schreib-, Lese- und Löschzugriff ist erforderlich.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot hub device-identity import

Importieren von Geräteidentitäten in einen IoT Hub aus einem Speichercontainer-BLOB.

Die erwartete Eingabedatei, die Geräteidentitäten enthält, sollte den Namen "devices.txt" haben. Die Ausgabeprotokolldatei "importErrors.log" ist leer, wenn der Import erfolgreich ist, und enthält Fehlerprotokolle im Falle eines Importfehlers.

Erforderliche Berechtigungen – Entweder ioT Hub shared access policy supporting 'Registry Read & Registry Write' OR a principal with 'IoT Hub Data Contributor' role on the IoT Hub.

Parameter für speicherkontoname und blob container name can only be used when the storage account is in the same subscription as the input IoT Hub. Informationen zu INLINE-BLOB-Container-SAS-URI-Eingaben finden Sie in den Eingaberegeln Ihrer Umgebung.

Weitere Informationen finden Sie unter https://aka.ms/iothub-device-exportimport.

az iot hub device-identity import [--auth-type {key, login}]
                                  [--hub-name]
                                  [--ibc]
                                  [--ibcu]
                                  [--identity]
                                  [--input-storage-account]
                                  [--login]
                                  [--obc]
                                  [--obcu]
                                  [--osa]
                                  [--resource-group]

Beispiele

Importieren Sie alle Geräteidentitäten aus einem Blob, indem Sie Befehlsparameter für Eingabe-BLOB-Container und Speicherkonto sowie Ausgabe-BLOB-Container und Speicherkonto bereitstellen.

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name}

Importieren Sie alle Geräteidentitäten aus einem Blob mithilfe eines Inline-SAS-URI.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri}

Importieren Sie alle Geräteidentitäten aus einem BLOB mithilfe eines Dateipfads, der SAS-URI enthält.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri_filepath} --obcu {output_sas_uri_filepath}

Importieren Sie alle Geräteidentitäten aus einem Blob mithilfe der vom System zugewiesenen Identität, die über Rollen für "Storage Blob Data Contributor" für beide Speicherkonten verfügt. Der Eingabe-BLOB-Container und das Speicherkonto sowie der Ausgabe-BLOB-Container und das Speicherkonto werden als Parameter für den Befehl bereitgestellt.

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity [system]

Importieren Sie alle Geräteidentitäten aus einem Blob mithilfe der vom System zugewiesenen Identität, die über Rollen für "Storage Blob Data Contributor" für beide Speicherkonten verfügt. Der BLOB-Container-URI benötigt nicht das BLOB-SAS-Token.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity [system]

Importieren Sie alle Geräteidentitäten aus einem Blob, wobei die vom Benutzer zugewiesene verwaltete Identität verwendet wird, die über Rollen für "Storage Blob Data Contributor" für beide Speicherkonten verfügt. Der Eingabe-BLOB-Container und das Speicherkonto sowie der Ausgabe-BLOB-Container und das Speicherkonto werden als Parameter für den Befehl bereitgestellt.

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity {managed_identity_resource_id}

Importieren Sie alle Geräteidentitäten aus einem Blob, wobei die vom Benutzer zugewiesene verwaltete Identität verwendet wird, die über Rollen für "Storage Blob Data Contributor" für beide Speicherkonten verfügt. Der BLOB-Container-URI benötigt nicht das BLOB-SAS-Token.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity {managed_identity_resource_id}

Optionale Parameter

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

Zulässige Werte: key, login
Standardwert: key
--hub-name -n

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

--ibc --input-blob-container

Dieser BLOB-Container speichert die Datei, die Vorgänge definiert, die für die Identitätsregistrierung ausgeführt werden sollen. Der Parameter wird ignoriert, wenn input_blob_container_uri bereitgestellt wird. Lesezugriff ist für diesen BLOB-Container erforderlich.

--ibcu --input-blob-container-uri

Blob Shared Access Signature URI mit Lesezugriff auf einen BLOB-Container. Dieser Blob enthält die Vorgänge, die für die Identitätsregistrierung ausgeführt werden sollen. Hinweis: Bei Verwendung der identitätsbasierten Authentifizierung ist weiterhin ein https://-URI erforderlich , aber kein SAS-Token erforderlich. Eingaben für dieses Argument können inline oder aus einem Dateipfad stammen.

--identity

Verwalteter Identitätstyp, um zu ermitteln, ob vom System zugewiesene verwaltete Identität oder vom Benutzer zugewiesene verwaltete Identität verwendet wird. Verwenden Sie für vom System zugewiesene verwaltete Identität [system]. Geben Sie für vom Benutzer zugewiesene verwaltete Identität die Ressourcen-ID der vom Benutzer zugewiesenen verwalteten Identität an. Diese Identität erfordert eine Rolle "Storage Blob Data Contributor" für die Zielrolle "Speicherkonto" und "Mitwirkender" für den IoT Hub.

--input-storage-account --isa

Name des Azure Storage-Kontos, das den Eingabe-BLOB-Container enthält. Nur erforderlich, wenn input_blob_container_uri nicht angegeben wird. Lesezugriff ist erforderlich.

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

--obc --output-blob-container

Dieser BLOB-Container wird verwendet, um den Status des Geräteidentitätsimportauftrags und der Ergebnisse auszugeben. Nur erforderlich, wenn input_blob_container_uri nicht angegeben wird. Schreibzugriff ist für diesen BLOB-Container erforderlich.

--obcu --output-blob-container-uri

Blob Shared Access Signature URI mit Schreibzugriff auf einen BLOB-Container. Dies wird verwendet, um den Status des Auftrags und die Ergebnisse auszugeben. Hinweis: Bei Verwendung der identitätsbasierten Authentifizierung ist weiterhin ein https:// URI ohne das SAS-Token erforderlich. Eingaben für dieses Argument können inline oder aus einem Dateipfad stammen.

--osa --output-storage-account

Name des Azure Storage-Kontos, das den Ausgabe-BLOB-Container enthält. Der Parameter wird ignoriert, wenn output_blob_container_uri bereitgestellt wird. Schreibzugriff ist erforderlich.

--resource-group -g

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

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot hub device-identity list

Auflisten von Geräten in einem IoT Hub.

Dieser Befehl ist ein Alias für az iot hub device-twin list, der für diesen Befehl dringend empfohlen wird. In Zukunft kann dieser az iot hub device-identity list Befehl geändert oder veraltet sein.

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

Optionale Parameter

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

Zulässige Werte: key, login
Standardwert: key
--edge-enabled --ee

Flag, das die Randaktivierung angibt.

Zulässige Werte: false, true
Standardwert: False
--hub-name -n

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

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

--resource-group -g

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

--top

Maximale Anzahl der zurückzugebenden Elemente. Verwenden Sie -1 für unbegrenzt.

Standardwert: 1000
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot hub device-identity renew-key

Verlängern Sie Zielschlüssel eines IoT Hub-Geräts mit sas-Authentifizierung.

az iot hub device-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--resource-group]

Beispiele

Verlängern Sie den Primärschlüssel.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt primary

Tauschen Sie die primären und sekundären Schlüssel aus.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt swap

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

--hub-name -n

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

--key-type --kt

Zielschlüsseltyp, der neu generiert werden soll.

Zulässige Werte: primary, secondary, swap

Optionale Parameter

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

Zulässige Werte: key, login
Standardwert: key
--etag -e

Etag oder Entitätstag, das dem letzten Status der Ressource entspricht. Wenn kein Etag angegeben wird, wird der Wert '*' verwendet.

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

--resource-group -g

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

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot hub device-identity show

Rufen Sie die Details eines IoT Hub-Geräts ab.

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

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

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

Zulässige Werte: key, login
Standardwert: key
--hub-name -n

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

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

--resource-group -g

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

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot hub device-identity update

Aktualisieren sie ein IoT Hub-Gerät.

Verwenden Sie --set gefolgt von Eigenschaftszuweisungen zum Aktualisieren eines Geräts. Nutzen Sie parameter, die von "iot hub device-identity show" zurückgegeben werden.

az iot hub device-identity update --device-id
                                  [--add]
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--edge-enabled {false, true}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--remove]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--set]
                                  [--sta {disabled, enabled}]
                                  [--star]

Beispiele

Aktivieren der Edgefunktionen für Das Gerät

az iot hub device-identity update -d {device_id} -n {iothub_name} --set capabilities.iotEdge=true

Aktivieren Sie Edgefunktionen für Geräte mithilfe des Komfortarguments.

az iot hub device-identity update -d {device_id} -n {iothub_name} --ee

Gerätestatus deaktivieren

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled

Deaktivieren Sie den Gerätestatus mithilfe des Komfortarguments.

az iot hub device-identity update -d {device_id} -n {iothub_name} --status disabled

In einem Befehl

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled capabilities.iotEdge=true

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

Standardwert: []
--am --auth-method

Die Autorisierungsmethode, mit der eine Entität erstellt werden soll.

Zulässige Werte: shared_private_key, x509_ca, x509_thumbprint
--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>.

Zulässige Werte: key, login
Standardwert: key
--edge-enabled --ee

Flag, das die Randaktivierung angibt.

Zulässige Werte: false, true
--etag -e

Etag oder Entitätstag, das dem letzten Status der Ressource entspricht. Wenn kein Etag angegeben wird, wird der Wert '*' verwendet.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Standardwert: False
--hub-name -n

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

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

--pk --primary-key

Der primäre symmetrische gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.

--primary-thumbprint --ptp

Selbstsignierter Zertifikatfingerabdruck, der für den primären Fingerabdruck verwendet werden soll.

--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

Standardwert: []
--resource-group -g

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

--secondary-key --sk

Der sekundäre symmetrische gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.

--secondary-thumbprint --stp

Selbstsignierter Zertifikatfingerabdruck, der für den sekundären Fingerabdruck verwendet werden soll.

--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>.

Standardwert: []
--sta --status

Legen Sie den Gerätestatus beim Erstellen fest.

Zulässige Werte: disabled, enabled
--star --status-reason

Beschreibung für den Gerätestatus.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.