Dela via

az iot dps enrollment

  • Referens

Kommentar

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.46.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot dps-registreringskommando . Läs mer om tillägg.

Hantera enskilda enhetsregistreringar i en Azure IoT Hub Device Provisioning-tjänst.

Kommandon

Name Description Typ Status
az iot dps enrollment create

Skapa en enskild enhetsregistrering i en Azure IoT Hub Device Provisioning-tjänst.

 Anknytning Allmän tillgänglighet
az iot dps enrollment delete

Ta bort en enskild enhetsregistrering i en Azure IoT Hub Device Provisioning-tjänst.

 Anknytning Allmän tillgänglighet
az iot dps enrollment list

Visa en lista över enskilda enhetsregistreringar i en Azure IoT Hub Device Provisioning-tjänst.

 Anknytning Allmän tillgänglighet
az iot dps enrollment registration

Hantera enhetsregistreringar på tjänstsidan för en enskild registrering i en Azure IoT Hub Device Provisioning-tjänst.

 Anknytning Allmän tillgänglighet
az iot dps enrollment registration delete

Ta bort en enhetsregistrering för en enskild registrering i en Azure IoT Hub Device Provisioning-tjänst.

 Anknytning Allmän tillgänglighet
az iot dps enrollment registration show

Hämta en enhetsregistrering för en enskild registrering i en Azure IoT Hub Device Provisioning-tjänst.

 Anknytning Allmän tillgänglighet
az iot dps enrollment show

Hämta information om enskilda enhetsregistreringar i en Azure IoT Hub Device Provisioning-tjänst.

 Anknytning Allmän tillgänglighet
az iot dps enrollment update

Uppdatera en enskild enhetsregistrering i en Azure IoT Hub Device Provisioning-tjänst.

 Anknytning Allmän tillgänglighet

az iot dps enrollment create

Skapa en enskild enhetsregistrering i en Azure IoT Hub Device Provisioning-tjänst.

Ange certifikatformat med Base64 ASCII-kodning och certifikatet ska ha matchande BEGIN- och END-segment, till exempel: börja med "-----BEGIN CERTIFICATE-----" och sluta med "-----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]

Exempel

Skapa en registrering {enrollment_id} med attesteringstypen "x509" i Azure IoT Device Provisioning Service {dps_name} i resursgruppen {resource_group_name} med etableringsstatusen "inaktiverad", enhets-ID {device_id}, de första tvillingegenskaperna {"location":{"region":"US"}}", initiala tvillingtaggar {"version":"1"} och enhetsinformationen {"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}

Skapa en registrering "MyEnrollment" med attesteringstypen "tpm" i Azure IoT Device Provisioning Service {dps_name} i resursgruppen {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

Skapa en registrering "MyEnrollment" med attesteringstypen "symmetrickey" i Azure IoT Device Provisioning-tjänsten {dps_name} i resursgruppen {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}

Skapa en registrering "MyEnrollment" med ometablering i Azure IoT Device Provisioning-tjänsten {dps_name} i resursgruppen {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

Skapa en registrering "MyEnrollment" med statisk allokeringsprincip i Azure IoT Device Provisioning-tjänsten {dps_name} i resursgruppen {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}

Skapa en registrering "MyEnrollment" med hashad allokeringsprincip och flera hubbar i Azure IoT Device Provisioning-tjänsten {dps_name} i resursgruppen {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}

Skapa en registrering "MyEnrollment" med anpassad allokeringsprincip,

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}

Obligatoriska parametrar

--at --attestation-type

Attesteringsmekanism som används för autentisering till DPS.

Godkända värden: symmetricKey, tpm, x509
--eid --enrollment-id

Registrerings-ID för enskilda enheter.

Valfria parametrar

--allocation-policy --ap

Typ av allokeringsprincip för att avgöra hur en enhet tilldelas till en IoT Hub. Om den inte tillhandahålls är allokeringsprincipen standardinställningen för den aktuella allokeringsprincipen för instansen av enhetsetableringstjänsten.

Godkända värden: custom, geoLatency, hashed, static
--api-version --av

API-versionen av de etableringstjänsttyper som skickas i den anpassade allokeringsbegäran. Lägsta version som stöds: 2018-09-01-preview.

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iotdps-data-auth-type=<auth-type-value>

Godkända värden: key, login
Standardvärde: key
--certificate-path --cp

Sökvägen till filen som innehåller det primära certifikatet. Krävs när du väljer x509 som attesteringstyp och den sekundära certifikatsökvägen anges inte.

--device-id -d

Enhets-ID som är registrerat i IoT Hub.

--device-information --info

Valfri enhetsinformation.

--dps-name -n

Namn eller värdnamn för Azure IoT Hub Device Provisioning Service. Krävs om --login inte har angetts.

--edge-enabled --ee

Flagga som anger kantaktivering.

Godkända värden: false, true
Standardvärde: False
--ek --endorsement-key

TPM-bekräftelsenyckel för en TPM-enhet. När du väljer tpm som attesteringstyp krävs bekräftelsenyckel.

--ih --iot-hubs

Värdnamnet för mål-IoT Hub som är associerat med allokeringsprincipen. Använd blankstegsavgränsad lista för flera IoT Hubs.

--initial-twin-properties --props

Initiala egenskaper för enhetstvillingar.

--initial-twin-tags --tags

Initiala taggar för enhetstvillingar.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --dps-name inte anges.

--pk --primary-key

Den primära symmetriska delade åtkomstnyckeln som lagras i base64-format.

--provisioning-status --ps

Aktivera eller inaktivera registreringspost.

Godkända värden: disabled, enabled
--reprovision-policy --rp

Princip för att avgöra hur enhetsdata ska hanteras vid återetablering till en annan IoT Hub.

Godkända värden: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--scp --secondary-certificate-path

Sökvägen till filen som innehåller det sekundära certifikatet. Krävs när du väljer x509 som attesteringstyp och den primära certifikatsökvägen anges inte.

--secondary-key --sk

Den sekundära symmetriska delade åtkomstnyckeln som lagras i base64-format.

--webhook-url --wh

Webhook-URL:en för Azure Function som används för anpassade allokeringsbegäranden.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot dps enrollment delete

Ta bort en enskild enhetsregistrering i en Azure IoT Hub Device Provisioning-tjänst.

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

Obligatoriska parametrar

--eid --enrollment-id

Registrerings-ID för enskilda enheter.

Valfria parametrar

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iotdps-data-auth-type=<auth-type-value>

Godkända värden: key, login
Standardvärde: key
--dps-name -n

Namn eller värdnamn för Azure IoT Hub Device Provisioning Service. Krävs om --login inte har angetts.

--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --dps-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot dps enrollment list

Visa en lista över enskilda enhetsregistreringar i en Azure IoT Hub Device Provisioning-tjänst.

az iot dps enrollment list [--auth-type {key, login}]
                           [--dps-name]
                           [--login]
                           [--resource-group]
                           [--top]

Valfria parametrar

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iotdps-data-auth-type=<auth-type-value>

Godkända värden: key, login
Standardvärde: key
--dps-name -n

Namn eller värdnamn för Azure IoT Hub Device Provisioning Service. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --dps-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--top

Maximalt antal element som ska returneras. Använd -1 för obegränsat.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot dps enrollment show

Hämta information om enskilda enhetsregistreringar i en Azure IoT Hub Device Provisioning-tjänst.

az iot dps enrollment show --eid
                           [--auth-type {key, login}]
                           [--dps-name]
                           [--keys {false, true}]
                           [--login]
                           [--resource-group]

Exempel

Grundläggande användning

az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}

Inkludera fullständig attesteringsinformation i resultat för en symmetrisk nyckelregistrering

az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys

Obligatoriska parametrar

--eid --enrollment-id

Registrerings-ID för enskilda enheter.

Valfria parametrar

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iotdps-data-auth-type=<auth-type-value>

Godkända värden: key, login
Standardvärde: key
--dps-name -n

Namn eller värdnamn för Azure IoT Hub Device Provisioning Service. Krävs om --login inte har angetts.

--keys --show-keys

Inkludera attesteringsnycklar och information i registreringsresultat.

Godkända värden: false, true
--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --dps-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot dps enrollment update

Uppdatera en enskild enhetsregistrering i en Azure IoT Hub Device Provisioning-tjänst.

Ange certifikatformat med Base64 ASCII-kodning och certifikatet ska ha matchande BEGIN- och END-segment, till exempel: börja med "-----BEGIN CERTIFICATE-----" och sluta med "-----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]

Exempel

Uppdatera registreringen {enrollment_id} med ett nytt x509-certifikat i Azure IoT Device Provisioning Service {dps_name} i resursgruppen {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=

Uppdatera registreringen {enrollment_id} med en ny bekräftelsenyckel i Azure IoT Device Provisioning Service {dps_name} i resursgruppen {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=

Uppdatera registreringen {enrollment_id} med en ny primärnyckel i Azure IoT Device Provisioning Service {dps_name} i resursgruppen {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=

Uppdatera registreringen {enrollment_id} med en ny återetableringstyp i Azure IoT Device Provisioning Service {dps_name} i resursgruppen {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=

Uppdatera registreringen {enrollment_id} med en ny allokeringsprincip i Azure IoT Device Provisioning Service {dps_name} i resursgruppen {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}

Uppdatera registreringen {enrollment_id} i Azure IoT Device Provisioning Service {dps_name} i resursgruppen {resource_group_name} med de första tvillingegenskaperna {"location":{"region":"USA"}}, de första tvillingtaggar {"version":"2"} och enhetsinformationen {"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'}"

Obligatoriska parametrar

--eid --enrollment-id

Registrerings-ID för enskilda enheter.

Valfria parametrar

--allocation-policy --ap

Typ av allokeringsprincip för att avgöra hur en enhet tilldelas till en IoT Hub. Om den inte tillhandahålls är allokeringsprincipen standardinställningen för den aktuella allokeringsprincipen för instansen av enhetsetableringstjänsten.

Godkända värden: custom, geoLatency, hashed, static
--api-version --av

API-versionen av de etableringstjänsttyper som skickas i den anpassade allokeringsbegäran. Lägsta version som stöds: 2018-09-01-preview.

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iotdps-data-auth-type=<auth-type-value>

Godkända värden: key, login
Standardvärde: key
--certificate-path --cp

Sökvägen till filen som innehåller det primära certifikatet.

--device-id -d

Enhets-ID som är registrerat i IoT Hub.

--device-information --info

Valfri enhetsinformation.

--dps-name -n

Namn eller värdnamn för Azure IoT Hub Device Provisioning Service. Krävs om --login inte har angetts.

--edge-enabled --ee

Flagga som anger kantaktivering.

Godkända värden: false, true
--ek --endorsement-key

TPM-bekräftelsenyckel för en TPM-enhet.

--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

--ih --iot-hubs

Värdnamnet för mål-IoT Hub som är associerat med allokeringsprincipen. Använd blankstegsavgränsad lista för flera IoT Hubs.

--initial-twin-properties --props

Initiala egenskaper för enhetstvillingar.

--initial-twin-tags --tags

Initiala taggar för enhetstvillingar.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --dps-name inte anges.

--pk --primary-key

Den primära symmetriska delade åtkomstnyckeln som lagras i base64-format.

--provisioning-status --ps

Aktivera eller inaktivera registreringspost.

Godkända värden: disabled, enabled
--rc --remove-certificate

Flagga för att ta bort det aktuella primära certifikatet.

Godkända värden: false, true
--remove-secondary-certificate --rsc

Flagga för att ta bort det aktuella sekundära certifikatet.

Godkända värden: false, true
--reprovision-policy --rp

Princip för att avgöra hur enhetsdata ska hanteras vid återetablering till en annan IoT Hub.

Godkända värden: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--scp --secondary-certificate-path

Sökvägen till filen som innehåller det sekundära certifikatet.

--secondary-key --sk

Den sekundära symmetriska delade åtkomstnyckeln som lagras i base64-format.

--webhook-url --wh

Webhook-URL:en för Azure Function som används för anpassade allokeringsbegäranden.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.