az iot dps enrollment-group
Notitie
Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.46.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az iot dps enrollment-group-opdracht uitvoert. Meer informatie over extensies.
Inschrijvingsgroepen beheren in een Azure IoT Hub Device Provisioning Service.
Opdracht
Name | Description | Type | Status |
---|---|---|---|
az iot dps enrollment-group compute-device-key |
Genereer een AFGELEIDE SAS-sleutel voor een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
az iot dps enrollment-group create |
Maak een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
az iot dps enrollment-group delete |
Een inschrijvingsgroep verwijderen in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
az iot dps enrollment-group list |
Registratiegroepen weergeven in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
az iot dps enrollment-group registration |
Apparaatregistraties aan de servicezijde beheren voor een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
az iot dps enrollment-group registration delete |
Verwijder een apparaatregistratie voor een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
az iot dps enrollment-group registration list |
Apparaatregistraties weergeven voor een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
az iot dps enrollment-group registration show |
Haal een apparaatregistratie op voor een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
az iot dps enrollment-group show |
Haal de details van een inschrijvingsgroep op in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
az iot dps enrollment-group update |
Werk een inschrijvingsgroep bij in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
az iot dps enrollment-group compute-device-key
Genereer een AFGELEIDE SAS-sleutel voor een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group compute-device-key --registration-id
[--auth-type {key, login}]
[--dps-name]
[--eid]
[--key]
[--login]
[--resource-group]
Voorbeelden
Bereken de apparaatsleutel met de opgegeven symmetrische sleutel.
az iot dps enrollment-group compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}
Bereken de apparaatsleutel met de opgegeven inschrijvingsgroep.
az iot dps enrollment-group compute-device-key -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --registration-id {registration_id}
Vereiste parameters
Id van apparaatregistratie.
Optionele parameters
Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.
Id van inschrijvingsgroep.
De symmetrische gedeelde toegangssleutel voor de inschrijvingsgroep. Hiermee wordt het Device Provisioning Service-register omzeild en wordt het SAS-token rechtstreeks gegenereerd vanaf de opgegeven symmetrische sleutel zonder verdere validatie. Alle andere opdrachtparameters naast registratie-id worden genegeerd.
Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>
.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID
.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az iot dps enrollment-group create
Maak een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service.
Geef de certificaatindeling op met base64 ASCII-codering en het certificaat moet overeenkomende BEGIN- en END-segmenten hebben, bijvoorbeeld: begin met '-----BEGIN CERTIFICATE-----' en eindig op '-----END CERTIFICATE-----'.
az iot dps enrollment-group create --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--ca-name]
[--certificate-path]
[--dps-name]
[--edge-enabled {false, true}]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scn]
[--scp]
[--secondary-key]
[--webhook-url]
Voorbeelden
Maak een inschrijvingsgroep {enrollment_id} in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met behulp van een tussenliggend certificaat als primair certificaat.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem
Maak een inschrijvingsgroep {enrollment_id} in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met behulp van een CA-certificaat {certificate_name} als secundair certificaat.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name}
Maak een inschrijvingsgroep {enrollment_id} in de Azure IoT-inrichtingsservice 'MyDps' in de resourcegroep {resource_group_name} met de inrichtingsstatus 'ingeschakeld', initiële dubbeleigenschappen {"location":{"region":"US"}} en eerste dubbeltags {"version_dps":"1"} met behulp van een tussenliggend certificaat als primair certificaat.
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'}"
Maak een inschrijvingsgroep {enrollment_id} in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met het attestation-type 'symmetrickey'.
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}
Maak een inschrijvingsgroep {enrollment_id} met aangepast toewijzingsbeleid,
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}
Vereiste parameters
Id van inschrijvingsgroep.
Optionele parameters
Type toewijzingsbeleid om te bepalen hoe een apparaat wordt toegewezen aan een IoT Hub. Als dit niet is opgegeven, is het toewijzingsbeleid de standaardinstelling voor het huidige toewijzingsbeleid dat is ingesteld voor het Device Provisioning Service-exemplaar.
De API-versie van de inrichtingsservicetypen die zijn verzonden in de aangepaste toewijzingsaanvraag. Minimaal ondersteunde versie: 2018-09-01-preview.
Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
De naam van het primaire basis-CA-certificaat. Als attestation met een basis-CA-certificaat gewenst is, moet er een basis-CA-naam worden opgegeven.
Het pad naar het bestand met het primaire certificaat. Als attestation met een tussencertificaat gewenst is, moet er een certificaatpad worden opgegeven.
De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.
Vlag die aangeeft dat edge is ingeschakeld.
Hostnaam van de doel-IoT Hub die is gekoppeld aan het toewijzingsbeleid. Gebruik een door spaties gescheiden lijst voor meerdere IoT Hubs.
Initiële eigenschappen van apparaatdubbels.
Eerste tags voor apparaatdubbels.
Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.
De primaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
Inschrijvingsvermelding in- of uitschakelen.
Beleid om te bepalen hoe apparaatgegevens moeten worden verwerkt bij het opnieuw inrichten van een andere IoT Hub.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>
.
De naam van het secundaire basis-CA-certificaat. Als attestation met een basis-CA-certificaat gewenst is, moet er een basis-CA-naam worden opgegeven.
Het pad naar het bestand met het secundaire certificaat. Als attestation met een tussencertificaat gewenst is, moet er een certificaatpad worden opgegeven.
De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
De url van de Azure Function-webhook die wordt gebruikt voor aangepaste toewijzingsaanvragen.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID
.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az iot dps enrollment-group delete
Een inschrijvingsgroep verwijderen in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group delete --eid
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]
Vereiste parameters
Id van inschrijvingsgroep.
Optionele parameters
Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.
Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>
.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID
.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az iot dps enrollment-group list
Registratiegroepen weergeven in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group list [--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]
[--top]
Optionele parameters
Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.
Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>
.
Maximum aantal elementen dat moet worden geretourneerd. Gebruik -1 voor onbeperkt.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID
.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az iot dps enrollment-group show
Haal de details van een inschrijvingsgroep op in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group show --eid
[--auth-type {key, login}]
[--dps-name]
[--keys {false, true}]
[--login]
[--resource-group]
Voorbeelden
Basaal gebruik
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Volledige attestation-informatie opnemen in resultaten voor een symmetrische sleutelinschrijvingsgroep
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
Vereiste parameters
Id van inschrijvingsgroep.
Optionele parameters
Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.
Attestation-sleutels en -informatie opnemen in de resultaten van de inschrijvingsgroep.
Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>
.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID
.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az iot dps enrollment-group update
Werk een inschrijvingsgroep bij in een Azure IoT Hub Device Provisioning Service.
Geef de certificaatindeling op met base64 ASCII-codering en het certificaat moet overeenkomende BEGIN- en END-segmenten hebben, bijvoorbeeld: begin met '-----BEGIN CERTIFICATE-----' en eindig op '-----END CERTIFICATE-----'.
az iot dps enrollment-group update --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--ca-name]
[--certificate-path]
[--dps-name]
[--edge-enabled {false, true}]
[--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]
[--scn]
[--scp]
[--secondary-key]
[--webhook-url]
Voorbeelden
Werk de inschrijvingsgroep {enrollment_id} bij in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met initiële dubbeleigenschappen en eerste dubbeltags.
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=
Werk de inschrijvingsgroep {enrollment_id} bij in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met een nieuw primair tussenliggend certificaat en verwijder bestaande secundaire tussenliggende certificaten.
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=
Werk de inschrijvingsgroep {enrollment_id} bij in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met nieuw secundair CA-certificaat {certificate_name} en verwijder bestaand primair CA-certificaat.
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=
Werk de inschrijvingsgroep {enrollment_id} bij in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met nieuwe primaire sleutel.
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=
Vereiste parameters
Id van inschrijvingsgroep.
Optionele parameters
Type toewijzingsbeleid om te bepalen hoe een apparaat wordt toegewezen aan een IoT Hub. Als dit niet is opgegeven, is het toewijzingsbeleid de standaardinstelling voor het huidige toewijzingsbeleid dat is ingesteld voor het Device Provisioning Service-exemplaar.
De API-versie van de inrichtingsservicetypen die zijn verzonden in de aangepaste toewijzingsaanvraag. Minimaal ondersteunde versie: 2018-09-01-preview.
Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
De naam van het primaire basis-CA-certificaat. Als attestation met een basis-CA-certificaat gewenst is, moet er een basis-CA-naam worden opgegeven.
Het pad naar het bestand met het primaire certificaat. Als attestation met een tussencertificaat gewenst is, moet er een certificaatpad worden opgegeven.
De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.
Vlag die aangeeft dat edge is ingeschakeld.
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.
Hostnaam van de doel-IoT Hub die is gekoppeld aan het toewijzingsbeleid. Gebruik een door spaties gescheiden lijst voor meerdere IoT Hubs.
Initiële eigenschappen van apparaatdubbels.
Eerste tags voor apparaatdubbels.
Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.
De primaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
Inschrijvingsvermelding in- of uitschakelen.
Vlag om het huidige primaire certificaat te verwijderen.
Vlag om het huidige secundaire certificaat te verwijderen.
Beleid om te bepalen hoe apparaatgegevens moeten worden verwerkt bij het opnieuw inrichten van een andere IoT Hub.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>
.
De naam van het secundaire basis-CA-certificaat. Als attestation met een basis-CA-certificaat gewenst is, moet er een basis-CA-naam worden opgegeven.
Het pad naar het bestand met het secundaire certificaat. Als attestation met een tussencertificaat gewenst is, moet er een certificaatpad worden opgegeven.
De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
De url van de Azure Function-webhook die wordt gebruikt voor aangepaste toewijzingsaanvragen.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID
.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.