az iot dps enrollment-group
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 kommandot az iot dps enrollment-group . Läs mer om tillägg.
Hantera registreringsgrupper i en Azure IoT Hub Device Provisioning-tjänst.
Kommandon
Name | Description | Typ | Status |
---|---|---|---|
az iot dps enrollment-group compute-device-key |
Generera en SAS-nyckel för härledda enheter för en registreringsgrupp i en Azure IoT Hub Device Provisioning-tjänst. |
Anknytning | Allmän tillgänglighet |
az iot dps enrollment-group create |
Skapa en registreringsgrupp i en Azure IoT Hub Device Provisioning-tjänst. |
Anknytning | Allmän tillgänglighet |
az iot dps enrollment-group delete |
Ta bort en registreringsgrupp i en Azure IoT Hub Device Provisioning-tjänst. |
Anknytning | Allmän tillgänglighet |
az iot dps enrollment-group list |
Lista registreringsgrupper i en Azure IoT Hub Device Provisioning-tjänst. |
Anknytning | Allmän tillgänglighet |
az iot dps enrollment-group registration |
Hantera enhetsregistreringar på tjänstsidan för en registreringsgrupp i en Azure IoT Hub Device Provisioning-tjänst. |
Anknytning | Allmän tillgänglighet |
az iot dps enrollment-group registration delete |
Ta bort en enhetsregistrering för en registreringsgrupp i en Azure IoT Hub Device Provisioning-tjänst. |
Anknytning | Allmän tillgänglighet |
az iot dps enrollment-group registration list |
Lista enhetsregistreringar för en registreringsgrupp i en Azure IoT Hub Device Provisioning-tjänst. |
Anknytning | Allmän tillgänglighet |
az iot dps enrollment-group registration show |
Hämta en enhetsregistrering för en registreringsgrupp i en Azure IoT Hub Device Provisioning-tjänst. |
Anknytning | Allmän tillgänglighet |
az iot dps enrollment-group show |
Hämta information om en registreringsgrupp i en Azure IoT Hub Device Provisioning-tjänst. |
Anknytning | Allmän tillgänglighet |
az iot dps enrollment-group update |
Uppdatera en registreringsgrupp i en Azure IoT Hub Device Provisioning-tjänst. |
Anknytning | Allmän tillgänglighet |
az iot dps enrollment-group compute-device-key
Generera en SAS-nyckel för härledda enheter för en registreringsgrupp i en Azure IoT Hub Device Provisioning-tjänst.
az iot dps enrollment-group compute-device-key --registration-id
[--auth-type {key, login}]
[--dps-name]
[--eid]
[--key]
[--login]
[--resource-group]
Exempel
Beräkna enhetsnyckeln med den angivna symmetriska nyckeln.
az iot dps enrollment-group compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}
Beräkna enhetsnyckeln med den angivna registreringsgruppen.
az iot dps enrollment-group compute-device-key -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --registration-id {registration_id}
Obligatoriska parametrar
ID för enhetsregistrering.
Valfria parametrar
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>
Namn eller värdnamn för Azure IoT Hub Device Provisioning Service. Krävs om --login inte har angetts.
Registreringsgrupp-ID.
Den symmetriska delade åtkomstnyckeln för registreringsgruppen. Detta kringgår enhetsetableringstjänstens register och genererar SAS-token direkt från den angivna symmetriska nyckeln utan ytterligare verifiering. Alla andra kommandoparametrar förutom registrerings-ID ignoreras.
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.
Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
Utdataformat.
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
az iot dps enrollment-group create
Skapa en registreringsgrupp 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-group create --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--ca-name]
[--certificate-path]
[--dps-name]
[--edge-enabled {false, true}]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scn]
[--scp]
[--secondary-key]
[--webhook-url]
Exempel
Skapa en registreringsgrupp {enrollment_id} i Azure IoT-etableringstjänsten {dps_name} i resursgruppen {resource_group_name} med hjälp av ett mellanliggande certifikat som primärt certifikat.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem
Skapa en registreringsgrupp {enrollment_id} i Azure IoT-etableringstjänsten {dps_name} i resursgruppen {resource_group_name} med hjälp av ett CA-certifikat {certificate_name} som sekundärt certifikat.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name}
Skapa en registreringsgrupp {enrollment_id} i Azure IoT-etableringstjänsten "MyDps" i resursgruppen {resource_group_name} med etableringsstatusen "aktiverad", de första tvillingegenskaperna {"location":{"region":"US"}} och inledande tvillingtaggar {"version_dps":"1"} med hjälp av ett mellanliggande certifikat som primärt certifikat.
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 --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version_dps':'1'}"
Skapa en registreringsgrupp {enrollment_id} i Azure IoT-etableringstjänsten {dps_name} i resursgruppen {resource_group_name} med attesteringstypen "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}
Skapa en registreringsgrupp {enrollment_id} med anpassad allokeringsprincip,
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}
Obligatoriska parametrar
Registreringsgrupp-ID.
Valfria parametrar
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.
API-versionen av de etableringstjänsttyper som skickas i den anpassade allokeringsbegäran. Lägsta version som stöds: 2018-09-01-preview.
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>
Namnet på det primära rotcertifikatutfärdarcertifikatet. Om attestering med ett rotcertifikatutfärdarcertifikat önskas måste ett rotcertifikatutfärdarnamn anges.
Sökvägen till filen som innehåller det primära certifikatet. Om attestering med ett mellanliggande certifikat önskas måste en certifikatsökväg anges.
Namn eller värdnamn för Azure IoT Hub Device Provisioning Service. Krävs om --login inte har angetts.
Flagga som anger kantaktivering.
Värdnamnet för mål-IoT Hub som är associerat med allokeringsprincipen. Använd blankstegsavgränsad lista för flera IoT Hubs.
Initiala egenskaper för enhetstvillingar.
Initiala taggar för enhetstvillingar.
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.
Den primära symmetriska delade åtkomstnyckeln som lagras i base64-format.
Aktivera eller inaktivera registreringspost.
Princip för att avgöra hur enhetsdata ska hanteras vid återetablering till en annan IoT Hub.
Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>
Namnet på det sekundära rotcertifikatutfärdarcertifikatet. Om attestering med ett rotcertifikatutfärdarcertifikat önskas måste ett rotcertifikatutfärdarnamn anges.
Sökvägen till filen som innehåller det sekundära certifikatet. Om attestering med ett mellanliggande certifikat önskas måste en certifikatsökväg anges.
Den sekundära symmetriska delade åtkomstnyckeln som lagras i base64-format.
Webhook-URL:en för Azure Function som används för anpassade allokeringsbegäranden.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
Utdataformat.
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
az iot dps enrollment-group delete
Ta bort en registreringsgrupp i en Azure IoT Hub Device Provisioning-tjänst.
az iot dps enrollment-group delete --eid
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]
Obligatoriska parametrar
Registreringsgrupp-ID.
Valfria parametrar
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>
Namn eller värdnamn för Azure IoT Hub Device Provisioning Service. Krävs om --login inte har angetts.
Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.
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.
Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
Utdataformat.
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
az iot dps enrollment-group list
Lista registreringsgrupper i en Azure IoT Hub Device Provisioning-tjänst.
az iot dps enrollment-group list [--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]
[--top]
Valfria parametrar
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>
Namn eller värdnamn för Azure IoT Hub Device Provisioning Service. Krävs om --login inte har angetts.
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.
Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>
Maximalt antal element som ska returneras. Använd -1 för obegränsat.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
Utdataformat.
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
az iot dps enrollment-group show
Hämta information om en registreringsgrupp i en Azure IoT Hub Device Provisioning-tjänst.
az iot dps enrollment-group show --eid
[--auth-type {key, login}]
[--dps-name]
[--keys {false, true}]
[--login]
[--resource-group]
Exempel
Grundläggande användning
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Inkludera fullständig attesteringsinformation i resultat för en symmetrisk nyckelregistreringsgrupp
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
Obligatoriska parametrar
Registreringsgrupp-ID.
Valfria parametrar
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>
Namn eller värdnamn för Azure IoT Hub Device Provisioning Service. Krävs om --login inte har angetts.
Inkludera attesteringsnycklar och information i resultat för registreringsgrupper.
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.
Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
Utdataformat.
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
az iot dps enrollment-group update
Uppdatera en registreringsgrupp 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-group update --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--ca-name]
[--certificate-path]
[--dps-name]
[--edge-enabled {false, true}]
[--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]
[--scn]
[--scp]
[--secondary-key]
[--webhook-url]
Exempel
Uppdatera registreringsgruppen {enrollment_id} i Azure IoT-etableringstjänsten {dps_name} i resursgruppen {resource_group_name} med inledande tvillingegenskaper och inledande tvillingtaggar.
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=
Uppdatera registreringsgruppen {enrollment_id} i Azure IoT-etableringstjänsten {dps_name} i resursgruppen {resource_group_name} med det nya primära mellanliggande certifikatet och ta bort det befintliga sekundära mellanliggande certifikatet.
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=
Uppdatera registreringsgruppen {enrollment_id} i Azure IoT-etableringstjänsten {dps_name} i resursgruppen {resource_group_name} med det nya sekundära CA-certifikatet {certificate_name} och ta bort det befintliga primära CA-certifikatet.
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=
Uppdatera registreringsgruppen {enrollment_id} i Azure IoT-etableringstjänsten {dps_name} i resursgruppen {resource_group_name} med ny primärnyckel.
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=
Obligatoriska parametrar
Registreringsgrupp-ID.
Valfria parametrar
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.
API-versionen av de etableringstjänsttyper som skickas i den anpassade allokeringsbegäran. Lägsta version som stöds: 2018-09-01-preview.
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>
Namnet på det primära rotcertifikatutfärdarcertifikatet. Om attestering med ett rotcertifikatutfärdarcertifikat önskas måste ett rotcertifikatutfärdarnamn anges.
Sökvägen till filen som innehåller det primära certifikatet. Om attestering med ett mellanliggande certifikat önskas måste en certifikatsökväg anges.
Namn eller värdnamn för Azure IoT Hub Device Provisioning Service. Krävs om --login inte har angetts.
Flagga som anger kantaktivering.
Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.
Värdnamnet för mål-IoT Hub som är associerat med allokeringsprincipen. Använd blankstegsavgränsad lista för flera IoT Hubs.
Initiala egenskaper för enhetstvillingar.
Initiala taggar för enhetstvillingar.
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.
Den primära symmetriska delade åtkomstnyckeln som lagras i base64-format.
Aktivera eller inaktivera registreringspost.
Flagga för att ta bort det aktuella primära certifikatet.
Flagga för att ta bort det aktuella sekundära certifikatet.
Princip för att avgöra hur enhetsdata ska hanteras vid återetablering till en annan IoT Hub.
Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>
Namnet på det sekundära rotcertifikatutfärdarcertifikatet. Om attestering med ett rotcertifikatutfärdarcertifikat önskas måste ett rotcertifikatutfärdarnamn anges.
Sökvägen till filen som innehåller det sekundära certifikatet. Om attestering med ett mellanliggande certifikat önskas måste en certifikatsökväg anges.
Den sekundära symmetriska delade åtkomstnyckeln som lagras i base64-format.
Webhook-URL:en för Azure Function som används för anpassade allokeringsbegäranden.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
Utdataformat.
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.