Freigeben über


az iot device registration

Note

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.67.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie zum ersten Mal eine az iot-Geräteregistrierung Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Diese Befehlsgruppe befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Verwalten Von IoT-Geräteregistrierungen für den IoT-Gerätebereitstellungsdienst.

Dient az iot dps enrollment registration zum az iot dps enrollment-group registration Anzeigen und Löschen von Registrierungen.

Befehle

Name Beschreibung Typ Status
az iot device registration create

Registrieren Sie ein IoT-Gerät beim IoT-Gerätebereitstellungsdienst.

Extension Preview

az iot device registration create

Vorschau

Die Befehlsgruppe "iot-Geräteregistrierung" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Registrieren Sie ein IoT-Gerät beim IoT-Gerätebereitstellungsdienst.

Die folgenden Nachweismechanismen werden unterstützt:

  • Symmetrischer Schlüssel
  • x509-Zertifikat Bei Verwendung von x509-Authentifizierungsmethoden müssen die Zertifikat- und Schlüsseldateien (und passphrase bei Bedarf) bereitgestellt werden.
az iot device registration create --registration-id --rid
                                  [--auth-type {key, login}]
                                  [--certificate-file-path --cp]
                                  [--ck --compute-key]
                                  [--dps-name]
                                  [--enrollment-group-id --gid --group-id]
                                  [--host --provisioning-host]
                                  [--id-scope --scope]
                                  [--key --symmetric-key]
                                  [--key-file-path --kp]
                                  [--login]
                                  [--pass --passphrase]
                                  [--payload]
                                  [--resource-group]

Beispiele

Registrieren Sie ein IoT-Gerät mithilfe einer individuellen Registrierung.

az iot device registration create -n {dps_name} --rid {registration_id}

Registrieren Sie ein IoT-Gerät mithilfe einer Gruppenregistrierung.

az iot device registration create -n {dps_name} --rid {registration_id} --gid {group_enrollment_id}

Registrieren Sie ein IoT-Gerät mithilfe einer einzelnen Registrierung, des Gerätebereitstellungsdienst-ID-Bereichs und eines symmetrischen Schlüssels. Dadurch wird das Abrufen des ID-Bereichs und des individalen Registrierungssymmetrischen Schlüssels umgangen.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --key {symmetric_key}

Registrieren Sie ein IoT-Gerät mithilfe einer Gruppenregistrierung, des Gerätebereitstellungsdienst-ID-Bereichs und eines symmetrischen Registrierungsgruppenschlüssels. Dadurch wird das Abrufen des ID-Bereichs und des symmetrischen Registrierungsgruppenschlüssels umgangen. Der symmetrische Schlüssel, der für die Geräteregistrierung verwendet wird, wird aus dem angegebenen symmetrischen Schlüssel berechnet.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --gid {group_enrollment_id} --key {symmetric_key} --ck

Registrieren Sie ein IoT-Gerät mithilfe einer Gruppenregistrierung, des Gerätebereitstellungsdienst-ID-Bereichs und eines symmetrischen Schlüssels. Dadurch wird das Abrufen des ID-Bereichs umgangen. Beachten Sie, dass die Registrierungsgruppen-ID nicht erforderlich ist, da der symmetrische Schlüssel der berechnete Geräteschlüssel sein sollte.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --key {symmetric_key}

Registrieren Sie ein IoT-Gerät mithilfe einer individuellen Registrierung, des Gerätebereitstellungsdienst-ID-Bereichs und der angegebenen Zertifikat- und Schlüsseldateien. Dadurch wird das Abrufen des ID-Bereichs umgangen.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file}

Registrieren Sie ein IoT-Gerät mithilfe einer individuellen Registrierung, des Gerätebereitstellungsdienst-ID-Bereichs und der angegebenen Zertifikat- und Schlüsseldateien und Passphrase für die Schlüsseldatei. Dadurch wird das Abrufen des ID-Bereichs umgangen.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file} --pass {passphrase}

Registrieren Sie ein IoT-Gerät mithilfe einer Gruppenregistrierung, des Gerätebereitstellungsdienst-ID-Bereichs und der angegebenen Zertifikat- und Schlüsseldateien. Dadurch wird das Abrufen des ID-Bereichs umgangen. Beachten Sie, dass die Gruppenregistrierungs-ID für x509-Nachweise nicht erforderlich ist und der Betreff der Zertifikatdatei die Registrierungs-ID ist.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file}

Erforderliche Parameter

--registration-id --rid

Geräteregistrierungs-ID oder einzelne Registrierungs-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--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
Parametergruppe: Access Control Arguments
Standardwert: key
Zulässige Werte: key, login
--certificate-file-path --cp

Pfad zur PEM-Zertifikatdatei. Erforderlich für x509-Registrierungen.

Eigenschaft Wert
Parametergruppe: x509 Authentication Arguments
--ck --compute-key

Kennzeichnen Sie, um anzugeben, dass der symmetrische Schlüssel für die Geräteregistrierung aus dem angegebenen Schlüssel mit --symmetrischem Schlüssel berechnet werden soll.

Eigenschaft Wert
Parametergruppe: Symmetric Key Authentication Arguments
Standardwert: False
--dps-name -n

Name des Azure IoT Hub-Gerätebereitstellungsdiensts. Erforderlich, wenn --login nicht angegeben oder authenticaton-Argumente und --id-scope nicht bereitgestellt werden.

Eigenschaft Wert
Parametergruppe: DPS Identifier Arguments
--enrollment-group-id --gid --group-id

Registrierungsgruppen-ID. Nur zum Abrufen von Authentifizierungsargumenten erforderlich.

--host --provisioning-host

Endpunkt, der auf den zu verwendenden Bereitstellungshost zeigt.

Eigenschaft Wert
Standardwert: global.azure-devices-provisioning.net
--id-scope --scope

ID-Bereich des Azure IoT Hub-Gerätebereitstellungsdiensts. Wenn sie mit Authentifizierungsargumenten bereitgestellt werden, wird die Sitzungsanmeldung vermieden.

Eigenschaft Wert
Parametergruppe: DPS Identifier Arguments
--key --symmetric-key

Der symmetrische gemeinsam genutzte Zugriffsschlüssel für die Geräteregistrierung.

Eigenschaft Wert
Parametergruppe: Symmetric Key Authentication Arguments
--key-file-path --kp

Pfad zur PEM-Schlüsseldatei. Erforderlich für x509-Registrierungen.

Eigenschaft Wert
Parametergruppe: x509 Authentication 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 --dps-name nicht angegeben oder authenticaton-Argumente und --id-scope nicht bereitgestellt werden.

Eigenschaft Wert
Parametergruppe: DPS Identifier Arguments
--pass --passphrase

Passphrase für das Zertifikat.

Eigenschaft Wert
Parametergruppe: x509 Authentication Arguments
--payload

Benutzerdefinierte Zuordnungsnutzlast als JSON. Speziell für die Verwendung mit benutzerdefinierten Zuordnungsrichtlinien mithilfe von Azure Functions.

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

Ausgabeformat.

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