az iot dps enrollment-group
Notitie
Deze referentie maakt deel uit van de azure-iot-extensie voor Azure CLI en vereist versie 2.17.1 of hoger. De extensie wordt automatisch geïnstalleerd wanneer u de opdracht az iot dps enrollment-group voor het eerst hebt uitgevoerd. Meer informatie over extensies.
Beheer Azure IoT Hub Device Provisioning Service.
Opdracht
| az iot dps enrollment-group create |
Maak een registratiegroep in een Azure IoT Hub Device Provisioning Service. |
| az iot dps enrollment-group delete |
Verwijder een registratiegroep in een Azure IoT Hub Device Provisioning Service. |
| az iot dps enrollment-group list |
Registratiegroepen in een Azure IoT Hub Device Provisioning Service. |
| az iot dps enrollment-group show |
De details van een registratiegroep in een Azure IoT Hub Device Provisioning Service. |
| az iot dps enrollment-group update |
Een registratiegroep bijwerken in een Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment-group create
Maak een registratiegroep in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group create --dps-name
--enrollment-id
--resource-group
[--allocation-policy {custom, geolatency, hashed, static}]
[--api-version]
[--ca-name]
[--certificate-path]
[--edge-enabled {false, true}]
[--hn]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--pk]
[--provisioning-status {disabled, enabled}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--scn]
[--scp]
[--secondary-key]
[--webhook-url]
Voorbeelden
Maak een registratiegroep {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 registratiegroep {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 registratiegroep {enrollment_id}' in de Azure IoT-inrichtingsservice 'MyDps' in de resourcegroep {resource_group_name}, met de inrichtingsstatus Ingeschakeld, doel IoT Hub {iothub_host_name}', initiële tweelingeigenschappen {"location":{"region":"US"}} en initiële tweelingtags {"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 --iot-hub-host-name {iothub_host_name} --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version_dps':'1'}"
Maak een registratiegroep {enrollment_id} in de Azure IoT-inrichtingsservice {dps_name}' in de resourcegroep {resource_group_name} met 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 registratiegroep {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
Naam van de Azure IoT Hub device provisioning service.
Id van de registratiegroep.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .
Optionele parameters
Type toewijzing voor het apparaat dat is toegewezen aan de hub.
De API-versie van de inrichtingsservicetypen die worden verzonden in de aangepaste toewijzingsaanvraag. Minimaal ondersteunde versie: 2018-09-01-preview.
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 tussenliggend certificaat gewenst is, moet er een certificaatpad worden opgegeven.
Vlag waarmee edge-inschakelen wordt aangegeven.
Hostnaam van doel-IoT Hub.
Hostnaam van doel-IoT Hub. Gebruik een door spatie gescheiden lijst voor meerdere IoT Hubs.
Eigenschappen van initiële tweelingen.
Initiële tweelingtags.
De primaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
Inschrijvingsinvoer in- of uitschakelen.
Apparaatgegevens die moeten worden verwerkt bij het opnieuw inrichten naar een andere IoT-hub.
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 tussenliggend certificaat gewenst is, moet er een certificaatpad worden opgegeven.
De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
De webhook-URL die wordt gebruikt voor aangepaste toewijzingsaanvragen.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot dps enrollment-group delete
Verwijder een registratiegroep in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group delete --dps-name
--enrollment-id
--resource-group
[--etag]
Vereiste parameters
Naam van de Azure IoT Hub device provisioning service.
Id van de registratiegroep.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .
Optionele parameters
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde * ' ' gebruikt.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot dps enrollment-group list
Registratiegroepen in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group list --dps-name
--resource-group
[--top]
Vereiste parameters
Naam van de Azure IoT Hub device provisioning service.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .
Optionele parameters
Maximum aantal elementen dat moet worden retourneren. Gebruik -1 voor onbeperkt.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot dps enrollment-group show
De details van een registratiegroep in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group show --dps-name
--enrollment-id
--resource-group
[--keys {false, true}]
Voorbeelden
Basisgebruik
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Volledige attestation-informatie opnemen in de 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
Naam van de Azure IoT Hub device provisioning service.
Id van de registratiegroep.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .
Optionele parameters
Attestation-sleutels en -informatie opnemen in de resultaten van de registratiegroep.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot dps enrollment-group update
Een registratiegroep bijwerken in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group update --dps-name
--enrollment-id
--resource-group
[--allocation-policy {custom, geolatency, hashed, static}]
[--api-version]
[--ca-name]
[--certificate-path]
[--edge-enabled {false, true}]
[--etag]
[--hn]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--pk]
[--provisioning-status {disabled, enabled}]
[--rc {false, true}]
[--remove-secondary-certificate {false, true}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--scn]
[--scp]
[--secondary-key]
[--webhook-url]
Voorbeelden
Werk de registratiegroep {enrollment_id} in de Azure IoT-inrichtingsservice {dps_name} bij in de resourcegroep {resource_group_name}, met initiële tweelingeigenschappen en initiële tweelingtags.
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 registratiegroep {enrollment_id} in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} bij met een nieuw primair tussenliggend certificaat en verwijder het bestaande secundaire tussencertificaat.
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 registratiegroep {enrollment_id} in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} bij met het nieuwe secundaire CA-certificaat {certificate_name} en verwijder het bestaande primaire 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 registratiegroep {enrollment_id} in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} bij met de 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
Naam van de Azure IoT Hub device provisioning service.
Id van de registratiegroep.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .
Optionele parameters
Type toewijzing voor het apparaat dat is toegewezen aan de hub.
De API-versie van de inrichtingsservicetypen die worden verzonden in de aangepaste toewijzingsaanvraag. Minimaal ondersteunde versie: 2018-09-01-preview.
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 tussenliggend certificaat gewenst is, moet er een certificaatpad worden opgegeven.
Vlag waarmee edge-inschakelen wordt aangegeven.
Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde * ' ' gebruikt.
Hostnaam van doel-IoT Hub.
Hostnaam van doel-IoT Hub. Gebruik een door spatie gescheiden lijst voor meerdere IoT Hubs.
Eigenschappen van initiële tweelingen.
Initiële tweelingtags.
De primaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
Inschrijvingsinvoer in- of uitschakelen.
Verwijder het huidige primaire certificaat.
Verwijder het huidige secundaire certificaat.
Apparaatgegevens die moeten worden verwerkt bij het opnieuw inrichten naar een andere IoT-hub.
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 tussenliggend certificaat gewenst is, moet er een certificaatpad worden opgegeven.
De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
De webhook-URL die wordt gebruikt voor aangepaste toewijzingsaanvragen.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.