az iot dps enrollment-group
Note
Diese Referenz ist Teil der erweiterung azure-iot für die Azure CLI (Version 2.70.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie ein az iot dps enrollment-group Befehl ausführen. Erfahren Sie mehr über Erweiterungen.
Verwalten von Registrierungsgruppen in einem Azure IoT Hub Gerätebereitstellungsdienst.
Befehle
| Name | Beschreibung | Typ | Status |
|---|---|---|---|
| az iot dps enrollment-group compute-device-key |
Generieren Sie einen abgeleiteten Geräte-SAS-Schlüssel für eine Registrierungsgruppe in einem Azure IoT Hub Gerätebereitstellungsdienst. |
Extension | GA |
| az iot dps enrollment-group create |
Erstellen Sie eine Registrierungsgruppe in einem Azure IoT Hub Gerätebereitstellungsdienst. |
Extension | GA |
| az iot dps enrollment-group delete |
Löschen Einer Registrierungsgruppe in einem Azure IoT Hub Gerätebereitstellungsdienst. |
Extension | GA |
| az iot dps enrollment-group list |
Auflisten von Registrierungsgruppen in einem Azure IoT Hub Gerätebereitstellungsdienst. |
Extension | GA |
| az iot dps enrollment-group registration |
Verwalten sie dienstseitige Geräteregistrierungen für eine Registrierungsgruppe in einem Azure IoT Hub Gerätebereitstellungsdienst. |
Extension | GA |
| az iot dps enrollment-group registration delete |
Löschen Einer Geräteregistrierung für eine Registrierungsgruppe in einem Azure IoT Hub Gerätebereitstellungsdienst. |
Extension | GA |
| az iot dps enrollment-group registration list |
Auflisten von Geräteregistrierungen für eine Registrierungsgruppe in einem Azure IoT Hub Gerätebereitstellungsdienst. |
Extension | GA |
| az iot dps enrollment-group registration show |
Rufen Sie eine Geräteregistrierung für eine Registrierungsgruppe in einem Azure IoT Hub Gerätebereitstellungsdienst ab. |
Extension | GA |
| az iot dps enrollment-group show |
Rufen Sie die Details einer Registrierungsgruppe in einem Azure IoT Hub Gerätebereitstellungsdienst ab. |
Extension | GA |
| az iot dps enrollment-group update |
Aktualisieren einer Registrierungsgruppe in einem Azure IoT Hub Gerätebereitstellungsdienst. |
Extension | GA |
az iot dps enrollment-group compute-device-key
Generieren Sie einen abgeleiteten Geräte-SAS-Schlüssel für eine Registrierungsgruppe in einem Azure IoT Hub Gerätebereitstellungsdienst.
az iot dps enrollment-group compute-device-key --registration-id --rid
[--acquire-policy-token]
[--auth-type {key, login}]
[--change-reference]
[--dps-name]
[--eid --enrollment-id --gid --group-id]
[--key --symmetric-key]
[--login]
[--resource-group]
Beispiele
Berechnen Sie den Geräteschlüssel mit dem angegebenen symmetrischen Schlüssel.
az iot dps enrollment-group compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}
Berechnen Sie den Geräteschlüssel mit der angegebenen Registrierungsgruppe.
az iot dps enrollment-group compute-device-key -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --registration-id {registration_id}
Erforderliche Parameter
ID der Geräteregistrierung.
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.
Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
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 |
Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
Name oder Hostname des Azure IoT Hub Gerätebereitstellungsdiensts. Erforderlich, wenn --login nicht angegeben wird.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Device Provisioning Service Identifier Arguments |
Registrierungsgruppen-ID.
Der symmetrische gemeinsam genutzte Zugriffsschlüssel für die Registrierungsgruppe. Dadurch wird die Registrierung des Gerätebereitstellungsdiensts umgangen und das SAS-Token direkt aus dem bereitgestellten symmetrischen Schlüssel ohne weitere Überprüfung generiert. Alle anderen Befehlsparameter werden außer der Registrierungs-ID ignoriert.
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 |
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
az iot dps enrollment-group create
Erstellen Sie eine Registrierungsgruppe 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-group create --eid --enrollment-id --gid --group-id
[--acquire-policy-token]
[--allocation-policy --ap {custom, geoLatency, hashed, static}]
[--api-version --av]
[--auth-type {key, login}]
[--ca-name --cn --root-ca-name]
[--certificate-path --cp]
[--change-reference]
[--cpn --credential-policy-name]
[--dps-name]
[--edge-enabled --ee {false, true}]
[--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]
[--scn --secondary-ca-name --secondary-root-ca-name]
[--scp --secondary-certificate-path]
[--secondary-key --sk]
[--webhook-url --wh]
Beispiele
Erstellen Sie eine Registrierungsgruppe "{enrollment_id}" im Azure IoT Bereitstellungsdienst "{dps_name}" in der Ressourcengruppe "{resource_group_name}" mithilfe eines Zwischenzertifikats als primäres Zertifikat.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem
Erstellen Sie eine Registrierungsgruppe "{enrollment_id}" im Azure IoT Bereitstellungsdienst "{dps_name}" in der Ressourcengruppe "{resource_group_name}" mithilfe eines Zertifizierungsstellenzertifikats {certificate_name} als sekundäres Zertifikat".
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name}
Erstellen Sie eine Registrierungsgruppe '{enrollment_id}' im Azure IoT Bereitstellungsdienst 'MyDps' in der Ressourcengruppe '{resource_group_name}' mit dem Bereitstellungsstatus 'enabled', den anfänglichen Zwillingseigenschaften '{"location":{"region":"US"}}' und den anfänglichen Twintags '{"version_dps":"1"}' mithilfe eines Zwischenzertifikats als primäres Zertifikat.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem --provisioning-status enabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version_dps':'1'}"
Erstellen Sie eine Registrierungsgruppe "{enrollment_id}" im Azure IoT Bereitstellungsdienst "{dps_name}" in der Ressourcengruppe "{resource_group_name}" mit dem Nachweistyp "symmetrisch".
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {primary_key} --secondary-key {secondary_key}
Erstellen sie eine Registrierungsgruppe "{enrollment_id}" mit benutzerdefinierter Zuordnungsrichtlinie,
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}
Erstellen Sie eine Registrierungsgruppe mit einer benutzerdefinierten Geräteregistrierungsnamespace-Anmeldeinformationsrichtlinie.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy hashed --credential-policy-name {policy_name}
Erforderliche Parameter
Registrierungsgruppen-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.
Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
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 |
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 |
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 |
Der Name des primären Stammzertifizierungsstellenzertifikats. Wenn der Nachweis mit einem Stammzertifizierungsstellenzertifikat gewünscht wird, muss ein Name der Stammzertifizierungsstelle angegeben werden.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
Der Pfad zu der Datei, die das primäre Zertifikat enthält. Wenn der Nachweis mit einem Zwischenzertifikat gewünscht wird, muss ein Zertifikatpfad angegeben werden.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
Name der ADR-Namespace-Anmeldeinformationsrichtlinie.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | ADR Credential Policy Arguments |
Name oder Hostname des Azure IoT Hub Gerätebereitstellungsdiensts. Erforderlich, wenn --login nicht angegeben wird.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Device Provisioning Service Identifier Arguments |
Flag, das die Randaktivierung angibt.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
| Zulässige Werte: | false, true |
Hostname des Ziels IoT Hub der Zuordnungsrichtlinie zugeordnet. Verwenden Sie eine durch Leerzeichen getrennte Liste für mehrere IoT Hubs.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Allocation Policy Arguments |
Anfängliche Geräte-Twin-Eigenschaften.
Erste Geräte-Twin-Tags.
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 |
Der primäre symmetrische gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
Aktivieren oder Deaktivieren des Registrierungseintrags.
| Eigenschaft | Wert |
|---|---|
| Zulässige Werte: | disabled, enabled |
Richtlinie, um zu bestimmen, wie Gerätedaten bei der erneuten Bereitstellung auf einem anderen IoT Hub behandelt werden sollen.
| Eigenschaft | Wert |
|---|---|
| Zulässige Werte: | never, reprovisionandmigratedata, reprovisionandresetdata |
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
Der Name des sekundären Stammzertifizierungsstellenzertifikats. Wenn der Nachweis mit einem Stammzertifizierungsstellenzertifikat gewünscht wird, muss ein Name der Stammzertifizierungsstelle angegeben werden.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
Der Pfad zur Datei, die das sekundäre Zertifikat enthält. Wenn der Nachweis mit einem Zwischenzertifikat gewünscht wird, muss ein Zertifikatpfad angegeben werden.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
Der sekundäre symmetrische gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
Die Azure Webhook-URL der Funktion, die für benutzerdefinierte Zuordnungsanforderungen verwendet wird.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Allocation Policy Arguments |
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
az iot dps enrollment-group delete
Löschen Einer Registrierungsgruppe in einem Azure IoT Hub Gerätebereitstellungsdienst.
az iot dps enrollment-group delete --eid --enrollment-id --gid --group-id
[--acquire-policy-token]
[--auth-type {key, login}]
[--change-reference]
[--dps-name]
[--etag]
[--login]
[--resource-group]
Erforderliche Parameter
Registrierungsgruppen-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.
Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
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 |
Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
Name oder Hostname des Azure IoT Hub Gerätebereitstellungsdiensts. Erforderlich, wenn --login nicht angegeben wird.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Device Provisioning Service Identifier Arguments |
Etag oder Entitätstag, das dem letzten Status der Ressource entspricht. Wenn kein Etag angegeben wird, wird der Wert '*' verwendet.
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 |
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
az iot dps enrollment-group list
Auflisten von Registrierungsgruppen in einem Azure IoT Hub Gerätebereitstellungsdienst.
az iot dps enrollment-group 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.
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 |
Name oder Hostname des Azure IoT Hub Gerätebereitstellungsdiensts. Erforderlich, wenn --login nicht angegeben wird.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Device Provisioning Service Identifier Arguments |
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 |
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
Maximale Anzahl der zurückzugebenden Elemente. Verwenden Sie -1 für unbegrenzt.
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
az iot dps enrollment-group show
Rufen Sie die Details einer Registrierungsgruppe in einem Azure IoT Hub Gerätebereitstellungsdienst ab.
az iot dps enrollment-group show --eid --enrollment-id --gid --group-id
[--auth-type {key, login}]
[--dps-name]
[--keys --show-keys {false, true}]
[--login]
[--resource-group]
Beispiele
Grundlegende Nutzung
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Vollständige Nachweisinformationen in Ergebnisse für eine symmetrische Schlüsselregistrierungsgruppe einschließen
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
Erforderliche Parameter
Registrierungsgruppen-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.
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 |
Name oder Hostname des Azure IoT Hub Gerätebereitstellungsdiensts. Erforderlich, wenn --login nicht angegeben wird.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Device Provisioning Service Identifier Arguments |
Schließen Sie Nachweisschlüssel und Informationen in die Ergebnisse der Registrierungsgruppe ein.
| Eigenschaft | Wert |
|---|---|
| Zulässige Werte: | false, true |
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 |
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
az iot dps enrollment-group update
Aktualisieren einer Registrierungsgruppe 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-group update --eid --enrollment-id --gid --group-id
[--acquire-policy-token]
[--allocation-policy --ap {custom, geoLatency, hashed, static}]
[--api-version --av]
[--auth-type {key, login}]
[--ca-name --cn --root-ca-name]
[--certificate-path --cp]
[--change-reference]
[--cpn --credential-policy-name]
[--dps-name]
[--edge-enabled --ee {false, true}]
[--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]
[--scn --secondary-ca-name --secondary-root-ca-name]
[--scp --secondary-certificate-path]
[--secondary-key --sk]
[--webhook-url --wh]
Beispiele
Aktualisieren Sie die Registrierungsgruppe "{enrollment_id}" im Azure IoT Bereitstellungsdienst "{dps_name}" in der Ressourcengruppe "{resource_group_name}" mit anfänglichen Twin-Eigenschaften und anfänglichen Twin-Tags.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version_dps':'2'}" --etag AAAAAAAAAAA=
Aktualisieren Sie die Registrierungsgruppe '{enrollment_id}' im Azure IoT Bereitstellungsdienst '{dps_name}' in der Ressourcengruppe '{resource_group_name}' mit neuem primären Zwischenzertifikat, und entfernen Sie vorhandenes sekundäres Zwischenzertifikat.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --remove-secondary-certificate --etag AAAAAAAAAAA=
Aktualisieren Sie die Registrierungsgruppe "{enrollment_id}" im Azure IoT Bereitstellungsdienst "{dps_name}" in der Ressourcengruppe "{resource_group_name}" mit dem neuen sekundären Zertifizierungsstellenzertifikat "{certificate_name}", und entfernen Sie das vorhandene primäre Zertifizierungsstellenzertifikat.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name} --remove-certificate --etag AAAAAAAAAAA=
Aktualisieren Sie die Registrierungsgruppe '{enrollment_id}' im Azure IoT Bereitstellungsdienst '{dps_name}' in der Ressourcengruppe '{resource_group_name}' mit neuem Primärschlüssel.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=
Aktualisieren Sie die Registrierungsgruppe "{enrollment_id}" im Azure IoT Gerätebereitstellungsdienst "{dps_name}", um eine benutzerdefinierte ADR-Namespace-Anmeldeinformationsrichtlinie zu verwenden.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --credential-policy-name {my_policy}
Erforderliche Parameter
Registrierungsgruppen-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.
Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
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 |
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 |
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 |
Der Name des primären Stammzertifizierungsstellenzertifikats. Wenn der Nachweis mit einem Stammzertifizierungsstellenzertifikat gewünscht wird, muss ein Name der Stammzertifizierungsstelle angegeben werden.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
Der Pfad zu der Datei, die das primäre Zertifikat enthält. Wenn der Nachweis mit einem Zwischenzertifikat gewünscht wird, muss ein Zertifikatpfad angegeben werden.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
Name der ADR-Namespace-Anmeldeinformationsrichtlinie.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | ADR Credential Policy Arguments |
Name oder Hostname des Azure IoT Hub Gerätebereitstellungsdiensts. Erforderlich, wenn --login nicht angegeben wird.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Device Provisioning Service Identifier Arguments |
Flag, das die Randaktivierung angibt.
| Eigenschaft | Wert |
|---|---|
| Zulässige Werte: | false, true |
Etag oder Entitätstag, das dem letzten Status der Ressource entspricht. Wenn kein Etag angegeben wird, wird der Wert '*' verwendet.
Hostname des Ziels IoT Hub der Zuordnungsrichtlinie zugeordnet. Verwenden Sie eine durch Leerzeichen getrennte Liste für mehrere IoT Hubs.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Allocation Policy Arguments |
Anfängliche Geräte-Twin-Eigenschaften.
Erste Geräte-Twin-Tags.
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 |
Der primäre symmetrische gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
Aktivieren oder Deaktivieren des Registrierungseintrags.
| Eigenschaft | Wert |
|---|---|
| Zulässige Werte: | disabled, enabled |
Flag zum Entfernen des aktuellen primären Zertifikats.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
| Zulässige Werte: | false, true |
Flag zum Entfernen des aktuellen sekundären Zertifikats.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
| Zulässige Werte: | false, true |
Richtlinie, um zu bestimmen, wie Gerätedaten bei der erneuten Bereitstellung auf einem anderen IoT Hub behandelt werden sollen.
| Eigenschaft | Wert |
|---|---|
| Zulässige Werte: | never, reprovisionandmigratedata, reprovisionandresetdata |
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
Der Name des sekundären Stammzertifizierungsstellenzertifikats. Wenn der Nachweis mit einem Stammzertifizierungsstellenzertifikat gewünscht wird, muss ein Name der Stammzertifizierungsstelle angegeben werden.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
Der Pfad zur Datei, die das sekundäre Zertifikat enthält. Wenn der Nachweis mit einem Zwischenzertifikat gewünscht wird, muss ein Zertifikatpfad angegeben werden.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
Der sekundäre symmetrische gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Authentication Arguments |
Die Azure Webhook-URL der Funktion, die für benutzerdefinierte Zuordnungsanforderungen verwendet wird.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Allocation Policy Arguments |
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |