az iot central enrollment-group
Hinweis
Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.46.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az iot-zentralen Registrierungsgruppenbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen
Verwalten und Konfigurieren der IoT Central-Registrierungsgruppe.
Befehle
Name | Beschreibung | Typ | Status |
---|---|---|---|
az iot central enrollment-group create |
Erstellen einer Registrierungsgruppe |
Erweiterung | Allgemein verfügbar |
az iot central enrollment-group delete |
Löschen Sie eine Registrierungsgruppe nach ID. |
Erweiterung | Allgemein verfügbar |
az iot central enrollment-group generate-verification-code |
Generieren Sie einen Überprüfungscode für das primäre oder sekundäre x509-Zertifikat einer Registrierungsgruppe. |
Erweiterung | Allgemein verfügbar |
az iot central enrollment-group list |
Ruft die Liste der Registrierungsgruppen in einer Anwendung ab. |
Erweiterung | Allgemein verfügbar |
az iot central enrollment-group show |
Rufen Sie Details zu einer Registrierungsgruppe nach ID ab. |
Erweiterung | Allgemein verfügbar |
az iot central enrollment-group update |
Aktualisieren einer Registrierungsgruppe. |
Erweiterung | Allgemein verfügbar |
az iot central enrollment-group verify-certificate |
Überprüfen Sie das primäre oder sekundäre x509-Zertifikat einer Registrierungsgruppe. |
Erweiterung | Allgemein verfügbar |
az iot central enrollment-group create
Erstellen einer Registrierungsgruppe
az iot central enrollment-group create --app-id
--at {symmetricKey, x509}
--display-name
--group-id
--type
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--certificate-path]
[--etag]
[--pk]
[--provisioning-status {disabled, enabled}]
[--scp]
[--secondary-key]
[--token]
Beispiele
Erstellen einer Registrierungsgruppe
az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at {attestation} --display-name {displayName} --type {type}
Erstellen einer Registrierungsgruppe mit der primären x509-Zertifizierung
az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'x509' --display-name {displayName} --type {type} --cp {primayCertPath}
Erstellen einer Registrierungsgruppe mit einer bestimmten symmetrischen Schlüsselzertifizierung
az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'symmetricKey' --display-name {displayName} --type {type} --pk {primaryKey} --sk {secondaryKey}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Der Nachweismechanismus für die Registrierungsgruppe. Es sind nur 'x509' oder 'symmetricKey' zulässig. Standardmäßig wird "symmetricKey" für den Nachweis verwendet.
Anzeigename der Registrierungsgruppe.
Eindeutiger Bezeichner für die Registrierungsgruppe.
Gerätetyp, die über die Gruppe verbunden werden.
Optionale Parameter
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
Der Pfad zu der Datei, die das primäre Zertifikat enthält.
Etag oder Entitätstag, das dem letzten Status der Ressource entspricht. Wenn kein Etag angegeben wird, wird der Wert '*' verwendet.
Der primäre symmetrische gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.
Gibt an, ob die Geräte, die die Gruppe verwenden, eine Verbindung mit IoT Central herstellen dürfen. Richtig oder falsch.
Der Pfad zur Datei, die das sekundäre Zertifikat enthält.
Der sekundäre symmetrische gemeinsam genutzte Zugriffsschlüssel, der im Base64-Format gespeichert ist.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot central enrollment-group delete
Löschen Sie eine Registrierungsgruppe nach ID.
az iot central enrollment-group delete --app-id
--group-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
Beispiele
Löschen einer Registrierungsgruppe nach ID
az iot central enrollment-group delete --app-id {appid} --id {enrollmentGroupId}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Eindeutiger Bezeichner für die Registrierungsgruppe.
Optionale Parameter
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot central enrollment-group generate-verification-code
Generieren Sie einen Überprüfungscode für das primäre oder sekundäre x509-Zertifikat einer Registrierungsgruppe.
az iot central enrollment-group generate-verification-code --app-id
--group-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--certificate-entry {primary, secondary}]
[--token]
Beispiele
Generieren eines Überprüfungscodes für das primäre x509-Zertifikat einer Registrierungsgruppe
az iot central enrollment-group generate-verification-code --app-id {appid} --id {enrollmentGroupId} --entry 'primary'
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Eindeutiger Bezeichner für die Registrierungsgruppe.
Optionale Parameter
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
Eintragstyp des x509-Zertifikats, das nur "primär" und "sekundär" zulässt.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot central enrollment-group list
Ruft die Liste der Registrierungsgruppen in einer Anwendung ab.
az iot central enrollment-group list --app-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
Beispiele
Abrufen der Liste der Registrierungsgruppen in einer Anwendung
az iot central enrollment-group list --app-id {appid}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Optionale Parameter
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot central enrollment-group show
Rufen Sie Details zu einer Registrierungsgruppe nach ID ab.
az iot central enrollment-group show --app-id
--group-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--certificate-entry {primary, secondary}]
[--token]
Beispiele
Abrufen von Details zu einer Registrierungsgruppe nach ID
az iot central enrollment-group show --app-id {appid} --id {enrollmentGroupId}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Eindeutiger Bezeichner für die Registrierungsgruppe.
Optionale Parameter
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
Eintragstyp des x509-Zertifikats, das nur "primär" und "sekundär" zulässt.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot central enrollment-group update
Aktualisieren einer Registrierungsgruppe.
az iot central enrollment-group update --app-id
--group-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--certificate-entry {primary, secondary}]
[--certificate-path]
[--display-name]
[--etag]
[--provisioning-status {disabled, enabled}]
[--remove-x509 {false, true}]
[--scp]
[--token]
[--type]
Beispiele
Aktualisieren einer Registrierungsgruppe
az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --display-name {displayName} --type {type} --ps {enabled}
Entfernen des primären x509-Zertifikats aus einer Registrierungsgruppe
az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --remove-x509 'true' --entry 'primary'
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Eindeutiger Bezeichner für die Registrierungsgruppe.
Optionale Parameter
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
Eintragstyp des x509-Zertifikats, das nur "primär" und "sekundär" zulässt.
Der Pfad zu der Datei, die das primäre Zertifikat enthält.
Anzeigename der Registrierungsgruppe.
ETag, das verwendet wird, um Konflikte bei Registrierungsgruppenaktualisierungen zu verhindern.
Gibt an, ob die Geräte, die die Gruppe verwenden, eine Verbindung mit IoT Central herstellen dürfen. Richtig oder falsch.
Gibt an, ob das x509-Zertifikat aus der Gruppe entfernt werden soll. Richtig oder falsch.
Der Pfad zur Datei, die das sekundäre Zertifikat enthält.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Gerätetyp, die über die Gruppe verbunden werden.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot central enrollment-group verify-certificate
Überprüfen Sie das primäre oder sekundäre x509-Zertifikat einer Registrierungsgruppe.
Überprüfen Sie das primäre oder sekundäre x509-Zertifikat einer Registrierungsgruppe, indem Sie ein Zertifikat mit dem signierten Überprüfungscode angeben.
Wenn eine Registrierungsgruppe mit einem nicht überprüften x509-Zertifikat erstellt wurde, muss ein Überprüfungszertifikat mit dem nicht überprüften x509-Zertifikat und einem Überprüfungscode erstellt werden, bevor Sie diesen Befehl verwenden. Ein Überprüfungscode kann über cli mithilfe des Befehls "enrollment-group generate-verification-code" generiert werden. Weitere Informationen zum Erstellen von Überprüfungszertifikaten mithilfe des Überprüfungscodes finden Sie unter https://learn.microsoft.com/en-us/azure/iot-central/core/how-to-connect-devices-x509.
az iot central enrollment-group verify-certificate --app-id
--group-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--certificate-path]
[--scp]
[--token]
Beispiele
Überprüfen des primären x509-Zertifikats einer Registrierungsgruppe
az iot central enrollment-group verify-certificate --app-id {appid} --id {enrollmentGroupId} --cp {primayCertPath}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Eindeutiger Bezeichner für die Registrierungsgruppe.
Optionale Parameter
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
Der Pfad zu der Datei, die das primäre Zertifikat enthält.
Der Pfad zur Datei, die das sekundäre Zertifikat enthält.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für