az iot dps enrollment

Hinweis

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

Verwalten sie einzelne Geräteregistrierungen in einem Azure IoT Hub-Gerätebereitstellungsdienst.

Befehle

Name	Beschreibung	Typ	Status
az iot dps enrollment create	Erstellen Sie eine einzelne Geräteregistrierung in einem Azure IoT Hub Device Provisioning Service.	Durchwahl	Allgemein verfügbar
az iot dps enrollment delete	Löschen Einer einzelnen Geräteregistrierung in einem Azure IoT Hub Device Provisioning Service.	Durchwahl	Allgemein verfügbar
az iot dps enrollment list	Auflisten einzelner Geräteregistrierungen in einem Azure IoT Hub Device Provisioning Service.	Durchwahl	Allgemein verfügbar
az iot dps enrollment registration	Verwalten Sie dienstseitige Geräteregistrierungen für eine einzelne Registrierung in einem Azure IoT Hub Device Provisioning Service.	Durchwahl	Allgemein verfügbar
az iot dps enrollment registration delete	Löschen Einer Geräteregistrierung für eine einzelne Registrierung in einem Azure IoT Hub Device Provisioning Service.	Durchwahl	Allgemein verfügbar
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.	Durchwahl	Allgemein verfügbar
az iot dps enrollment show	Abrufen einzelner Geräteregistrierungsdetails in einem Azure IoT Hub Device Provisioning Service.	Durchwahl	Allgemein verfügbar
az iot dps enrollment update	Aktualisieren einer einzelnen Geräteregistrierung in einem Azure IoT Hub-Gerätebereitstellungsdienst.	Durchwahl	Allgemein verfügbar

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 {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]
                             [--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}', 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-info "{'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}

Erforderliche Parameter

--at --attestation-type

Nachweismechanismus, der für die Authentifizierung beim 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. Wenn nicht angegeben, ist die Zuweisungsrichtlinie die aktuelle Standardeinstellung 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. Mindestens 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. 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>.

Zulässige Werte: key, login

Standardwert: key

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

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

--edge-enabled --ee

Flag, das die Randaktivierung angibt.

Zulässige Werte: false, true

Standardwert: False

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

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

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

--pk --primary-key

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

--provisioning-status --ps

Aktivieren oder Deaktivieren des Registrierungseintrags.

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.

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 gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.

--webhook-url --wh

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

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 dps enrollment delete

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

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

Zulässige Werte: key, login

Standardwert: key

--dps-name -n

Name oder Hostname des Azure IoT Hub Device Provisioning Service. Erforderlich, wenn --login 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ä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.

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

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

Zulässige Werte: key, login

Standardwert: key

--dps-name -n

Name oder Hostname des Azure IoT Hub Device Provisioning Service. 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 --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.

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 dps enrollment show

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

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

Zulässige Werte: key, login

Standardwert: key

--dps-name -n

Name oder Hostname des Azure IoT Hub Device Provisioning Service. Erforderlich, wenn --login 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ä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.

--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 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
                             [--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]
                             [--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-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-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. Wenn nicht angegeben, ist die Zuweisungsrichtlinie die aktuelle Standardeinstellung 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. Mindestens 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. 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>.

Zulässige Werte: key, login

Standardwert: key

--certificate-path --cp

Der Pfad zu der 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 oder Hostname des Azure IoT Hub Device Provisioning Service. Erforderlich, wenn --login nicht angegeben wird.

--edge-enabled --ee

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

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

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

--pk --primary-key

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

--provisioning-status --ps

Aktivieren oder Deaktivieren des Registrierungseintrags.

Zulässige Werte: disabled, enabled

--rc --remove-certificate

Flag zum Entfernen des aktuellen primären Zertifikats.

Zulässige Werte: false, true

--remove-secondary-certificate --rsc

Flag zum Entfernen des aktuellen sekundären Zertifikats.

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.

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 gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.

--webhook-url --wh

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

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.