az iot dps enrollment
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 az iot dps enrollment-opdracht uitvoert. Meer informatie over extensies.
Afzonderlijke apparaatinschrijvingen beheren in een Azure IoT Hub Device Provisioning Service.
Opdracht
| Name | Description | Type | Status |
|---|---|---|---|
| az iot dps enrollment create |
Maak een afzonderlijke apparaatinschrijving in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
| az iot dps enrollment delete |
Verwijder een afzonderlijke apparaatinschrijving in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
| az iot dps enrollment list |
Afzonderlijke apparaatinschrijvingen weergeven in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
| az iot dps enrollment registration |
Beheer apparaatregistraties aan de servicezijde voor een afzonderlijke inschrijving in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
| az iot dps enrollment registration delete |
Verwijder een apparaatregistratie voor een afzonderlijke inschrijving in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
| az iot dps enrollment registration show |
Haal een apparaatregistratie op voor een afzonderlijke inschrijving in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
| az iot dps enrollment show |
Afzonderlijke apparaatinschrijvingsgegevens ophalen in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
| az iot dps enrollment update |
Werk een afzonderlijke apparaatinschrijving bij in een Azure IoT Hub Device Provisioning Service. |
Toestel | GA |
az iot dps enrollment create
Maak een afzonderlijke apparaatinschrijving 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 create --at {symmetricKey, tpm, x509}
--eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--certificate-path]
[--device-id]
[--device-information]
[--dps-name]
[--edge-enabled {false, true}]
[--ek]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scp]
[--secondary-key]
[--webhook-url]Voorbeelden
Maak een inschrijving {enrollment_id} met attestation-type 'x509' in de Azure IoT Device Provisioning Service {dps_name} in de resourcegroep {resource_group_name} met de inrichtingsstatus uitgeschakeld, apparaat-id {device_id}, initiële dubbeleigenschappen {"location":{"region":"US"}}, eerste dubbeltags {"version":"1"}" en apparaatgegevens {"color":"red"}".
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 --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version':'1'}" --device-info "{'color':'red'}" --device-id {device_id}Maak een inschrijving 'MyEnrollment' met het 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 14963E8F3BA5B3984110B3C1CA8E8B89Maak 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 herinrichting 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 14963E8F3BA5B3984110B3C1CA8E8B89Maak 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 dat wordt gebruikt voor verificatie bij de DPS.
Afzonderlijke apparaatinschrijvings-id.
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>.
Het pad naar het bestand met het primaire certificaat. Vereist bij het kiezen van x509 als attestation-type en het secundaire certificaatpad is niet opgegeven.
Apparaat-id die is geregistreerd in de IoT Hub.
Optionele apparaatgegevens.
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.
TPM-goedkeuringssleutel voor een TPM-apparaat. Wanneer u tpm als attestation-type kiest, is goedkeuringssleutel vereist.
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>.
Het pad naar het bestand met het secundaire certificaat. Vereist bij het kiezen van x509 als attestation-type en het primaire certificaatpad is niet 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 delete
Verwijder een afzonderlijke apparaatinschrijving in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment delete --eid
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]Vereiste parameters
Afzonderlijke apparaatinschrijvings-id.
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 list
Afzonderlijke apparaatinschrijvingen weergeven in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment 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 show
Afzonderlijke apparaatinschrijvingsgegevens ophalen in een Azure IoT Hub Device Provisioning Service.
az iot dps enrollment show --eid
[--auth-type {key, login}]
[--dps-name]
[--keys {false, true}]
[--login]
[--resource-group]Voorbeelden
Basaal gebruik
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}Volledige attestation-informatie opnemen in resultaten voor een symmetrische sleutelinschrijving
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keysVereiste parameters
Afzonderlijke apparaatinschrijvings-id.
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 inschrijvingsresultaten.
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 update
Werk een afzonderlijke apparaatinschrijving 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 update --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--certificate-path]
[--device-id]
[--device-information]
[--dps-name]
[--edge-enabled {false, true}]
[--ek]
[--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]
[--scp]
[--secondary-key]
[--webhook-url]Voorbeelden
Werk de inschrijving {enrollment_id} bij met een nieuw x509-certificaat in de 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 de 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 de 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=Werk de inschrijving {enrollment_id} bij met een nieuw herinrichtingstype in de 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 de 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}"Werk de inschrijving {enrollment_id} bij in de Azure IoT Device Provisioning Service {dps_name} in de resourcegroep {resource_group_name}, met initiële dubbeleigenschappen {"location":{"region":"USA"}}, eerste dubbeltags {"version":"2"}" en apparaatinformatie {"color":"red"}.
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'}" --device-info "{'color':'red'}"Vereiste parameters
Afzonderlijke apparaatinschrijvings-id.
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>.
Het pad naar het bestand met het primaire certificaat.
Apparaat-id die is geregistreerd in de IoT Hub.
Optionele apparaatgegevens.
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.
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 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>.
Het pad naar het bestand met het secundaire certificaat.
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.
Feedback
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor