az iot device registration

  • Wersja Preview

Note

To odwołanie jest częścią rozszerzenia azure-iot dla Azure CLI (wersja 2.73.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

Rejestrowanie urządzenia za pomocą usługi Azure IoT Hub Device Provisioning Service (DPS).

Utwórz rejestrację indywidualną lub grupową, a następnie stan operacji, aby postępować zgodnie z zaakceptowaną rejestracją. Uwierzytelnij urządzenie przy użyciu klucza symetrycznego lub certyfikatu X.509. Rekordy rejestracji usługi i administracja stanem rejestracji pozostają w obszarze az iot dps.

Polecenia

Nazwisko Opis Typ Stan
az iot device registration create

Zarejestruj urządzenie i opcjonalnie wystaw certyfikat operacyjny.

 Extension Preview
az iot device registration operation-status

Pokaż stan operacji rejestracji urządzenia usługi DPS.

 Extension Preview

az iot device registration create

Wersja Preview

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 i opcjonalnie wystaw certyfikat operacyjny.

W przypadku rejestracji indywidualnej podaj jego urządzenie — klucz symetryczny. W przypadku rejestracji grupy podaj klucz grupy z kluczem --compute-key lub podaj już pochodny klucz urządzenia bez klucza --compute-key. Alternatywnie użyj parametru --dps-name z identyfikatorem logowania typu --auth, aby odnaleźć zakres identyfikatora/punkt końcowy i pobrać klucze rejestracji; dodaj --group-id i --compute-key na potrzeby rejestracji grupy. Entra login autoryzuje to wyszukiwanie bootstrap, a nie żądanie rejestracji urządzenia.

Użyj --id-scope z jawnymi poświadczeniami urządzenia, aby pominąć odnajdywanie zasobów usługi DPS. Ustaw --host podczas korzystania z innego niż domyślnego punktu końcowego aprowizacji. W przypadku uwierzytelniania X.509 podaj ścieżkę --certificate-file-path i --key-file-path; dodaj hasło --passphrase tylko wtedy, gdy klucz prywatny jest zaszyfrowany.

Dodaj polecenie --csr (alias --csr-file-path), aby zażądać certyfikatu operacyjnego. Akceptuje PEM lub base64 DER PKCS #10, wbudowany lub z pliku. Podpis CSR musi być prawidłowy, a jego nazwa pospolita musi być zgodna z --registration-id. Uwierzytelnianie CSR nie zastępuje uwierzytelniania symetrycznego lub X.509 urządzenia.

Polecenie sonduje zaakceptowane rejestracje, honorując polecenie Ponów próbę po. Jeśli upłynął limit czasu po otrzymaniu identyfikatora operacji, użyj stanu operacji z tym identyfikatorem i tym samym identyfikatorem rejestracji, zakresem identyfikatora, punktem końcowym i uwierzytelnianiem urządzenia. Limit czasu nie powoduje anulowania operacji zaplecza; nie należy ponownie uruchamiać ponownie. --limit czasu stosuje twardy termin do tego samego przepływu REST dla rejestracji CSR i innej niż CSR, w tym uruchamiania procesu roboczego, ponawiania prób HTTP i sondowania, po wstępnym zakresie identyfikatora i odnajdowaniu poświadczeń bootstrap. Bez --timeout istniejące ograniczone pięciominutowe zachowanie sondowania jest zachowywane.

Dane wyjściowe JSON zachowują wystawione certyfikatyCertificateChain i connectionProfile, gdy program DPS je zwraca, oraz registryDeviceExternalId dla korelacji urządzenia rejestru. Kontrakt 2026-11-02-preview RegisterDeviceAndIssueCertificate opisuje wystawiony certyfikatCertificateChain tylko jako tablicę bajtów i nie definiuje kodowania przewodu ani zamówienia certyfikatu. W związku z tym to polecenie zachowuje to pole w danych wyjściowych JSON, ale nie oferuje opcji danych wyjściowych pliku certyfikatu; pisanie odgadniętych łańcuchów może spowodować, że pakiet nie jest gotowy do użycia z protokołem TLS lub niepoprawnie uporządkowany. --endorsement-key i --storage-root-key są zachowywane jako zaawansowane pola schematu żądania, ale uwierzytelnianie tylko modułu TPM jest jawnie nieobsługiwane, ponieważ ten kontrakt nie zapewnia protokołu wyzwania modułu TPM klienta.

az iot device registration create --registration-id --rid
                                  [--acquire-policy-token]
                                  [--auth-type {key, login}]
                                  [--certificate-file-path --cp]
                                  [--change-reference]
                                  [--ck --compute-key]
                                  [--csr --csr-file-path]
                                  [--dps-name]
                                  [--endorsement-key]
                                  [--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]
                                  [--storage-root-key]
                                  [--timeout]

Przykłady

Rejestrowanie rejestracji indywidualnej przy użyciu wyszukiwania klucza bootstrap autoryzowanego przez firmę Entra

az iot device registration create --dps-name MyDps --resource-group MyResourceGroup \
  --registration-id device-01 --auth-type login

Rejestrowanie członka grupy przy użyciu wyszukiwania klucza bootstrap autoryzowanego przez firmę Entra

az iot device registration create --dps-name MyDps --registration-id device-01 \
  --group-id MyEnrollmentGroup --compute-key --auth-type login

Rejestrowanie przy użyciu klucza urządzenia i znanego zakresu identyfikatorów bez wyszukiwania bootstrap

az iot device registration create --id-scope 0ne00000000 \
  --registration-id device-01 --symmetric-key DEVICE_KEY

Uzyskiwanie klucza urządzenia z klucza grupy rejestracji i rejestrowanie

az iot device registration create --id-scope 0ne00000000 \
  --registration-id device-01 --symmetric-key GROUP_KEY --compute-key

Rejestrowanie i żądanie certyfikatu operacyjnego z żądania csr PEM

az iot device registration create --id-scope 0ne00000000 --registration-id device-01 \
  --symmetric-key DEVICE_KEY --csr ./device-01.csr --timeout 120

Rejestrowanie przy użyciu certyfikatu urządzenia X.509

az iot device registration create --id-scope 0ne00000000 \
  --registration-id device-01 --certificate-file-path ./device.pem \
  --key-file-path ./device-key.pem

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.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji 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
--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

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

Oblicz klucz per-device z --symmetric-key lub z klucza enrollment-group rozpoznanego przez parametr --group-id z parametrem --dps-name/-login. Nie można połączyć z wejściami X.509.

Właściwość Wartość
Grupa parametrów: Symmetric Key Authentication Arguments
Domyślna wartość: False
--csr --csr-file-path

Wbudowany plik PEM/base64 DER PKCS #10 CSR lub ścieżka do pliku CSR. Jego podpis musi być prawidłowy, a nazwa pospolita musi być zgodna z identyfikatorem rejestracji. Żądanie wysyła nagłówki base64 DER bez nagłówków PEM.

Właściwość Wartość
Grupa parametrów: Certificate Issuance Arguments
--dps-name -n

Nazwa usługi Azure IoT Hub Device Provisioning Service. 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
--endorsement-key

Zaawansowane pole żądania modułu TPM przechowywane przez schemat usługi. Musi być używany z kluczem --storage-root-key. Uwierzytelnianie klienta tylko w module TPM nie jest obsługiwane przez to polecenie.

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

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

--host --provisioning-host

Punkt końcowy urządzenia usługi DPS. Po pominięciu punkt końcowy pochodzi z wybranego zasobu usługi DPS, a następnie wraca do globalnego punktu końcowego.

--id-scope --scope

Zakres identyfikatorów usługi Azure IoT Hub Device Provisioning Service. Zakres identyfikatora nie identyfikuje punktu końcowego urządzenia: --dps-name lub --login jest nadal rozpoznawany po podaniu. W przypadku tylko poświadczeń --id-scope i jawnego urządzenia używany jest udokumentowany globalny rezerwowy punkt końcowy.

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 jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma 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 klucza prywatnego X.509. Prawidłowy tylko w przypadku ścieżki --certificate-file-path i --key-file-path.

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

Ładunek rejestracji jako obiekt JSON lub ścieżka do pliku JSON.

--resource-group -g

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

--storage-root-key

Zaawansowane pole żądania modułu TPM przechowywane przez schemat usługi. Należy używać z kluczem --endorsement-key. Uwierzytelnianie klienta tylko w module TPM nie jest obsługiwane przez to polecenie.

Właściwość Wartość
Grupa parametrów: TPM Arguments
--timeout

Dodatnia liczba całkowita twardego limitu czasu rejestracji REST w sekundach, w tym uruchamianie procesu roboczego, protokół HTTP i sondowanie. Wyklucza wstępny zakres identyfikatorów i odnajdywanie poświadczeń bootstrap.

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

az iot device registration operation-status

Wersja Preview

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

Pokaż stan operacji rejestracji urządzenia usługi DPS.

Podaj identyfikator operacji zwrócony przez usługę DPS lub zgłoszony przez utworzenie po przekroczeniu limitu czasu. Użyj ponownie identyfikatora rejestracji, zakresu identyfikatora (lub nazwy usługi DPS), aprowizacji hosta i uwierzytelniania urządzenia na podstawie tworzenia. Jest to stan odczytany, a nie nowa rejestracja.

az iot device registration operation-status --operation-id
                                            --registration-id --rid
                                            [--acquire-policy-token]
                                            [--auth-type {key, login}]
                                            [--certificate-file-path --cp]
                                            [--change-reference]
                                            [--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]
                                            [--resource-group]

Przykłady

Obserwowanie indywidualnej rejestracji przy użyciu wyszukiwania klucza bootstrap

az iot device registration operation-status --dps-name MyDps \
  --registration-id device-01 --operation-id OPERATION_ID --auth-type login

Obserwowanie członka grupy przy użyciu tego samego klucza grupy i hosta aprowizacji

az iot device registration operation-status --id-scope 0ne00000000 \
  --registration-id device-01 --operation-id OPERATION_ID \
  --symmetric-key GROUP_KEY --compute-key --host MyProvisioningHost

Postępuj zgodnie z zaakceptowaną operacją po przekroczeniu limitu czasu bez ponownego anulowania rejestracji

az iot device registration operation-status --id-scope 0ne00000000 \
  --registration-id device-01 --operation-id OPERATION_ID --symmetric-key DEVICE_KEY

Parametry wymagane

--operation-id

Identyfikator operacji rejestracji zwrócony przez utworzenie.

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

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji 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
--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

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

Oblicz klucz per-device z --symmetric-key lub z klucza enrollment-group rozpoznanego przez parametr --group-id z parametrem --dps-name/-login. Nie można połączyć z wejściami X.509.

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 Service. 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 urządzenia usługi DPS. Po pominięciu punkt końcowy pochodzi z wybranego zasobu usługi DPS, a następnie wraca do globalnego punktu końcowego.

--id-scope --scope

Zakres identyfikatorów usługi Azure IoT Hub Device Provisioning Service. Zakres identyfikatora nie identyfikuje punktu końcowego urządzenia: --dps-name lub --login jest nadal rozpoznawany po podaniu. W przypadku tylko poświadczeń --id-scope i jawnego urządzenia używany jest udokumentowany globalny rezerwowy punkt końcowy.

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 jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma 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 klucza prywatnego X.509. Prawidłowy tylko w przypadku ścieżki --certificate-file-path i --key-file-path.

Właściwość Wartość
Grupa parametrów: x509 Authentication Arguments
--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