az iot device registration

  • Önizle

Note

Bu başvuru, Azure CLI (sürüm 2.73.0 veya üzeri) için azure-iot uzantısının bir parçasıdır. uzantı, az iot device registration komutunu ilk kez çalıştırdığınızda otomatik olarak yüklenir. Uzantılar hakkında daha fazla bilgi edinin.

Bu komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

Cihazı Azure IoT Hub Cihaz Sağlama Hizmeti (DPS) aracılığıyla kaydedin.

Bireysel kayıt veya grup kaydı için oluştur'u, ardından kabul edilen kaydı izlemek için işlem durumu'nu kullanın. Cihazın simetrik anahtarı veya X.509 sertifikasıyla kimliğini doğrulama. Hizmet kayıt kayıtları ve kayıt durumu yönetimi altında az iot dpskalır.

Komutlar

Veri Akışı Adı Description Tür Durum
az iot device registration create

Bir cihazı kaydedin ve isteğe bağlı olarak işletimsel sertifikasını verin.

 Extension Preview
az iot device registration operation-status

DPS cihaz kayıt işleminin durumunu gösterin.

 Extension Preview

az iot device registration create

Önizle

'iot cihaz kaydı' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

Bir cihazı kaydedin ve isteğe bağlı olarak işletimsel sertifikasını verin.

Bireysel kayıt için cihazını --simetrik anahtar olarak sağlayın. Grup kaydı için grup anahtarını --compute-key ile sağlayın veya --compute-key olmadan zaten türetilmiş bir cihaz anahtarı sağlayın. Alternatif olarak, kimlik kapsamını/uç noktasını bulmak ve kayıt anahtarlarını almak için --dps-name ile --auth-type oturum açma bilgilerini kullanın; grup kaydı için --group-id ve --compute-key ekleyin. Entra oturum açma işlemi, cihaz kayıt isteğine değil bu önyükleme aramasını yetkiler.

DPS kaynak bulmayı atlamak için açık cihaz kimlik bilgileriyle --id-scope kullanın. Varsayılan olmayan bir sağlama uç noktası kullanırken --host değerini ayarlayın. X.509 kimlik doğrulaması için --certificate-file-path ve --key-file-path; add --passphrase yalnızca özel anahtar şifrelenirse.

İşletimsel sertifika istemek için --csr (diğer ad --csr-file-path) ekleyin. PeM veya base64 DER PKCS #10,satır içi veya dosyadan kabul eder. CSR imzası geçerli olmalı ve Ortak Adı --registration-id ile eşleşmelidir. CSR, cihazın simetrik anahtarının veya X.509 kimlik doğrulamasının yerini almaz.

Komut, kabul edilen kayıtları yoklar ve Retry-After değerini alır. İşlem kimliğini aldıktan sonra zaman aşımına uğradıysa, bu kimlik ve aynı kayıt kimliği, kimlik kapsamı, uç nokta ve cihaz kimlik doğrulaması ile işlem durumunu kullanın. Zaman aşımı arka uç işlemini iptal etmez; oluşturmayı körü körüne yeniden çalıştırmayın. --zaman aşımı, hem CSR hem de CSR dışı kayıt için ön kimlik kapsamı ve önyükleme kimlik bilgisi bulma işleminden sonra çalışan başlatma, HTTP yeniden denemeleri ve yoklama dahil olmak üzere aynı REST akışına sabit bir son tarih uygular. --timeout olmadan, mevcut sınırlanmış beş dakikalık yoklama davranışı korunur.

JSON çıkışı, DPS döndürdüğünde verilenCertificateChain ve connectionProfile değerlerini ve Kayıt Defteri Cihazı bağıntısı için registryDeviceExternalId değerini korur. 2026-11-02-preview RegisterDeviceAndIssueCertificate sözleşmesi, verilenCertificateChain'i yalnızca bayt dizisi olarak açıklar ve kablo kodlamasını veya sertifika sırasını tanımlamaz. Sonuç olarak, bu komut JSON çıkışında bu alanı korur ancak bir sertifika dosyası çıkış seçeneği sunmaz; tahmin edilen bir zincir yazmak TLS'ye hazır olmayan veya yanlış sıralanmış bir paket üretebilir. --endorsement-key ve --storage-root-key gelişmiş istek-şeması alanları olarak korunur, ancak bu sözleşme istemci TPM sınama protokolü sağlamadığından yalnızca TPM kimlik doğrulaması açıkça desteklenmez.

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]

Örnekler

Entra-authorized bootstrap key lookup kullanarak tek bir kaydı kaydetme

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

Entra yetkili önyükleme anahtarı arama kullanarak grup üyesi kaydetme

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

Bootstrap araması olmadan bir cihaz anahtarına ve bilinen kimlik kapsamına kaydolma

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

Kayıt grubu anahtarından cihaz anahtarı türetme ve kaydetme

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

PEM CSR'den işlem sertifikası kaydetme ve isteme

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

X.509 cihaz sertifikasına kaydolma

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

Gerekli Parametreler

--registration-id --rid

Cihaz kayıt kimliği veya bireysel kayıt kimliği.

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.

Özellik Değer
Parametre grubu: Global Policy Arguments
--auth-type

İşlemin bir ilke anahtarını otomatik olarak türetmesi mi yoksa geçerli Azure AD oturumunu mu kullanması gerektiğini gösterir. Kimlik doğrulama türü oturum açma bilgisiyse ve kaynak ana bilgisayar adı sağlanmışsa, gerekmedikçe kaynak araması atlanır. kullanarak varsayılanı az configure --defaults iothub-data-auth-type={auth-type-value}yapılandırabilirsiniz.

Özellik Değer
Parametre grubu: Access Control Arguments
Default value: key
Kabul edilen değerler: key, login
--certificate-file-path --cp

Sertifika PEM dosyasının yolu. x509 kayıtları için gereklidir.

Özellik Değer
Parametre grubu: x509 Authentication Arguments
--change-reference

Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.

Özellik Değer
Parametre grubu: Global Policy Arguments
--ck --compute-key

--simetrik anahtardan veya --dps-name/--login ile --group-id ile çözümlenen kayıt grubu anahtarından cihaz başına anahtarı hesaplayın. X.509 girişleri ile birleştirilemez.

Özellik Değer
Parametre grubu: Symmetric Key Authentication Arguments
Default value: False
--csr --csr-file-path

Satır içi PEM/base64 DER PKCS #10 CSR veya CSR dosyasının yolu. İmzasının geçerli olması ve Ortak Ad'ın kayıt kimliğiyle eşleşmesi gerekir. İstek, PEM üst bilgileri olmadan base64 DER gönderir.

Özellik Değer
Parametre grubu: Certificate Issuance Arguments
--dps-name -n

Azure IoT Hub Cihaz Sağlama Hizmeti'nin adı. --login sağlanmadıysa veya authenticaton bağımsız değişkenleri ve --id-scope sağlanmadıysa gereklidir.

Özellik Değer
Parametre grubu: DPS Identifier Arguments
--endorsement-key

Hizmet şeması tarafından tutulan gelişmiş TPM isteği alanı. --storage-root-key ile kullanılmalıdır. Yalnızca TPM istemci kimlik doğrulaması bu komut tarafından desteklenmez.

Özellik Değer
Parametre grubu: TPM Arguments
--enrollment-group-id --gid --group-id

Kayıt grubu kimliği. Yalnızca kimlik doğrulama bağımsız değişkenlerini almak için gereklidir.

--host --provisioning-host

DPS cihaz uç noktası. Atlandığında, uç nokta seçilen DPS kaynağından türetilir ve ardından genel uç noktaya geri döner.

--id-scope --scope

Azure IoT Hub Cihaz Sağlama Hizmeti'nin kimlik kapsamı. Kimlik kapsamı bir cihaz uç noktasını tanımlamaz: --dps-name veya --login yine de sağlandığında çözümlenir. Yalnızca --id-scope ve açık cihaz kimlik bilgileriyle, belgelenen genel uç nokta geri dönüşü kullanılır.

Özellik Değer
Parametre grubu: DPS Identifier Arguments
--key --symmetric-key

Cihaz kaydı için simetrik paylaşılan erişim anahtarı.

Özellik Değer
Parametre grubu: Symmetric Key Authentication Arguments
--key-file-path --kp

Anahtar PEM dosyasının yolu. x509 kayıtları için gereklidir.

Özellik Değer
Parametre grubu: x509 Authentication Arguments
--login -l

Bu komut, eylem gerçekleştirme haklarına sahip bir varlık bağlantı dizesi destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık bağlantı dizesi hem de ad sağlanırsa, bağlantı dizesi öncelik alır. --dps-name sağlanmadıysa veya authenticaton bağımsız değişkenleri ve --id-scope sağlanmadıysa gereklidir.

Özellik Değer
Parametre grubu: DPS Identifier Arguments
--pass --passphrase

X.509 özel anahtarı için parola. Yalnızca hem --certificate-file-path hem de --key-file-path ile geçerlidir.

Özellik Değer
Parametre grubu: x509 Authentication Arguments
--payload

JSON nesnesi veya JSON dosyasının yolu olarak kayıt yükü.

--resource-group -g

Kaynak grubunun adı. az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.

--storage-root-key

Hizmet şeması tarafından tutulan gelişmiş TPM isteği alanı. --endorsement-key ile kullanılmalıdır. Yalnızca TPM istemci kimlik doğrulaması bu komut tarafından desteklenmez.

Özellik Değer
Parametre grubu: TPM Arguments
--timeout

Çalışan başlatma, HTTP ve yoklama dahil olmak üzere saniyeler içinde pozitif tamsayı sabit REST kaydı zaman aşımı. Ön kimlik kapsamını ve önyükleme kimlik bilgisi bulmayı dışlar.

Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

Özellik Değer
Default value: False
--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

Özellik Değer
Default value: False
--output -o

Çıkış biçimi.

Özellik Değer
Default value: json
Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

Özellik Değer
Default value: False

az iot device registration operation-status

Önizle

'iot cihaz kaydı' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

DPS cihaz kayıt işleminin durumunu gösterin.

DPS tarafından döndürülen veya zaman aşımından sonra oluşturma tarafından bildirilen işlem kimliğini sağlayın. Kayıt kimliğini, kimlik kapsamını (veya DPS adını) yeniden kullanın, oluşturma işleminden ana bilgisayar ve cihaz kimlik doğrulaması sağlayın. Bu, yeni bir kayıt değil, durum okumadır.

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]

Örnekler

Bootstrap anahtarı araması ile tek bir kaydı izleme

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

Aynı grup anahtarına ve sağlama konağına sahip bir grup üyesini izleme

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

Kayıt yeniden göndermeden zaman aşımının ardından kabul edilen işlemi izleme

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

Gerekli Parametreler

--operation-id

Oluşturma tarafından döndürülen kayıt işlemi tanımlayıcısı.

--registration-id --rid

Cihaz kayıt kimliği veya bireysel kayıt kimliği.

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.

Özellik Değer
Parametre grubu: Global Policy Arguments
--auth-type

İşlemin bir ilke anahtarını otomatik olarak türetmesi mi yoksa geçerli Azure AD oturumunu mu kullanması gerektiğini gösterir. Kimlik doğrulama türü oturum açma bilgisiyse ve kaynak ana bilgisayar adı sağlanmışsa, gerekmedikçe kaynak araması atlanır. kullanarak varsayılanı az configure --defaults iothub-data-auth-type={auth-type-value}yapılandırabilirsiniz.

Özellik Değer
Parametre grubu: Access Control Arguments
Default value: key
Kabul edilen değerler: key, login
--certificate-file-path --cp

Sertifika PEM dosyasının yolu. x509 kayıtları için gereklidir.

Özellik Değer
Parametre grubu: x509 Authentication Arguments
--change-reference

Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.

Özellik Değer
Parametre grubu: Global Policy Arguments
--ck --compute-key

--simetrik anahtardan veya --dps-name/--login ile --group-id ile çözümlenen kayıt grubu anahtarından cihaz başına anahtarı hesaplayın. X.509 girişleri ile birleştirilemez.

Özellik Değer
Parametre grubu: Symmetric Key Authentication Arguments
Default value: False
--dps-name -n

Azure IoT Hub Cihaz Sağlama Hizmeti'nin adı. --login sağlanmadıysa veya authenticaton bağımsız değişkenleri ve --id-scope sağlanmadıysa gereklidir.

Özellik Değer
Parametre grubu: DPS Identifier Arguments
--enrollment-group-id --gid --group-id

Kayıt grubu kimliği. Yalnızca kimlik doğrulama bağımsız değişkenlerini almak için gereklidir.

--host --provisioning-host

DPS cihaz uç noktası. Atlandığında, uç nokta seçilen DPS kaynağından türetilir ve ardından genel uç noktaya geri döner.

--id-scope --scope

Azure IoT Hub Cihaz Sağlama Hizmeti'nin kimlik kapsamı. Kimlik kapsamı bir cihaz uç noktasını tanımlamaz: --dps-name veya --login yine de sağlandığında çözümlenir. Yalnızca --id-scope ve açık cihaz kimlik bilgileriyle, belgelenen genel uç nokta geri dönüşü kullanılır.

Özellik Değer
Parametre grubu: DPS Identifier Arguments
--key --symmetric-key

Cihaz kaydı için simetrik paylaşılan erişim anahtarı.

Özellik Değer
Parametre grubu: Symmetric Key Authentication Arguments
--key-file-path --kp

Anahtar PEM dosyasının yolu. x509 kayıtları için gereklidir.

Özellik Değer
Parametre grubu: x509 Authentication Arguments
--login -l

Bu komut, eylem gerçekleştirme haklarına sahip bir varlık bağlantı dizesi destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık bağlantı dizesi hem de ad sağlanırsa, bağlantı dizesi öncelik alır. --dps-name sağlanmadıysa veya authenticaton bağımsız değişkenleri ve --id-scope sağlanmadıysa gereklidir.

Özellik Değer
Parametre grubu: DPS Identifier Arguments
--pass --passphrase

X.509 özel anahtarı için parola. Yalnızca hem --certificate-file-path hem de --key-file-path ile geçerlidir.

Özellik Değer
Parametre grubu: x509 Authentication Arguments
--resource-group -g

Kaynak grubunun adı. az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.

Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

Özellik Değer
Default value: False
--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

Özellik Değer
Default value: False
--output -o

Çıkış biçimi.

Özellik Değer
Default value: json
Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

Özellik Değer
Default value: False