Delen via

az iot dps enrollment

Note

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

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.

 Extension GA
az iot dps enrollment delete

Verwijder een afzonderlijke apparaatinschrijving in een Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment list

Afzonderlijke apparaatinschrijvingen weergeven in een Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment registration

Beheer apparaatregistraties aan de servicezijde voor een afzonderlijke inschrijving in een Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment registration delete

Verwijder een apparaatregistratie voor een afzonderlijke inschrijving in een Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment registration show

Haal een apparaatregistratie op voor een afzonderlijke inschrijving in een Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment show

Afzonderlijke apparaatinschrijvingsgegevens ophalen in een Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment update

Werk een afzonderlijke apparaatinschrijving bij in een Azure IoT Hub Device Provisioning Service.

 Extension 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 --attestation-type {symmetricKey, tpm, x509}
                             --eid --enrollment-id
                             [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                             [--api-version --av]
                             [--auth-type {key, login}]
                             [--certificate-path --cp]
                             [--cpn --credential-policy-name]
                             [--device-id]
                             [--device-information --info]
                             [--dps-name]
                             [--edge-enabled --ee {false, true}]
                             [--ek --endorsement-key]
                             [--ih --iot-hubs]
                             [--initial-twin-properties --props]
                             [--initial-twin-tags --tags]
                             [--login]
                             [--pk --primary-key]
                             [--provisioning-status --ps {disabled, enabled}]
                             [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp --secondary-certificate-path]
                             [--secondary-key --sk]
                             [--webhook-url --wh]

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-information "{'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 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 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 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}

Maak een inschrijving met een aangepast adr-naamruimtereferentiebeleid dat is opgegeven.

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --credential-policy-name {policy_name}

Vereiste parameters

--at --attestation-type

Attestation-mechanisme dat wordt gebruikt voor verificatie bij de DPS.

Eigenschap Waarde
Parametergroep: Authentication Arguments
Geaccepteerde waarden: symmetricKey, tpm, x509
--eid --enrollment-id

Afzonderlijke apparaatinschrijvings-id.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--allocation-policy --ap

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.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
Geaccepteerde waarden: custom, geoLatency, hashed, static
--api-version --av

De API-versie van de inrichtingsservicetypen die zijn verzonden in de aangepaste toewijzingsaanvraag. Minimaal ondersteunde versie: 2018-09-01-preview.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
--auth-type

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}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--certificate-path --cp

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.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--cpn --credential-policy-name

Naam van adr-naamruimtereferentiebeleid.

Eigenschap Waarde
Parametergroep: ADR Credential Policy Arguments
--device-id -d

Apparaat-id die is geregistreerd in de IoT Hub.

--device-information --info

Optionele apparaatgegevens.

--dps-name -n

De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--edge-enabled --ee

Vlag die aangeeft dat edge is ingeschakeld.

Eigenschap Waarde
Default value: False
Geaccepteerde waarden: false, true
--ek --endorsement-key

TPM-goedkeuringssleutel voor een TPM-apparaat. Wanneer u tpm als attestation-type kiest, is goedkeuringssleutel vereist.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--ih --iot-hubs

Hostnaam van de doel-IoT Hub die is gekoppeld aan het toewijzingsbeleid. Gebruik een door spaties gescheiden lijst voor meerdere IoT Hubs.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
--initial-twin-properties --props

Initiële eigenschappen van apparaatdubbels.

--initial-twin-tags --tags

Eerste tags voor apparaatdubbels.

--login -l

Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--pk --primary-key

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

Eigenschap Waarde
Parametergroep: Authentication Arguments
--provisioning-status --ps

Inschrijvingsvermelding in- of uitschakelen.

Eigenschap Waarde
Geaccepteerde waarden: disabled, enabled
--reprovision-policy --rp

Beleid om te bepalen hoe apparaatgegevens moeten worden verwerkt bij het opnieuw inrichten van een andere IoT Hub.

Eigenschap Waarde
Geaccepteerde waarden: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--scp --secondary-certificate-path

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.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--secondary-key --sk

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

Eigenschap Waarde
Parametergroep: Authentication Arguments
--webhook-url --wh

De url van de Azure Function-webhook die wordt gebruikt voor aangepaste toewijzingsaanvragen.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot dps enrollment delete

Verwijder een afzonderlijke apparaatinschrijving in een Azure IoT Hub Device Provisioning Service.

az iot dps enrollment delete --eid --enrollment-id
                             [--auth-type {key, login}]
                             [--dps-name]
                             [--etag]
                             [--login]
                             [--resource-group]

Vereiste parameters

--eid --enrollment-id

Afzonderlijke apparaatinschrijvings-id.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--auth-type

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}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--dps-name -n

De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--etag -e

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

--login -l

Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

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

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--auth-type

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}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--dps-name -n

De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--login -l

Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--top

Maximum aantal elementen dat moet worden geretourneerd. Gebruik -1 onbeperkt.

Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot dps enrollment show

Afzonderlijke apparaatinschrijvingsgegevens ophalen in een Azure IoT Hub Device Provisioning Service.

az iot dps enrollment show --eid --enrollment-id
                           [--auth-type {key, login}]
                           [--dps-name]
                           [--keys --show-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-keys

Vereiste parameters

--eid --enrollment-id

Afzonderlijke apparaatinschrijvings-id.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--auth-type

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}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--dps-name -n

De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--keys --show-keys

Attestation-sleutels en -informatie opnemen in de inschrijvingsresultaten.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--login -l

Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

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 --enrollment-id
                             [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                             [--api-version --av]
                             [--auth-type {key, login}]
                             [--certificate-path --cp]
                             [--cpn --credential-policy-name]
                             [--device-id]
                             [--device-information --info]
                             [--dps-name]
                             [--edge-enabled --ee {false, true}]
                             [--ek --endorsement-key]
                             [--etag]
                             [--ih --iot-hubs]
                             [--initial-twin-properties --props]
                             [--initial-twin-tags --tags]
                             [--login]
                             [--pk --primary-key]
                             [--provisioning-status --ps {disabled, enabled}]
                             [--rc --remove-certificate {false, true}]
                             [--remove-secondary-certificate --rsc {false, true}]
                             [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp --secondary-certificate-path]
                             [--secondary-key --sk]
                             [--webhook-url --wh]

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-information "{'color':'red'}"

Werk de inschrijving {enrollment_id} bij in de Azure IoT Device Provisioning Service {dps_name} om een aangepast referentiebeleid voor ADR-naamruimten te gebruiken.

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --credential-policy-name {my_policy}

Vereiste parameters

--eid --enrollment-id

Afzonderlijke apparaatinschrijvings-id.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--allocation-policy --ap

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.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
Geaccepteerde waarden: custom, geoLatency, hashed, static
--api-version --av

De API-versie van de inrichtingsservicetypen die zijn verzonden in de aangepaste toewijzingsaanvraag. Minimaal ondersteunde versie: 2018-09-01-preview.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
--auth-type

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}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--certificate-path --cp

Het pad naar het bestand met het primaire certificaat.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--cpn --credential-policy-name

Naam van adr-naamruimtereferentiebeleid.

Eigenschap Waarde
Parametergroep: ADR Credential Policy Arguments
--device-id -d

Apparaat-id die is geregistreerd in de IoT Hub.

--device-information --info

Optionele apparaatgegevens.

--dps-name -n

De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--edge-enabled --ee

Vlag die aangeeft dat edge is ingeschakeld.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--ek --endorsement-key

TPM-goedkeuringssleutel voor een TPM-apparaat.

--etag -e

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

--ih --iot-hubs

Hostnaam van de doel-IoT Hub die is gekoppeld aan het toewijzingsbeleid. Gebruik een door spaties gescheiden lijst voor meerdere IoT Hubs.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
--initial-twin-properties --props

Initiële eigenschappen van apparaatdubbels.

--initial-twin-tags --tags

Eerste tags voor apparaatdubbels.

--login -l

Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--pk --primary-key

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

Eigenschap Waarde
Parametergroep: Authentication Arguments
--provisioning-status --ps

Inschrijvingsvermelding in- of uitschakelen.

Eigenschap Waarde
Geaccepteerde waarden: disabled, enabled
--rc --remove-certificate

Vlag om het huidige primaire certificaat te verwijderen.

Eigenschap Waarde
Parametergroep: Authentication Arguments
Geaccepteerde waarden: false, true
--remove-secondary-certificate --rsc

Vlag om het huidige secundaire certificaat te verwijderen.

Eigenschap Waarde
Parametergroep: Authentication Arguments
Geaccepteerde waarden: false, true
--reprovision-policy --rp

Beleid om te bepalen hoe apparaatgegevens moeten worden verwerkt bij het opnieuw inrichten van een andere IoT Hub.

Eigenschap Waarde
Geaccepteerde waarden: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--scp --secondary-certificate-path

Het pad naar het bestand met het secundaire certificaat.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--secondary-key --sk

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

Eigenschap Waarde
Parametergroep: Authentication Arguments
--webhook-url --wh

De url van de Azure Function-webhook die wordt gebruikt voor aangepaste toewijzingsaanvragen.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False