az iot central enrollment-group

Notitie

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.37.0 of hoger). De extensie installeert automatisch de eerste keer dat u een opdracht az iot central enrollment-group uitvoert. Meer informatie over extensies.

IoT Central-inschrijvingsgroep beheren en configureren.

Opdracht

Name Description Type Status
az iot central enrollment-group create

Maak een inschrijvingsgroep.

Toestel GA
az iot central enrollment-group delete

Verwijder een inschrijvingsgroep op id.

Toestel GA
az iot central enrollment-group generate-verification-code

Genereer een verificatiecode voor het primaire of secundaire x509-certificaat van een inschrijvingsgroep.

Toestel GA
az iot central enrollment-group list

Haal de lijst met inschrijvingsgroepen in een toepassing op.

Toestel GA
az iot central enrollment-group show

Meer informatie over een inschrijvingsgroep op id.

Toestel GA
az iot central enrollment-group update

Een inschrijvingsgroep bijwerken.

Toestel GA
az iot central enrollment-group verify-certificate

Controleer het primaire of secundaire x509-certificaat van een inschrijvingsgroep.

Toestel GA

az iot central enrollment-group create

Maak een inschrijvingsgroep.

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]

Voorbeelden

Een inschrijvingsgroep maken

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at {attestation} --display-name {displayName} --type {type}

Een inschrijvingsgroep maken met x509-primaire certificering

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'x509' --display-name {displayName} --type {type} --cp {primayCertPath}

Een inschrijvingsgroep maken met een opgegeven symmetrische sleutelcertificering

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'symmetricKey' --display-name {displayName} --type {type} --pk {primaryKey} --sk {secondaryKey}

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--at --attestation-type

Het attestation-mechanisme voor de inschrijvingsgroep. Alleen 'x509' of 'symmetricKey' zijn toegestaan. SymmetricKey wordt standaard gebruikt voor attestation.

geaccepteerde waarden: symmetricKey, x509
standaardwaarde: symmetricKey
--display-name

Weergavenaam van de inschrijvingsgroep.

--group-id --id

Unieke id voor de inschrijvingsgroep.

--type

Type apparaten dat verbinding maakt via de groep.

Optionele parameters

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
standaardwaarde: 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

standaardwaarde: azureiotcentral.com
--certificate-path --cp

Het pad naar het bestand met het primaire certificaat.

--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.

--pk --primary-key

De primaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.

--provisioning-status --ps

Of de apparaten die de groep gebruiken, verbinding mogen maken met IoT Central. Waar of Onwaar.

geaccepteerde waarden: disabled, enabled
standaardwaarde: enabled
--scp --secondary-certificate-path

Het pad naar het bestand met het secundaire certificaat.

--secondary-key --sk

De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.

--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central enrollment-group delete

Verwijder een inschrijvingsgroep op id.

az iot central enrollment-group delete --app-id
                                       --group-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

Voorbeelden

Een inschrijvingsgroep op id verwijderen

az iot central enrollment-group delete --app-id {appid} --id {enrollmentGroupId}

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--group-id --id

Unieke id voor de inschrijvingsgroep.

Optionele parameters

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
standaardwaarde: 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

standaardwaarde: azureiotcentral.com
--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central enrollment-group generate-verification-code

Genereer een verificatiecode voor het primaire of secundaire x509-certificaat van een inschrijvingsgroep.

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]

Voorbeelden

Een verificatiecode genereren voor het primaire x509-certificaat van een inschrijvingsgroep

az iot central enrollment-group generate-verification-code --app-id {appid} --id {enrollmentGroupId} --entry 'primary'

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--group-id --id

Unieke id voor de inschrijvingsgroep.

Optionele parameters

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
standaardwaarde: 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

standaardwaarde: azureiotcentral.com
--certificate-entry --entry

Invoertype van het x509-certificaat dat alleen 'primair' en 'secundair' toestaat.

geaccepteerde waarden: primary, secondary
--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central enrollment-group list

Haal de lijst met inschrijvingsgroepen in een toepassing op.

az iot central enrollment-group list --app-id
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--token]

Voorbeelden

De lijst met inschrijvingsgroepen in een toepassing ophalen

az iot central enrollment-group list --app-id {appid}

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

Optionele parameters

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
standaardwaarde: 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

standaardwaarde: azureiotcentral.com
--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central enrollment-group show

Meer informatie over een inschrijvingsgroep op id.

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]

Voorbeelden

Details ophalen over een inschrijvingsgroep op id

az iot central enrollment-group show --app-id {appid} --id {enrollmentGroupId}

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--group-id --id

Unieke id voor de inschrijvingsgroep.

Optionele parameters

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
standaardwaarde: 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

standaardwaarde: azureiotcentral.com
--certificate-entry --entry

Invoertype van het x509-certificaat dat alleen 'primair' en 'secundair' toestaat.

geaccepteerde waarden: primary, secondary
--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central enrollment-group update

Een inschrijvingsgroep bijwerken.

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]

Voorbeelden

Een inschrijvingsgroep bijwerken

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --display-name {displayName} --type {type} --ps {enabled}

Primair x509-certificaat uit een inschrijvingsgroep verwijderen

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --remove-x509 'true' --entry 'primary'

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--group-id --id

Unieke id voor de inschrijvingsgroep.

Optionele parameters

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
standaardwaarde: 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

standaardwaarde: azureiotcentral.com
--certificate-entry --entry

Invoertype van het x509-certificaat dat alleen 'primair' en 'secundair' toestaat.

geaccepteerde waarden: primary, secondary
--certificate-path --cp

Het pad naar het bestand met het primaire certificaat.

--display-name

Weergavenaam van de inschrijvingsgroep.

--etag

ETag die wordt gebruikt om conflicten in updates van inschrijvingsgroepen te voorkomen.

--provisioning-status --ps

Of de apparaten die de groep gebruiken, verbinding mogen maken met IoT Central. Waar of Onwaar.

geaccepteerde waarden: disabled, enabled
standaardwaarde: enabled
--remove-x509

Of het x509-certificaat uit de groep moet worden verwijderd. Waar of Onwaar.

geaccepteerde waarden: false, true
--scp --secondary-certificate-path

Het pad naar het bestand met het secundaire certificaat.

--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

--type

Type apparaten dat verbinding maakt via de groep.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central enrollment-group verify-certificate

Controleer het primaire of secundaire x509-certificaat van een inschrijvingsgroep.

Controleer het primaire of secundaire x509-certificaat van een inschrijvingsgroep door een certificaat met de ondertekende verificatiecode op te geven.

Houd er rekening mee dat als een inschrijvingsgroep is gemaakt met een niet-geverifieerd x509-certificaat, een verificatiecertificaat moet worden gemaakt met het niet-geverifieerde x509-certificaat en een verificatiecode voordat u deze opdracht gebruikt. Een verificatiecode kan worden gegenereerd via cli met behulp van de opdracht 'enrollment-group generate-verification-code'. Meer informatie over het maken van verificatiecertificaten met behulp van verificatiecode op 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]

Voorbeelden

Het primaire x509-certificaat van een inschrijvingsgroep controleren

az iot central enrollment-group verify-certificate --app-id {appid} --id {enrollmentGroupId} --cp {primayCertPath}

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--group-id --id

Unieke id voor de inschrijvingsgroep.

Optionele parameters

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
standaardwaarde: 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

standaardwaarde: azureiotcentral.com
--certificate-path --cp

Het pad naar het bestand met het primaire certificaat.

--scp --secondary-certificate-path

Het pad naar het bestand met het secundaire certificaat.

--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.