az iot dps enrollment

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.30.0 oder höher). Die Erweiterung installiert automatisch beim ersten Ausführen eines Az iot dps-Registrierungsbefehls . Weitere Informationen zu Erweiterungen

Verwalten einzelner Geräteregistrierungen in einem Azure IoT Hub Gerätebereitstellungsdienst.

Befehle

az iot dps enrollment create

Erstellen Sie eine einzelne Geräteregistrierung in einem Azure IoT Hub Gerätebereitstellungsdienst.

az iot dps enrollment delete

Löschen Sie eine einzelne Geräteregistrierung in einem Azure IoT Hub Gerätebereitstellungsdienst.

az iot dps enrollment list

Auflisten einzelner Geräteregistrierungen in einem Azure IoT Hub Gerätebereitstellungsdienst.

az iot dps enrollment registration

Verwalten Sie dienstseitige Geräteregistrierungen für eine einzelne Registrierung in einem Azure IoT Hub Gerätebereitstellungsdienst.

az iot dps enrollment registration delete

Löschen Sie eine Geräteregistrierung für eine einzelne Registrierung in einem Azure IoT Hub Gerätebereitstellungsdienst.

az iot dps enrollment registration show

Rufen Sie eine Geräteregistrierung für eine einzelne Registrierung in einem Azure IoT Hub Gerätebereitstellungsdienst ab.

az iot dps enrollment show

Abrufen einzelner Geräteregistrierungsdetails in einem Azure IoT Hub Gerätebereitstellungsdienst.

az iot dps enrollment update

Aktualisieren einer einzelnen Geräteregistrierung in einem Azure IoT Hub Gerätebereitstellungsdienst.

az iot dps enrollment create

Erstellen Sie eine einzelne Geräteregistrierung in einem Azure IoT Hub Gerätebereitstellungsdienst.

az iot dps enrollment create --at {symmetricKey, tpm, x509}
                             --eid
                             [--allocation-policy {custom, geoLatency, hashed, static}]
                             [--api-version]
                             [--auth-type {key, login}]
                             [--certificate-path]
                             [--device-id]
                             [--device-information]
                             [--dps-name]
                             [--edge-enabled {false, true}]
                             [--ek]
                             [--hn]
                             [--ih]
                             [--initial-twin-properties]
                             [--initial-twin-tags]
                             [--login]
                             [--pk]
                             [--provisioning-status {disabled, enabled}]
                             [--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp]
                             [--secondary-key]
                             [--webhook-url]

Beispiele

Erstellen Sie eine Registrierung "{enrollment_id}" mit dem Nachweistyp "x509" im Azure IoT-Gerätebereitstellungsdienst "{dps_name}" in der Ressourcengruppe "{resource_group_name}" mit dem Bereitstellungsstatus "deaktiviert", Geräte-ID '{device_id}', erste Zwillingseigenschaften '{"location":{"region":"US"}}', erste Twintags '{"version":"1"}' und Geräteinformationen '{"color":"red"}'.

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type x509 --certificate-path /certificates/Certificate.pem --provisioning-status disabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version':'1'}" --device-info "{'color':'red'}" --device-id {device_id}

Erstellen Sie eine Registrierung "MyEnrollment" mit Nachweistyp "tpm" im Azure IoT-Gerätebereitstellungsdienst '{dps_name}' in der Ressourcengruppe '{resource_group_name}'.

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89

Erstellen Sie eine Registrierung "MyEnrollment" mit dem Nachweistyp "symmetrickey" im Azure IoT-Gerätebereitstellungsdienst "{dps_name}" in der Ressourcengruppe "{resource_group_name}".

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --primary-key {primary_key} --secondary-key {secondary_key}

Erstellen Sie eine Registrierung "MyEnrollment" mit erneuter Bereitstellung im Azure IoT-Gerätebereitstellungsdienst '{dps_name}' in der Ressourcengruppe '{resource_group_name}'.

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --reprovision-policy {reprovision_type} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89

Erstellen Sie eine Registrierung "MyEnrollment" mit statischer Zuordnungsrichtlinie im Azure IoT-Gerätebereitstellungsdienst '{dps_name}' in der Ressourcengruppe '{resource_group_name}'.

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy static --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name}

Erstellen Sie eine Registrierung "MyEnrollment" mit Hashzuordnungsrichtlinie und mehreren Hubs im Azure IoT-Gerätebereitstellungsdienst "{dps_name}" in der Ressourcengruppe "{resource_group_name}".

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy hashed --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs "{iot_hub_host_name1} {iot_hub_host_name2}"

Erstellen einer Registrierung "MyEnrollment" mit benutzerdefinierter Zuordnungsrichtlinie,

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}

Erforderliche Parameter

--at --attestation-type

Nachweismechanismus, der für die Authentifizierung für die DPS verwendet wird.

Zulässige Werte: symmetricKey, tpm, x509
--eid --enrollment-id

Individuelle Geräteregistrierungs-ID.

Optionale Parameter

--allocation-policy --ap

Typ der Zuordnungsrichtlinie, um zu bestimmen, wie ein Gerät einem IoT Hub zugewiesen wird. Falls nicht angegeben, ist die Zuordnungsrichtlinie der aktuelle Standard für die Zuordnungsrichtlinie für die Device Provisioning Service-Instanz.

Zulässige Werte: custom, geoLatency, hashed, static
--api-version --av

Die API-Version der Bereitstellungsdiensttypen, die in der benutzerdefinierten Zuordnungsanforderung gesendet werden. Mindest unterstützte Version: 2018-09-01-preview.

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Sie können die Standardeinstellung mithilfe von az configure --defaults iotdps-data-auth-type=<auth-type-value>.

Zulässige Werte: key, login
Standardwert: key
--certificate-path --cp

Der Pfad zur Datei, die das primäre Zertifikat enthält. Erforderlich, wenn Sie x509 als Nachweistyp auswählen und der sekundäre Zertifikatpfad nicht angegeben wird.

--device-id -d

Geräte-ID, die im IoT Hub registriert ist.

--device-information --info

Optionale Geräteinformationen.

--dps-name -n

Name des Azure IoT Hub Gerätebereitstellungsdiensts. Erforderlich, wenn die Anmeldung nicht angegeben wird.

--edge-enabled --ee

Kennzeichen, das die Randaktivierung angibt.

Zulässige Werte: false, true
--ek --endorsement-key

TPM-Bestätigungsschlüssel für ein TPM-Gerät. Wenn Sie tpm als Nachweistyp auswählen, ist der Bestätigungsschlüssel erforderlich.

--hn --iot-hub-host-name

Hostname des Ziel-IoT Hub. Die Zuordnungsrichtlinie ist standardmäßig statisch, wenn dieser Parameter bereitgestellt wird.

--ih --iot-hubs

Hostname des Ziels IoT Hub, das der Zuordnungsrichtlinie zugeordnet ist. Verwenden Sie leertrennte Liste für mehrere IoT Hubs.

--initial-twin-properties --props

Anfängliche Geräte-Twin-Eigenschaften.

--initial-twin-tags --tags

Erste Geräte-Twin-Tags.

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen einer Aktion. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --dps-name nicht angegeben wird.

--pk --primary-key

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

--provisioning-status --ps

Aktivieren oder deaktivieren Sie den Registrierungseintrag.

Zulässige Werte: disabled, enabled
--reprovision-policy --rp

Richtlinie, um zu bestimmen, wie Gerätedaten bei der erneuten Bereitstellung für eine andere IoT Hub behandelt werden sollen.

Zulässige Werte: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

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

--scp --secondary-certificate-path

Der Pfad zur Datei, die das sekundäre Zertifikat enthält. Erforderlich, wenn Sie x509 als Nachweistyp auswählen und der primäre Zertifikatpfad nicht angegeben wird.

--secondary-key --sk

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

--webhook-url --wh

Die Azure Function-Webhook-URL, die für benutzerdefinierte Zuordnungsanforderungen verwendet wird.

az iot dps enrollment delete

Löschen Sie eine einzelne Geräteregistrierung in einem Azure IoT Hub Gerätebereitstellungsdienst.

az iot dps enrollment delete --eid
                             [--auth-type {key, login}]
                             [--dps-name]
                             [--etag]
                             [--login]
                             [--resource-group]

Erforderliche Parameter

--eid --enrollment-id

Individuelle Geräteregistrierungs-ID.

Optionale Parameter

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Sie können die Standardeinstellung mithilfe von az configure --defaults iotdps-data-auth-type=<auth-type-value>.

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

Name des Azure IoT Hub Gerätebereitstellungsdiensts. Erforderlich, wenn die Anmeldung nicht angegeben wird.

--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ätsverbindungszeichenfolge mit Rechten zum Ausführen einer Aktion. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --dps-name nicht angegeben wird.

--resource-group -g

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

az iot dps enrollment list

Auflisten einzelner Geräteregistrierungen in einem Azure IoT Hub Gerätebereitstellungsdienst.

az iot dps enrollment list [--auth-type {key, login}]
                           [--dps-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. Sie können die Standardeinstellung mithilfe von az configure --defaults iotdps-data-auth-type=<auth-type-value>.

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

Name des Azure IoT Hub Gerätebereitstellungsdiensts. Erforderlich, wenn die Anmeldung nicht angegeben wird.

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen einer Aktion. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --dps-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.

az iot dps enrollment show

Abrufen einzelner Geräteregistrierungsdetails in einem Azure IoT Hub Gerätebereitstellungsdienst.

az iot dps enrollment show --eid
                           [--auth-type {key, login}]
                           [--dps-name]
                           [--keys {false, true}]
                           [--login]
                           [--resource-group]

Beispiele

Grundlegende Verwendung

az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}

Vollständige Nachweisinformationen in Ergebnisse für eine symmetrische Schlüsselregistrierung einschließen

az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys

Erforderliche Parameter

--eid --enrollment-id

Individuelle Geräteregistrierungs-ID.

Optionale Parameter

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Sie können die Standardeinstellung mithilfe von az configure --defaults iotdps-data-auth-type=<auth-type-value>.

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

Name des Azure IoT Hub Gerätebereitstellungsdiensts. Erforderlich, wenn die Anmeldung nicht angegeben wird.

--keys --show-keys

Schließen Sie Nachweisschlüssel und Informationen in Die Registrierungsergebnisse ein.

Zulässige Werte: false, true
--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen einer Aktion. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --dps-name nicht angegeben wird.

--resource-group -g

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

az iot dps enrollment update

Aktualisieren einer einzelnen Geräteregistrierung in einem Azure IoT Hub Gerätebereitstellungsdienst.

az iot dps enrollment update --eid
                             [--allocation-policy {custom, geoLatency, hashed, static}]
                             [--api-version]
                             [--auth-type {key, login}]
                             [--certificate-path]
                             [--device-id]
                             [--device-information]
                             [--dps-name]
                             [--edge-enabled {false, true}]
                             [--ek]
                             [--etag]
                             [--hn]
                             [--ih]
                             [--initial-twin-properties]
                             [--initial-twin-tags]
                             [--login]
                             [--pk]
                             [--provisioning-status {disabled, enabled}]
                             [--rc {false, true}]
                             [--remove-secondary-certificate {false, true}]
                             [--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp]
                             [--secondary-key]
                             [--webhook-url]

Beispiele

Aktualisieren Sie die Registrierung '{enrollment_id}' mit einem neuen x509-Zertifikat im Azure IoT Device Provisioning Service '{dps_name}' in der Ressourcengruppe '{resource_group_name}'.

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --etag AAAAAAAAAAA=

Aktualisieren Sie die Registrierung "{enrollment_id}" mit einem neuen Bestätigungsschlüssel im Azure IoT-Gerätebereitstellungsdienst "{dps_name}" in der Ressourcengruppe "{resource_group_name}".

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --etag AAAAAAAAAAA=

Aktualisieren Sie die Registrierung '{enrollment_id}' mit einem neuen Primärschlüssel im Azure IoT-Gerätebereitstellungsdienst '{dps_name}' in der Ressourcengruppe '{resource_group_name}'.

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=

Aktualisieren Sie die Registrierung '{enrollment_id}' mit einem neuen Neubereitstellungstyp im Azure IoT Device Provisioning Service '{dps_name}' in der Ressourcengruppe '{resource_group_name}'.

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --reprovision-policy {reprovision_type} --etag AAAAAAAAAAA=

Aktualisieren Sie die Registrierung '{enrollment_id}' mit einer neuen Zuordnungsrichtlinie im Azure IoT Device Provisioning Service '{dps_name}' in der Ressourcengruppe '{resource_group_name}'.

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy geolatency --etag AAAAAAAAAAA= --iot-hubs "{iot_hub_host_name1} {iot_hub_host_name2} {iot_hub_host_name3}"

Aktualisieren Sie die Registrierung '{enrollment_id}' im Azure IoT-Gerätebereitstellungsdienst '{dps_name}' in der Ressourcengruppe '{resource_group_name}' mit den ursprünglichen Zwillingseigenschaften '{"location":{"region":"USA"}}', ersten Twintags '{"version":"2"}' und Geräteinformationen '{"color":"red"}'.

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version1':'2'}" --device-info "{'color':'red'}"

Erforderliche Parameter

--eid --enrollment-id

Individuelle Geräteregistrierungs-ID.

Optionale Parameter

--allocation-policy --ap

Typ der Zuordnungsrichtlinie, um zu bestimmen, wie ein Gerät einem IoT Hub zugewiesen wird. Falls nicht angegeben, ist die Zuordnungsrichtlinie der aktuelle Standard für die Zuordnungsrichtlinie für die Device Provisioning Service-Instanz.

Zulässige Werte: custom, geoLatency, hashed, static
--api-version --av

Die API-Version der Bereitstellungsdiensttypen, die in der benutzerdefinierten Zuordnungsanforderung gesendet werden. Mindest unterstützte Version: 2018-09-01-preview.

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Sie können die Standardeinstellung mithilfe von az configure --defaults iotdps-data-auth-type=<auth-type-value>.

Zulässige Werte: key, login
Standardwert: key
--certificate-path --cp

Der Pfad zur Datei, die das primäre Zertifikat enthält.

--device-id -d

Geräte-ID, die im IoT Hub registriert ist.

--device-information --info

Optionale Geräteinformationen.

--dps-name -n

Name des Azure IoT Hub Gerätebereitstellungsdiensts. Erforderlich, wenn die Anmeldung nicht angegeben wird.

--edge-enabled --ee

Kennzeichen, das die Randaktivierung angibt.

Zulässige Werte: false, true
--ek --endorsement-key

TPM-Bestätigungsschlüssel für ein TPM-Gerät.

--etag -e

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

--hn --iot-hub-host-name

Hostname des Ziel-IoT Hub. Die Zuordnungsrichtlinie ist standardmäßig statisch, wenn dieser Parameter bereitgestellt wird.

--ih --iot-hubs

Hostname des Ziels IoT Hub, das der Zuordnungsrichtlinie zugeordnet ist. Verwenden Sie leertrennte Liste für mehrere IoT Hubs.

--initial-twin-properties --props

Anfängliche Geräte-Twin-Eigenschaften.

--initial-twin-tags --tags

Erste Geräte-Twin-Tags.

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen einer Aktion. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --dps-name nicht angegeben wird.

--pk --primary-key

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

--provisioning-status --ps

Aktivieren oder deaktivieren Sie den Registrierungseintrag.

Zulässige Werte: disabled, enabled
--rc --remove-certificate

Kennzeichnen, um das aktuelle primäre Zertifikat zu entfernen.

Zulässige Werte: false, true
--remove-secondary-certificate --rsc

Kennzeichnen, um das aktuelle sekundäre Zertifikat zu entfernen.

Zulässige Werte: false, true
--reprovision-policy --rp

Richtlinie, um zu bestimmen, wie Gerätedaten bei der erneuten Bereitstellung für eine andere IoT Hub behandelt werden sollen.

Zulässige Werte: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

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

--scp --secondary-certificate-path

Der Pfad zur Datei, die das sekundäre Zertifikat enthält.

--secondary-key --sk

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

--webhook-url --wh

Die Azure Function-Webhook-URL, die für benutzerdefinierte Zuordnungsanforderungen verwendet wird.