az iot dps enrollment

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 dps-Registrierung Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Verwalten der Geräteregistrierungen im Azure IoT Hub Device Provisioning Service.

Befehle

Name	Beschreibung	Typ	Status
az iot dps enrollment create	Erstellen Sie eine einzelne Geräteregistrierung in einem Azure IoT Hub Device Provisioning Service.	Extension	GA
az iot dps enrollment delete	Löschen Einer einzelnen Geräteregistrierung in einem Azure IoT Hub Device Provisioning Service.	Extension	GA
az iot dps enrollment list	Auflisten einzelner Geräteregistrierungen in einem Azure IoT Hub Device Provisioning Service.	Extension	GA
az iot dps enrollment registration	Verwalten Sie dienstseitige Geräteregistrierungen für eine einzelne Registrierung in einem Azure IoT Hub Device Provisioning Service.	Extension	GA
az iot dps enrollment registration delete	Löschen Einer Geräteregistrierung für eine einzelne Registrierung in einem Azure IoT Hub Device Provisioning Service.	Extension	GA
az iot dps enrollment registration show	Rufen Sie eine Geräteregistrierung für eine einzelne Registrierung in einem Azure IoT Hub Device Provisioning Service ab.	Extension	GA
az iot dps enrollment show	Abrufen einzelner Geräteregistrierungsdetails in einem Azure IoT Hub Device Provisioning Service.	Extension	GA
az iot dps enrollment update	Aktualisieren einer einzelnen Geräteregistrierung in einem Azure IoT Hub-Gerätebereitstellungsdienst.	Extension	GA

az iot dps enrollment create

Erstellen Sie eine einzelne Geräteregistrierung in einem Azure IoT Hub Device Provisioning Service.

Geben Sie das Zertifikatformat mithilfe der Base64 ASCII-Codierung an, und das Zertifikat sollte über übereinstimmende BEGIN- und END-Segmente verfügen, z. B. mit "-----BEGIN CERTIFICATE-----" beginnen und mit "-----END CERTIFICATE-----" enden.

az iot dps enrollment create --at --attestation-type {symmetricKey, tpm, x509}
                             --eid --enrollment-id
                             [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                             [--api-version --av]
                             [--auth-type {key, login}]
                             [--certificate-path --cp]
                             [--cpn --credential-policy-name]
                             [--device-id]
                             [--device-information --info]
                             [--dps-name]
                             [--edge-enabled --ee {false, true}]
                             [--ek --endorsement-key]
                             [--ih --iot-hubs]
                             [--initial-twin-properties --props]
                             [--initial-twin-tags --tags]
                             [--login]
                             [--pk --primary-key]
                             [--provisioning-status --ps {disabled, enabled}]
                             [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp --secondary-certificate-path]
                             [--secondary-key --sk]
                             [--webhook-url --wh]

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}', anfängliche Zwillingseigenschaften '{"location":{"region":"US"}}', anfängliche 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-information "{'color':'red'}" --device-id {device_id}

Erstellen Sie eine Registrierung "MyEnrollment" mit dem 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}

Erstellen Sie eine Registrierung mit einer benutzerdefinierten ADR-Namespace-Anmeldeinformationsrichtlinie.

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --credential-policy-name {policy_name}

Erforderliche Parameter

--at --attestation-type

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

Eigenschaft	Wert
Parametergruppe:	Authentication Arguments
Zulässige Werte:	symmetricKey, tpm, x509

--eid --enrollment-id

Individuelle Geräteregistrierungs-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.

--allocation-policy --ap

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

Eigenschaft	Wert
Parametergruppe:	Allocation Policy Arguments
Zulässige Werte:	custom, geoLatency, hashed, static

--api-version --av

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

Eigenschaft	Wert
Parametergruppe:	Allocation Policy Arguments

--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 iotdps-data-auth-type={auth-type-value}.

Eigenschaft	Wert
Parametergruppe:	Access Control Arguments
Standardwert:	key
Zulässige Werte:	key, login

--certificate-path --cp

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

Eigenschaft	Wert
Parametergruppe:	Authentication Arguments

--cpn --credential-policy-name

Name der ADR-Namespace-Anmeldeinformationsrichtlinie.

Eigenschaft	Wert
Parametergruppe:	ADR Credential Policy Arguments

--device-id -d

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

--device-information --info

Optionale Geräteinformationen.

--dps-name -n

Name oder Hostname des Azure IoT Hub Device Provisioning Service. Erforderlich, wenn --login nicht angegeben wird.

Eigenschaft	Wert
Parametergruppe:	Device Provisioning Service Identifier Arguments

--edge-enabled --ee

Flag, das die Randaktivierung angibt.

Eigenschaft	Wert
Standardwert:	False
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.

Eigenschaft	Wert
Parametergruppe:	Authentication Arguments

--ih --iot-hubs

Hostname des IoT Hub-Ziels, das der Zuordnungsrichtlinie zugeordnet ist. Verwenden Sie eine durch Leerzeichen getrennte Liste für mehrere IoT Hubs.

Eigenschaft	Wert
Parametergruppe:	Allocation Policy Arguments

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

Eigenschaft	Wert
Parametergruppe:	Device Provisioning Service Identifier Arguments

--pk --primary-key

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

Eigenschaft	Wert
Parametergruppe:	Authentication Arguments

--provisioning-status --ps

Aktivieren oder Deaktivieren des Registrierungseintrags.

Eigenschaft	Wert
Zulässige Werte:	disabled, enabled

--reprovision-policy --rp

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

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

Eigenschaft	Wert
Parametergruppe:	Authentication Arguments

--secondary-key --sk

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

Eigenschaft	Wert
Parametergruppe:	Authentication Arguments

--webhook-url --wh

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

Eigenschaft	Wert
Parametergruppe:	Allocation Policy Arguments

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

az iot dps enrollment delete

Löschen Einer einzelnen Geräteregistrierung in einem Azure IoT Hub Device Provisioning Service.

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

Erforderliche Parameter

--eid --enrollment-id

Individuelle Geräteregistrierungs-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 iotdps-data-auth-type={auth-type-value}.

Eigenschaft	Wert
Parametergruppe:	Access Control Arguments
Standardwert:	key
Zulässige Werte:	key, login

--dps-name -n

Name oder Hostname des Azure IoT Hub Device Provisioning Service. Erforderlich, wenn --login nicht angegeben wird.

Eigenschaft	Wert
Parametergruppe:	Device Provisioning Service Identifier Arguments

--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 --dps-name nicht angegeben wird.

Eigenschaft	Wert
Parametergruppe:	Device Provisioning Service Identifier Arguments

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

az iot dps enrollment list

Auflisten einzelner Geräteregistrierungen in einem Azure IoT Hub Device Provisioning Service.

az iot dps enrollment list [--auth-type {key, login}]
                           [--dps-name]
                           [--login]
                           [--resource-group]
                           [--top]

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 iotdps-data-auth-type={auth-type-value}.

Eigenschaft	Wert
Parametergruppe:	Access Control Arguments
Standardwert:	key
Zulässige Werte:	key, login

--dps-name -n

Name oder Hostname des Azure IoT Hub Device Provisioning Service. Erforderlich, wenn --login nicht angegeben wird.

Eigenschaft	Wert
Parametergruppe:	Device Provisioning Service 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 --dps-name nicht angegeben wird.

Eigenschaft	Wert
Parametergruppe:	Device Provisioning Service Identifier Arguments

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

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

az iot dps enrollment show

Abrufen einzelner Geräteregistrierungsdetails in einem Azure IoT Hub Device Provisioning Service.

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

Beispiele

Grundlegende Nutzung

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

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 iotdps-data-auth-type={auth-type-value}.

Eigenschaft	Wert
Parametergruppe:	Access Control Arguments
Standardwert:	key
Zulässige Werte:	key, login

--dps-name -n

Name oder Hostname des Azure IoT Hub Device Provisioning Service. Erforderlich, wenn --login nicht angegeben wird.

Eigenschaft	Wert
Parametergruppe:	Device Provisioning Service Identifier Arguments

--keys --show-keys

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

Eigenschaft	Wert
Zulässige Werte:	false, true

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

Eigenschaft	Wert
Parametergruppe:	Device Provisioning Service Identifier Arguments

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

az iot dps enrollment update

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

Geben Sie das Zertifikatformat mithilfe der Base64 ASCII-Codierung an, und das Zertifikat sollte über übereinstimmende BEGIN- und END-Segmente verfügen, z. B. mit "-----BEGIN CERTIFICATE-----" beginnen und mit "-----END CERTIFICATE-----" enden.

az iot dps enrollment update --eid --enrollment-id
                             [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                             [--api-version --av]
                             [--auth-type {key, login}]
                             [--certificate-path --cp]
                             [--cpn --credential-policy-name]
                             [--device-id]
                             [--device-information --info]
                             [--dps-name]
                             [--edge-enabled --ee {false, true}]
                             [--ek --endorsement-key]
                             [--etag]
                             [--ih --iot-hubs]
                             [--initial-twin-properties --props]
                             [--initial-twin-tags --tags]
                             [--login]
                             [--pk --primary-key]
                             [--provisioning-status --ps {disabled, enabled}]
                             [--rc --remove-certificate {false, true}]
                             [--remove-secondary-certificate --rsc {false, true}]
                             [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp --secondary-certificate-path]
                             [--secondary-key --sk]
                             [--webhook-url --wh]

Beispiele

Aktualisieren Sie die Registrierung "{enrollment_id}" mit einem neuen x509-Zertifikat 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} --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 Bereitstellungstyp 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} --reprovision-policy {reprovision_type} --etag AAAAAAAAAAA=

Aktualisieren Sie die Registrierung "{enrollment_id}" mit einer neuen Zuordnungsrichtlinie 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} --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 anfänglichen Zwillingseigenschaften '{"location":{"region":"USA"}}', den anfänglichen Twintags '{"version":"2"}' und den 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-information "{'color':'red'}"

Aktualisieren Sie die Registrierung "{enrollment_id}" im Azure IoT-Gerätebereitstellungsdienst "{dps_name}", um eine benutzerdefinierte ADR-Namespace-Anmeldeinformationsrichtlinie zu verwenden.

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --credential-policy-name {my_policy}

Erforderliche Parameter

--eid --enrollment-id

Individuelle Geräteregistrierungs-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.

--allocation-policy --ap

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

Eigenschaft	Wert
Parametergruppe:	Allocation Policy Arguments
Zulässige Werte:	custom, geoLatency, hashed, static

--api-version --av

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

Eigenschaft	Wert
Parametergruppe:	Allocation Policy Arguments

--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 iotdps-data-auth-type={auth-type-value}.

Eigenschaft	Wert
Parametergruppe:	Access Control Arguments
Standardwert:	key
Zulässige Werte:	key, login

--certificate-path --cp

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

Eigenschaft	Wert
Parametergruppe:	Authentication Arguments

--cpn --credential-policy-name

Name der ADR-Namespace-Anmeldeinformationsrichtlinie.

Eigenschaft	Wert
Parametergruppe:	ADR Credential Policy Arguments

--device-id -d

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

--device-information --info

Optionale Geräteinformationen.

--dps-name -n

Name oder Hostname des Azure IoT Hub Device Provisioning Service. Erforderlich, wenn --login nicht angegeben wird.

Eigenschaft	Wert
Parametergruppe:	Device Provisioning Service Identifier Arguments

--edge-enabled --ee

Flag, das die Randaktivierung angibt.

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

--ih --iot-hubs

Hostname des IoT Hub-Ziels, das der Zuordnungsrichtlinie zugeordnet ist. Verwenden Sie eine durch Leerzeichen getrennte Liste für mehrere IoT Hubs.

Eigenschaft	Wert
Parametergruppe:	Allocation Policy Arguments

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

Eigenschaft	Wert
Parametergruppe:	Device Provisioning Service Identifier Arguments

--pk --primary-key

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

Eigenschaft	Wert
Parametergruppe:	Authentication Arguments

--provisioning-status --ps

Aktivieren oder Deaktivieren des Registrierungseintrags.

Eigenschaft	Wert
Zulässige Werte:	disabled, enabled

--rc --remove-certificate

Flag zum Entfernen des aktuellen primären Zertifikats.

Eigenschaft	Wert
Parametergruppe:	Authentication Arguments
Zulässige Werte:	false, true

--remove-secondary-certificate --rsc

Flag zum Entfernen des aktuellen sekundären Zertifikats.

Eigenschaft	Wert
Parametergruppe:	Authentication Arguments
Zulässige Werte:	false, true

--reprovision-policy --rp

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

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

Eigenschaft	Wert
Parametergruppe:	Authentication Arguments

--secondary-key --sk

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

Eigenschaft	Wert
Parametergruppe:	Authentication Arguments

--webhook-url --wh

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

Eigenschaft	Wert
Parametergruppe:	Allocation Policy Arguments

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