az iot dps enrollment-group

Uwaga

Ta dokumentacja jest częścią rozszerzenia azure-iot dla interfejsu wiersza polecenia platformy Azure (wersja 2.30.0 lub nowsza). Rozszerzenie automatycznie zainstaluje polecenie az iot dps enrollment-group po raz pierwszy. Dowiedz się więcej o rozszerzeniach.

Zarządzanie grupami rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

Polecenia

az iot dps enrollment-group compute-device-key

Wygeneruj pochodny klucz sygnatury dostępu współdzielonego urządzenia dla grupy rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group create

Utwórz grupę rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group delete

Usuń grupę rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group list

Wyświetl listę grup rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group registration

Zarządzanie rejestracjami urządzeń po stronie usługi dla grupy rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group registration delete

Usuń rejestrację urządzenia dla grupy rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group registration list

Wyświetl listę rejestracji urządzeń dla grupy rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group registration show

Uzyskaj rejestrację urządzenia dla grupy rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group show

Pobierz szczegóły grupy rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group update

Zaktualizuj grupę rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group compute-device-key

Wygeneruj pochodny klucz sygnatury dostępu współdzielonego urządzenia dla grupy rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group compute-device-key --registration-id
                                               [--auth-type {key, login}]
                                               [--dps-name]
                                               [--eid]
                                               [--key]
                                               [--login]
                                               [--resource-group]

Przykłady

Oblicz klucz urządzenia przy użyciu danego klucza symetrycznego.

az iot dps enrollment-group compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}

Oblicz klucz urządzenia przy użyciu danej grupy rejestracji.

az iot dps enrollment-group compute-device-key -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --registration-id {registration_id}

Parametry wymagane

--registration-id --rid

Identyfikator rejestracji urządzenia.

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iotdps-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login
wartość domyślna: key
--dps-name -n

Nazwa usługi Azure IoT Hub Device Provisioning Service. Wymagane, jeśli nie podano --login.

--eid --enrollment-id --gid --group-id

Identyfikator grupy rejestracji.

--key --symmetric-key

Symetryczny klucz dostępu współdzielonego dla grupy rejestracji. Spowoduje to obejście rejestru usługi Device Provisioning Service i wygenerowanie tokenu SAS bezpośrednio z dostarczonego klucza symetrycznego bez dalszej weryfikacji. Wszystkie inne parametry polecenia oprócz identyfikatora rejestracji zostaną zignorowane.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --dps-name.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

az iot dps enrollment-group create

Utwórz grupę rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

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}]
                                   [--hn]
                                   [--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]

Przykłady

Utwórz grupę rejestracji "{enrollment_id}" w usłudze aprowizacji usługi Azure IoT "{dps_name}" w grupie zasobów {resource_group_name} przy użyciu certyfikatu pośredniego jako certyfikatu podstawowego.

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem

Utwórz grupę rejestracji "{enrollment_id}" w usłudze aprowizacji usługi Azure IoT "{dps_name}" w grupie zasobów {resource_group_name} przy użyciu certyfikatu urzędu certyfikacji {certificate_name} jako certyfikatu pomocniczego.

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name}

Utwórz grupę rejestracji "{enrollment_id}" w usłudze aprowizacji azure IoT w grupie zasobów {resource_group_name}" ze stanem inicjowania obsługi administracyjnej "{"location":{"region":"US"}" i początkowymi tagami bliźniaczych reprezentacji {"version_dps":"1"}" przy użyciu certyfikatu pośredniego jako certyfikatu podstawowego".

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

Utwórz grupę rejestracji "{enrollment_id}" w usłudze aprowizacji azure IoT "{dps_name}" w grupie zasobów {resource_group_name} z typem zaświadczania "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}

Utwórz grupę rejestracji "{enrollment_id}" przy użyciu niestandardowych zasad alokacji,

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}

Parametry wymagane

--eid --enrollment-id --gid --group-id

Identyfikator grupy rejestracji.

Parametry opcjonalne

--allocation-policy --ap

Typ zasad alokacji, aby określić, jak urządzenie jest przypisane do IoT Hub. Jeśli nie zostanie podana, zasady alokacji będą bieżącymi zasadami alokacji ustawionymi dla wystąpienia usługi Device Provisioning Service.

akceptowane wartości: custom, geoLatency, hashed, static
--api-version --av

Wersja interfejsu API typów usług aprowizacji wysyłanych w niestandardowym żądaniu alokacji. Minimalna obsługiwana wersja: 2018-09-01-preview.

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iotdps-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login
wartość domyślna: key
--ca-name --cn --root-ca-name

Nazwa podstawowego głównego certyfikatu urzędu certyfikacji. Jeśli wymagane jest zaświadczenie z certyfikatem głównego urzędu certyfikacji, należy podać nazwę głównego urzędu certyfikacji.

--certificate-path --cp

Ścieżka do pliku zawierającego certyfikat podstawowy. Jeśli wymagane jest zaświadczenie za pomocą certyfikatu pośredniego, należy podać ścieżkę certyfikatu.

--dps-name -n

Nazwa usługi Azure IoT Hub Device Provisioning Service. Wymagane, jeśli nie podano --login.

--edge-enabled --ee

Flaga wskazująca włączenie krawędzi.

akceptowane wartości: false, true
--hn --iot-hub-host-name

Nazwa hosta IoT Hub docelowego. Ustawienia domyślne zasad alokacji są statyczne, jeśli ten parametr jest podany.

--ih --iot-hubs

Nazwa hosta IoT Hub docelowej skojarzonej z zasadami alokacji. Użyj listy rozdzielanej spacjami dla wielu centrów IoT Hubs.

--initial-twin-properties --props

Początkowe właściwości bliźniaczej reprezentacji urządzenia.

--initial-twin-tags --tags

Początkowe tagi bliźniaczej reprezentacji urządzenia.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --dps-name.

--pk --primary-key

Podstawowy symetryczny klucz dostępu współdzielonego przechowywany w formacie base64.

--provisioning-status --ps

Włącz lub wyłącz wpis rejestracji.

akceptowane wartości: disabled, enabled
--reprovision-policy --rp

Zasady umożliwiające określenie sposobu obsługi danych urządzenia podczas ponownej aprowizacji w innym IoT Hub.

akceptowane wartości: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--scn --secondary-ca-name --secondary-root-ca-name

Nazwa pomocniczego certyfikatu głównego urzędu certyfikacji. Jeśli wymagane jest zaświadczenie z certyfikatem głównego urzędu certyfikacji, należy podać nazwę głównego urzędu certyfikacji.

--scp --secondary-certificate-path

Ścieżka do pliku zawierającego certyfikat pomocniczy. Jeśli wymagane jest zaświadczenie za pomocą certyfikatu pośredniego, należy podać ścieżkę certyfikatu.

--secondary-key --sk

Pomocniczy symetryczny klucz dostępu współdzielonego przechowywany w formacie base64.

--webhook-url --wh

Adres URL elementu webhook funkcji platformy Azure używany do niestandardowych żądań alokacji.

az iot dps enrollment-group delete

Usuń grupę rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

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

Parametry wymagane

--eid --enrollment-id --gid --group-id

Identyfikator grupy rejestracji.

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iotdps-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login
wartość domyślna: key
--dps-name -n

Nazwa usługi Azure IoT Hub Device Provisioning Service. Wymagane, jeśli nie podano --login.

--etag -e

Etag lub tag jednostki odpowiadający ostatniemu stanowi zasobu. Jeśli nie podano elementu etag, zostanie użyta wartość "*".

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --dps-name.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

az iot dps enrollment-group list

Wyświetl listę grup rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

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

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iotdps-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login
wartość domyślna: key
--dps-name -n

Nazwa usługi Azure IoT Hub Device Provisioning Service. Wymagane, jeśli nie podano --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --dps-name.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--top

Maksymalna liczba elementów do zwrócenia. Użyj -1, aby uzyskać nieograniczoną liczbę.

az iot dps enrollment-group show

Pobierz szczegóły grupy rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

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

Przykłady

Podstawowy sposób użycia

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

Uwzględnij pełne informacje o zaświadczeniu w wynikach dla grupy rejestracji klucza symetrycznego

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

Parametry wymagane

--eid --enrollment-id --gid --group-id

Identyfikator grupy rejestracji.

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iotdps-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login
wartość domyślna: key
--dps-name -n

Nazwa usługi Azure IoT Hub Device Provisioning Service. Wymagane, jeśli nie podano --login.

--keys --show-keys

Uwzględnij klucze zaświadczania i informacje w wynikach grupy rejestracji.

akceptowane wartości: false, true
--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano --dps-name.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

az iot dps enrollment-group update

Zaktualizuj grupę rejestracji w usłudze Azure IoT Hub Device Provisioning Service.

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]
                                   [--hn]
                                   [--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]

Przykłady

Zaktualizuj grupę rejestracji "{enrollment_id}" w usłudze aprowizacji usługi Azure IoT "{dps_name}" w grupie zasobów "{resource_group_name}" z początkowymi właściwościami bliźniaczej reprezentacji i początkowymi tagami bliźniaczych reprezentacji.

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=

Zaktualizuj grupę rejestracji "{enrollment_id}" w usłudze aprowizacji usługi Azure IoT "{dps_name}" w grupie zasobów "{resource_group_name}" przy użyciu nowego podstawowego certyfikatu pośredniego i usuń istniejący pomocniczy certyfikat pośredniczący.

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=

Zaktualizuj grupę rejestracji "{enrollment_id}" w usłudze aprowizacji Azure IoT "{dps_name}" w grupie zasobów "{resource_group_name}" przy użyciu nowego pomocniczego certyfikatu urzędu certyfikacji "{certificate_name}" i usuń istniejący certyfikat podstawowego urzędu certyfikacji.

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=

Zaktualizuj grupę rejestracji "{enrollment_id}" w usłudze aprowizacji Azure IoT "{dps_name}" w grupie zasobów "{resource_group_name}" przy użyciu nowego klucza podstawowego.

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=

Parametry wymagane

--eid --enrollment-id --gid --group-id

Identyfikator grupy rejestracji.

Parametry opcjonalne

--allocation-policy --ap

Typ zasad alokacji w celu określenia, w jaki sposób urządzenie jest przypisane do IoT Hub. Jeśli nie zostanie podana, zasady alokacji będą domyślnymi zasadami alokacji dla wystąpienia usługi Device Provisioning Service.

akceptowane wartości: custom, geoLatency, hashed, static
--api-version --av

Wersja interfejsu API typów usługi aprowizacji wysłanych w niestandardowym żądaniu alokacji. Minimalna obsługiwana wersja: 2018-09-01-preview.

--auth-type

Wskazuje, czy operacja powinna automatycznie wyprowadzać klucz zasad, czy używać bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iotdps-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login
wartość domyślna: key
--ca-name --cn --root-ca-name

Nazwa podstawowego certyfikatu głównego urzędu certyfikacji. Jeśli wymagane jest zaświadczenie z certyfikatem głównego urzędu certyfikacji, należy podać nazwę głównego urzędu certyfikacji.

--certificate-path --cp

Ścieżka do pliku zawierającego certyfikat podstawowy. Jeśli wymagane jest zaświadczenie za pomocą certyfikatu pośredniego, należy podać ścieżkę certyfikatu.

--dps-name -n

Nazwa usługi Azure IoT Hub Device Provisioning Service. Wymagane, jeśli nie podano opcji --login.

--edge-enabled --ee

Flaga wskazująca włączenie krawędzi.

akceptowane wartości: false, true
--etag -e

Etag lub tag jednostki odpowiadający ostatniemu stanowi zasobu. Jeśli nie podano elementu etag, zostanie użyta wartość "*".

--hn --iot-hub-host-name

Nazwa hosta IoT Hub docelowej. W przypadku podania tego parametru zasady alokacji są domyślnie statyczne.

--ih --iot-hubs

Nazwa hosta IoT Hub docelowego skojarzonego z zasadami alokacji. Użyj listy rozdzielanej spacjami dla wielu centrów IoT Hub.

--initial-twin-properties --props

Początkowe właściwości bliźniaczej reprezentacji urządzenia.

--initial-twin-tags --tags

Początkowe tagi bliźniaczej reprezentacji urządzenia.

--login -l

To polecenie obsługuje parametry połączenia jednostki z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano --dps-name.

--pk --primary-key

Podstawowy symetryczny klucz dostępu współdzielonego przechowywany w formacie base64.

--provisioning-status --ps

Włączanie lub wyłączanie wpisu rejestracji.

akceptowane wartości: disabled, enabled
--rc --remove-certificate

Flaga usuwania bieżącego certyfikatu podstawowego.

akceptowane wartości: false, true
--remove-secondary-certificate --rsc

Flaga usuwania bieżącego certyfikatu pomocniczego.

akceptowane wartości: false, true
--reprovision-policy --rp

Zasady umożliwiające określenie sposobu obsługi danych urządzenia podczas ponownej aprowizacji w innym IoT Hub.

akceptowane wartości: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--scn --secondary-ca-name --secondary-root-ca-name

Nazwa pomocniczego certyfikatu głównego urzędu certyfikacji. Jeśli wymagane jest zaświadczenie z certyfikatem głównego urzędu certyfikacji, należy podać nazwę głównego urzędu certyfikacji.

--scp --secondary-certificate-path

Ścieżka do pliku zawierającego certyfikat pomocniczy. Jeśli wymagane jest zaświadczenie za pomocą certyfikatu pośredniego, należy podać ścieżkę certyfikatu.

--secondary-key --sk

Pomocniczy symetryczny klucz dostępu współdzielonego przechowywany w formacie base64.

--webhook-url --wh

Adres URL elementu webhook funkcji platformy Azure używany na potrzeby niestandardowych żądań alokacji.