Udostępnij przez


az iot device registration

Note

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

Ta grupa poleceń jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Zarządzanie rejestracjami urządzeń IoT dla usługi IoT Device Provisioning.

Użyj az iot dps enrollment registration lub az iot dps enrollment-group registration , aby wyświetlić i usunąć rejestracje.

Polecenia

Nazwa Opis Typ Stan
az iot device registration create

Zarejestruj urządzenie IoT w usłudze IoT Device Provisioning Service.

Extension Preview

az iot device registration create

Wersja zapoznawcza

Grupa poleceń "rejestracja urządzenia iot" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Zarejestruj urządzenie IoT w usłudze IoT Device Provisioning Service.

Obsługiwane są następujące mechanizmy zaświadczania:

  • Klucz symetryczny
  • Certyfikat x509 W przypadku używania metod uwierzytelniania x509 należy podać pliki certyfikatu i klucza (i hasło, jeśli to konieczne).
az iot device registration create --registration-id --rid
                                  [--auth-type {key, login}]
                                  [--certificate-file-path --cp]
                                  [--ck --compute-key]
                                  [--dps-name]
                                  [--enrollment-group-id --gid --group-id]
                                  [--host --provisioning-host]
                                  [--id-scope --scope]
                                  [--key --symmetric-key]
                                  [--key-file-path --kp]
                                  [--login]
                                  [--pass --passphrase]
                                  [--payload]
                                  [--resource-group]

Przykłady

Rejestrowanie urządzenia IoT przy użyciu rejestracji indywidualnej.

az iot device registration create -n {dps_name} --rid {registration_id}

Rejestrowanie urządzenia IoT przy użyciu rejestracji grupowej.

az iot device registration create -n {dps_name} --rid {registration_id} --gid {group_enrollment_id}

Zarejestruj urządzenie IoT przy użyciu rejestracji indywidualnej, zakresu identyfikatora usługi Device Provisioning i podanego klucza symetrycznego. Spowoduje to obejście pobierania zakresu identyfikatorów i klucza symetrycznego rejestracji individal.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --key {symmetric_key}

Zarejestruj urządzenie IoT przy użyciu rejestracji grupy, zakresu identyfikatora usługi Device Provisioning i podanego klucza symetrycznego grupy rejestracji. Spowoduje to obejście pobierania zakresu identyfikatorów i klucza symetrycznego grupy rejestracji. Klucz symetryczny używany do rejestracji urządzenia zostanie obliczony na podstawie danego klucza symetrycznego.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --gid {group_enrollment_id} --key {symmetric_key} --ck

Zarejestruj urządzenie IoT przy użyciu rejestracji grupy, zakresu identyfikatora usługi Device Provisioning i podanego klucza symetrycznego. Spowoduje to obejście pobierania zakresu identyfikatorów. Należy pamiętać, że ponieważ klucz symetryczny powinien być obliczonym kluczem urządzenia, identyfikator grupy rejestracji nie jest wymagany.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --key {symmetric_key}

Zarejestruj urządzenie IoT przy użyciu rejestracji indywidualnej, zakresu identyfikatora usługi Device Provisioning oraz podanego certyfikatu i plików kluczy. Spowoduje to obejście pobierania zakresu identyfikatorów.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file}

Zarejestruj urządzenie IoT przy użyciu rejestracji indywidualnej, zakresu identyfikatora usługi Device Provisioning oraz podanego certyfikatu i plików kluczy oraz hasła dla pliku klucza. Spowoduje to obejście pobierania zakresu identyfikatorów.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file} --pass {passphrase}

Zarejestruj urządzenie IoT przy użyciu rejestracji grupowej, zakresu identyfikatora usługi Device Provisioning oraz danych plików certyfikatu i klucza. Spowoduje to obejście pobierania zakresu identyfikatorów. Należy pamiętać, że identyfikator rejestracji grupy nie jest wymagany w przypadku zaświadczeń x509, a temat pliku certyfikatu jest identyfikatorem rejestracji.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file}

Parametry wymagane

--registration-id --rid

Identyfikator rejestracji urządzenia lub identyfikator rejestracji indywidualnej.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. Wartość domyślną można skonfigurować przy użyciu az configure --defaults iothub-data-auth-type={auth-type-value}.

Właściwość Wartość
Grupa parametrów: Access Control Arguments
Domyślna wartość: key
Dopuszczalne wartości: key, login
--certificate-file-path --cp

Ścieżka do pliku PEM certyfikatu. Wymagane do rejestracji x509.

Właściwość Wartość
Grupa parametrów: x509 Authentication Arguments
--ck --compute-key

Flaga wskazująca, że klucz symetryczny rejestracji urządzenia powinien zostać obliczony z danego klucza z kluczem --symmetric-key.

Właściwość Wartość
Grupa parametrów: Symmetric Key Authentication Arguments
Domyślna wartość: False
--dps-name -n

Nazwa usługi Azure IoT Hub Device Provisioning. Wymagane, jeśli nie podano argumentów --login lub nie podano argumentów authenticaton i --id-scope.

Właściwość Wartość
Grupa parametrów: DPS Identifier Arguments
--enrollment-group-id --gid --group-id

Identyfikator grupy rejestracji. Wymagane tylko do pobrania argumentów uwierzytelniania.

--host --provisioning-host

Punkt końcowy wskazujący host aprowizacji do użycia.

Właściwość Wartość
Domyślna wartość: global.azure-devices-provisioning.net
--id-scope --scope

Zakres identyfikatora usługi Azure IoT Hub Device Provisioning. W przypadku podania argumentów uwierzytelniania uniknie logowania do sesji.

Właściwość Wartość
Grupa parametrów: DPS Identifier Arguments
--key --symmetric-key

Symetryczny klucz dostępu współdzielonego na potrzeby rejestracji urządzenia.

Właściwość Wartość
Grupa parametrów: Symmetric Key Authentication Arguments
--key-file-path --kp

Ścieżka do pliku PEM klucza. Wymagane do rejestracji x509.

Właściwość Wartość
Grupa parametrów: x509 Authentication Arguments
--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 argumentów --dps-name ani argumentów authenticaton i --id-scope.

Właściwość Wartość
Grupa parametrów: DPS Identifier Arguments
--pass --passphrase

Hasło certyfikatu.

Właściwość Wartość
Grupa parametrów: x509 Authentication Arguments
--payload

Niestandardowy ładunek alokacji jako JSON. Specjalnie do użycia z niestandardowymi zasadami alokacji przy użyciu usługi Azure Functions.

--resource-group -g

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

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False