az iot dps enrollment
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 eerste keer een opdracht az iot dps enrollment hebt uitgevoerd. Meer informatie over extensies.
Inschrijvingen beheren in een Azure IoT Hub Device Provisioning Service.
Opdracht
| az iot dps enrollment create |
Maak een apparaatinschrijving in een Azure IoT Hub Device Provisioning Service. |
| az iot dps enrollment delete |
Een apparaatinschrijving verwijderen in een Azure IoT Hub Device Provisioning Service. |
| az iot dps enrollment list |
Apparaatinschrijvingen in een Azure IoT Hub Device Provisioning Service. |
| az iot dps enrollment show |
Haal de details van de apparaatinschrijving op in Azure IoT Hub Device Provisioning Service. |
| az iot dps enrollment update |
Een apparaatinschrijving bijwerken in een Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment create
Maak een apparaatinschrijving in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment create --at {symmetricKey, tpm, x509}
--dps-name
--enrollment-id
--resource-group
[--allocation-policy {custom, geolatency, hashed, static}]
[--api-version]
[--certificate-path]
[--device-id]
[--edge-enabled {false, true}]
[--ek]
[--hn]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--pk]
[--provisioning-status {disabled, enabled}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--scp]
[--secondary-key]
[--webhook-url]
Voorbeelden
Een inschrijving {enrollment_id} maken met attestation-type 'x509' in de Azure IoT-inrichtingsservice {dps_name}' in de resourcegroep {resource_group_name}'
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type x509 --certificate-path /certificates/Certificate.pem
Maak een inschrijving {enrollment_id}met attestation-type 'x509' in Azure IoT Device Provisioning Service {dps_name}' in de resourcegroep {resource_group_name}, met de inrichtingsstatus Uitgeschakeld, doel IoT Hub {iothub_host_name}, apparaat-id {device_id}, initiële dubbeleigenschappen {"locatie":{"regio":"US"}}" en initiële tweelingtags '{"version":"1"}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type x509 --certificate-path /certificates/Certificate.pem --provisioning-status disabled --iot-hub-host-name {iothub_host_name} --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version':'1'}" --device-id {device_id}
Maak een inschrijving 'MyEnrollment' met attestation-type 'tpm' in de Azure IoT Device Provisioning Service '{dps_name}' in de resourcegroep {resource_group_name}.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89
Maak een inschrijving 'MyEnrollment' met attestation-type 'symmetrickey' in de Azure IoT Device Provisioning Service '{dps_name}' in de resourcegroep '{resource_group_name}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --primary-key {primary_key} --secondary-key {secondary_key}
Maak een inschrijving 'MyEnrollment' met een nieuwe inrichting in de Azure IoT Device Provisioning Service {dps_name}' in de resourcegroep {resource_group_name}.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --reprovision-policy {reprovision_type} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89
Maak een inschrijving 'MyEnrollment' met statisch toewijzingsbeleid in de Azure IoT Device Provisioning Service {dps_name}' in de resourcegroep {resource_group_name}.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy static --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name}
Maak een inschrijving 'MyEnrollment' met hash-toewijzingsbeleid en meerdere hubs in de Azure IoT Device Provisioning Service {dps_name}' in de resourcegroep {resource_group_name}.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy hashed --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs "{iot_hub_host_name1} {iot_hub_host_name2}"
Een inschrijving 'MyEnrollment' maken met aangepast toewijzingsbeleid,
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}
Vereiste parameters
Attestation-mechanisme.
Naam van de Azure IoT Hub device provisioning service.
Id van de registratierecord van het apparaat.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
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.
Het pad naar het bestand met het primaire certificaat. Wanneer u x509 als attestation-type kiest, is een van de certificaatpaden vereist.
IoT Hub apparaat-id.
Vlag die edge-inschakelen aangeeft.
TPM-goedkeuringssleutel voor een TPM-apparaat. Wanneer u TPM als attestation-type kiest, is goedkeuringssleutel vereist.
Hostnaam van doel-IoT Hub.
Hostnaam van doel-IoT Hub. Gebruik een door spatie gescheiden lijst voor meerdere IoT Hubs.
Initiële dubbeleigenschappen.
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.
Het pad naar het bestand met het secundaire certificaat. Wanneer u x509 als attestation-type kiest, is een van de certificaatpaden vereist.
De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
De webhook-URL die wordt gebruikt voor aangepaste toewijzingsaanvragen.
Vergroot de logboekbebossing 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 logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot dps enrollment delete
Een apparaatinschrijving verwijderen in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment delete --dps-name
--enrollment-id
--resource-group
[--etag]
Vereiste parameters
Naam van de Azure IoT Hub device provisioning service.
Id van de registratierecord van het apparaat.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
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 logboekbebossing 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 logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot dps enrollment list
Apparaatinschrijvingen in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment 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 az configure --defaults group=<name> behulp van .
Optionele parameters
Maximum aantal elementen dat moet worden retourneren. Gebruik -1 voor onbeperkt.
Vergroot de logboekbebossing 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 logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot dps enrollment show
Haal de details van de apparaatinschrijving op in Azure IoT Hub Device Provisioning Service.
az iot dps enrollment show --dps-name
--enrollment-id
--resource-group
[--keys {false, true}]
Voorbeelden
Basisgebruik
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Volledige attestation-informatie opnemen in de resultaten voor een inschrijving met een symmetrische sleutel
az iot dps enrollment 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 registratierecord van het apparaat.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Optionele parameters
Attestation-sleutels en -informatie opnemen in de registratieresultaten.
Vergroot de logboekbebossing 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 logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az iot dps enrollment update
Een apparaatinschrijving bijwerken in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment update --dps-name
--enrollment-id
--resource-group
[--allocation-policy {custom, geolatency, hashed, static}]
[--api-version]
[--certificate-path]
[--device-id]
[--edge-enabled {false, true}]
[--ek]
[--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}]
[--scp]
[--secondary-key]
[--webhook-url]
Voorbeelden
Werk de inschrijving {enrollment_id} bij met een nieuw x509-certificaat in Azure IoT Device Provisioning Service {dps_name} in de resourcegroep {resource_group_name}.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --etag AAAAAAAAAAA=
Werk de inschrijving {enrollment_id} bij met een nieuwe goedkeuringssleutel in Azure IoT Device Provisioning Service {dps_name} in de resourcegroep {resource_group_name}.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --etag AAAAAAAAAAA=
Werk de inschrijving {enrollment_id} bij met een nieuwe primaire sleutel in Azure IoT Device Provisioning Service {dps_name} in de resourcegroep {resource_group_name}.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=
De inschrijving {enrollment_id} is bijgewerkt met een nieuw type inrichting in Azure IoT Device Provisioning Service {dps_name} in de resourcegroep {resource_group_name}.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --reprovision-policy {reprovision_type} --etag AAAAAAAAAAA=
Werk de inschrijving {enrollment_id} bij met een nieuw toewijzingsbeleid in Azure IoT Device Provisioning Service {dps_name} in de resourcegroep {resource_group_name}.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy geolatency --etag AAAAAAAAAAA= --iot-hubs "{iot_hub_host_name1} {iot_hub_host_name2} {iot_hub_host_name3}"
De inschrijving {enrollment_id} is bijgewerkt in de Azure IoT Device Provisioning Service {dps_name}' in de resourcegroep {resource_group_name}, met de initiële dubbeleigenschappen {"location":{"region":"USA"}}" en de initiële tweelingtags '{"version":"2"}".
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version1':'2'}"
Vereiste parameters
Naam van de Azure IoT Hub device provisioning service.
Id van de registratierecord van het apparaat.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
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.
Het pad naar het bestand met het primaire certificaat.
IoT Hub apparaat-id.
Vlag die edge-inschakelen aangeeft.
TPM-goedkeuringssleutel voor een TPM-apparaat.
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.
Initiële dubbeleigenschappen.
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.
Het pad naar het bestand met het secundaire certificaat.
De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.
De webhook-URL die wordt gebruikt voor aangepaste toewijzingsaanvragen.
Vergroot de logboekbebossing 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 logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.