az iot dps enrollment

Uwaga

Ta dokumentacja jest częścią rozszerzenia azure-iot dla interfejsu wiersza polecenia platformy Azure (wersja 2.30.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az iot dps enrollment . Dowiedz się więcej o rozszerzeniach.

Zarządzanie rejestracjami poszczególnych urządzeń w usłudze Azure IoT Hub Device Provisioning Service.

Polecenia

az iot dps enrollment create

Utwórz rejestrację poszczególnych urządzeń w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment delete

Usuń rejestrację poszczególnych urządzeń w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment list

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

az iot dps enrollment registration

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

az iot dps enrollment registration delete

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

az iot dps enrollment registration show

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

az iot dps enrollment show

Pobierz szczegóły rejestracji poszczególnych urządzeń w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment update

Zaktualizuj rejestrację poszczególnych urządzeń w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment create

Utwórz rejestrację poszczególnych urządzeń w usłudze Azure IoT Hub Device Provisioning Service.

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

Przykłady

Utwórz rejestrację "{enrollment_id}" z typem zaświadczania "x509" w usłudze Azure IoT Device Provisioning Service "{dps_name}" w grupie zasobów {resource_group_name}" ze stanem aprowizacji "disabled", identyfikator urządzenia "{device_id}", właściwości początkowej reprezentacji bliźniaczej "{"location":{"region":"US"}}", początkowe tagi bliźniaczych reprezentacji "{"version":"1"}" i informacje o urządzeniu "{"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}

Utwórz rejestrację "MyEnrollment" z typem zaświadczania "tpm" w usłudze Azure IoT Device Provisioning Service "{dps_name}" w grupie zasobów {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

Utwórz rejestrację "MyEnrollment" z typem zaświadczania "symmetrickey" w usłudze Azure IoT Device Provisioning Service "{dps_name}" w grupie zasobów {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}

Utwórz rejestrację "MyEnrollment" przy użyciu ponownej aprowizacji w usłudze Azure IoT Device Provisioning "{dps_name}" w grupie zasobów {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

Utwórz rejestrację "MyEnrollment" ze statycznymi zasadami alokacji w usłudze Azure IoT Device Provisioning "{dps_name}" w grupie zasobów {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}

Utwórz rejestrację "MyEnrollment" przy użyciu zasad alokacji skrótów i wielu centrów w usłudze Azure IoT Device Provisioning "{dps_name}" w grupie zasobów {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}"

Utwórz rejestrację "MyEnrollment" z niestandardowymi zasadami alokacji,

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}

Parametry wymagane

--at --attestation-type

Mechanizm zaświadczania używany do uwierzytelniania w usłudze DPS.

akceptowane wartości: symmetricKey, tpm, x509
--eid --enrollment-id

Identyfikator rejestracji poszczególnych urządzeń.

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
--certificate-path --cp

Ścieżka do pliku zawierającego certyfikat podstawowy. Wymagane podczas wybierania x509 jako typu zaświadczania i nie podano ścieżki certyfikatu pomocniczego.

--device-id -d

Identyfikator urządzenia zarejestrowany w IoT Hub.

--device-information --info

Opcjonalne informacje o urządzeniu.

--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
--ek --endorsement-key

Klucz poręczenia modułu TPM dla urządzenia TPM. Podczas wybierania modułu tpm jako typu zaświadczania wymagany jest klucz poręczenia.

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

--scp --secondary-certificate-path

Ścieżka do pliku zawierającego certyfikat pomocniczy. Wymagane podczas wybierania x509 jako typu zaświadczania i nie podano podstawowej ścieżki 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 delete

Usuń rejestrację poszczególnych urządzeń w usłudze Azure IoT Hub Device Provisioning Service.

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

Parametry wymagane

--eid --enrollment-id

Identyfikator rejestracji poszczególnych urządzeń.

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 list

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

az iot dps enrollment 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 show

Pobierz szczegóły rejestracji poszczególnych urządzeń w usłudze Azure IoT Hub Device Provisioning Service.

az iot dps enrollment 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 show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}

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

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

Parametry wymagane

--eid --enrollment-id

Identyfikator rejestracji poszczególnych urządzeń.

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 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 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 update

Zaktualizuj rejestrację poszczególnych urządzeń w usłudze Azure IoT Hub Device Provisioning Service.

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]
                             [--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]
                             [--scp]
                             [--secondary-key]
                             [--webhook-url]

Przykłady

Zaktualizuj rejestrację "{enrollment_id}" przy użyciu nowego certyfikatu x509 w usłudze Azure IoT Device Provisioning Service "{dps_name}" w grupie zasobów {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=

Zaktualizuj rejestrację "{enrollment_id}" przy użyciu nowego klucza poręczenia w usłudze Azure IoT Device Provisioning Service "{dps_name}" w grupie zasobów {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=

Zaktualizuj rejestrację "{enrollment_id}" przy użyciu nowego klucza podstawowego w usłudze Azure IoT Device Provisioning Service "{dps_name}" w grupie zasobów {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=

Zaktualizuj rejestrację "{enrollment_id}" przy użyciu nowego typu ponownej aprowizacji w usłudze Azure IoT Device Provisioning Service "{dps_name}" w grupie zasobów {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=

Zaktualizuj rejestrację "{enrollment_id}" przy użyciu nowych zasad alokacji w usłudze Azure IoT Device Provisioning Service "{dps_name}" w grupie zasobów {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}"

Zaktualizuj rejestrację "{enrollment_id}" w usłudze Azure IoT Device Provisioning Service "{dps_name}" w grupie zasobów {resource_group_name} z właściwościami początkowej reprezentacji bliźniaczej "{"location":{"region":"USA"}", początkowe tagi bliźniaczych "{"version":"2"}" i informacje o urządzeniu "{"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'}"

Parametry wymagane

--eid --enrollment-id

Identyfikator rejestracji poszczególnych urządzeń.

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ł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
--certificate-path --cp

Ścieżka do pliku zawierającego certyfikat podstawowy.

--device-id -d

Identyfikator urządzenia zarejestrowany w IoT Hub.

--device-information --info

Opcjonalne informacje o urządzeniu.

--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
--ek --endorsement-key

Klucz poręczenia modułu TPM dla urządzenia TPM.

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

--scp --secondary-certificate-path

Ścieżka do pliku zawierającego certyfikat pomocniczy.

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