az iot hub module-identity

Not

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

IoT cihaz modüllerini yönetme.

Komutlar

Name	Description	Tür	Durum
az iot hub module-identity connection-string	IoT cihaz modülünün bağlantı dizesi yönetin.	Dahili	GA
az iot hub module-identity connection-string show	Hedef IoT cihaz modülünü bağlantı dizesi gösterin.	Dahili	GA
az iot hub module-identity create	IoT Hub'ında hedef IoT cihazında modül oluşturma.	Dahili	GA
az iot hub module-identity delete	IoT Hub'daki bir cihazı silme.	Dahili	GA
az iot hub module-identity list	IoT Hub'ında bir IoT cihazında bulunan modülleri listeleme.	Dahili	GA
az iot hub module-identity renew-key	Sas kimlik doğrulaması ile ioT Hub cihaz modülünün hedef anahtarlarını yenileyin.	Dahili	GA
az iot hub module-identity show	IoT Hub'ında IoT cihaz modülünün ayrıntılarını alın.	Dahili	GA
az iot hub module-identity update	IoT Hub cihaz modülünü güncelleştirme.	Dahili	GA

az iot hub module-identity create

IoT Hub'ında hedef IoT cihazında modül oluşturma.

shared_private_key kimlik doğrulama yöntemini (simetrik anahtarlar olarak da bilinir) kullanırken, özel anahtar sağlanmamışsa hizmet bunları modül için oluşturur.

az iot hub module-identity create --device-id
                                  --module-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--valid-days]

Gerekli Parametreler

--device-id -d

Hedef Cihaz Kimliği.

--module-id -m

Hedef Modül Kimliği.

İsteğe Bağlı Parametreler

--am --auth-method

Varlığın oluşturulacağı yetkilendirme yöntemi.

kabul edilen değerler: shared_private_key, x509_ca, x509_thumbprint

varsayılan değer: shared_private_key

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

kabul edilen değerler: key, login

varsayılan değer: key

--hub-name -n

IoT Hub adı veya ana bilgisayar adı. --login sağlanmadıysa gereklidir.

--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. --hub-name sağlanmadıysa gereklidir.

--od --output-dir

Otomatik olarak imzalanan sertifika oluşturun ve parmak izini kullanın. Belirtilen hedef dizine çıktı.

--pk --primary-key

base64 biçiminde depolanan birincil simetrik paylaşılan erişim anahtarı.

--primary-thumbprint --ptp

Birincil parmak izi için kullanılacak otomatik olarak imzalanan sertifika parmak izi.

--resource-group -g

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

--secondary-key --sk

base64 biçiminde depolanan ikincil simetrik paylaşılan erişim anahtarı.

--secondary-thumbprint --stp

İkincil parmak izi için kullanılacak otomatik olarak imzalanan sertifika parmak izi.

--valid-days --vd

Otomatik olarak imzalanan sertifika oluşturun ve parmak izini kullanın. Belirtilen gün sayısı için geçerlidir. Varsayılan: 365.

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.

--help -h

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

--only-show-errors

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

--output -o

Çıkış biçimi.

kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc

varsayılan değer: json

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayı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.

az iot hub module-identity delete

IoT Hub'daki bir cihazı silme.

az iot hub module-identity delete --device-id
                                  --module-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Gerekli Parametreler

--device-id -d

Hedef Cihaz Kimliği.

--module-id -m

Hedef Modül Kimliği.

İsteğe Bağlı Parametreler

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

kabul edilen değerler: key, login

varsayılan değer: key

--etag -e

Kaynağın son durumuna karşılık gelen etag veya varlık etiketi. Etag sağlanmadıysa '*' değeri kullanılır.

--hub-name -n

IoT Hub adı veya ana bilgisayar adı. --login sağlanmadıysa gereklidir.

--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. --hub-name sağlanmadıysa gereklidir.

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>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.

--help -h

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

--only-show-errors

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

--output -o

Çıkış biçimi.

kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc

varsayılan değer: json

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayı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.

az iot hub module-identity list

IoT Hub'ında bir IoT cihazında bulunan modülleri listeleme.

az iot hub module-identity list --device-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

Gerekli Parametreler

--device-id -d

Hedef Cihaz Kimliği.

İsteğe Bağlı Parametreler

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

kabul edilen değerler: key, login

varsayılan değer: key

--hub-name -n

IoT Hub adı veya ana bilgisayar adı. --login sağlanmadıysa gereklidir.

--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. --hub-name sağlanmadıysa gereklidir.

--resource-group -g

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

--top

Döndürülecek öğe sayısı üst sınırı. Sınırsız için -1 kullanın.

varsayılan değer: 1000

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.

--help -h

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

--only-show-errors

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

--output -o

Çıkış biçimi.

kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc

varsayılan değer: json

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayı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.

az iot hub module-identity renew-key

Sas kimlik doğrulaması ile ioT Hub cihaz modülünün hedef anahtarlarını yenileyin.

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--resource-group]

Örnekler

Birincil anahtarı yenileyin.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt primary

Birincil ve ikincil anahtarları değiştirin.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swap

Gerekli Parametreler

--device-id -d

Hedef Cihaz Kimliği.

--hub-name -n

IoT Hub adı veya ana bilgisayar adı. --login sağlanmadıysa gereklidir.

--key-type --kt

Yeniden oluşturulacak hedef anahtar türü.

kabul edilen değerler: primary, secondary, swap

--module-id -m

Hedef Modül Kimliği.

İsteğe Bağlı Parametreler

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

kabul edilen değerler: key, login

varsayılan değer: key

--etag -e

Kaynağın son durumuna karşılık gelen etag veya varlık etiketi. Etag sağlanmadıysa '*' değeri kullanılır.

--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. --hub-name sağlanmadıysa gereklidir.

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>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.

--help -h

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

--only-show-errors

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

--output -o

Çıkış biçimi.

kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc

varsayılan değer: json

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayı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.

az iot hub module-identity show

IoT Hub'ında IoT cihaz modülünün ayrıntılarını alın.

az iot hub module-identity show --device-id
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Gerekli Parametreler

--device-id -d

Hedef Cihaz Kimliği.

--module-id -m

Hedef Modül Kimliği.

İsteğe Bağlı Parametreler

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

kabul edilen değerler: key, login

varsayılan değer: key

--hub-name -n

IoT Hub adı veya ana bilgisayar adı. --login sağlanmadıysa gereklidir.

--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. --hub-name sağlanmadıysa gereklidir.

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>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.

--help -h

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

--only-show-errors

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

--output -o

Çıkış biçimi.

kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc

varsayılan değer: json

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayı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.

az iot hub module-identity update

IoT Hub cihaz modülünü güncelleştirme.

Modülü güncelleştirmek için --set ve ardından özellik atamaları kullanın. 'iot hub module-identity show'dan döndürülen özelliklerden yararlanın.

az iot hub module-identity update --device-id
                                  --module-id
                                  [--add]
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--remove]
                                  [--resource-group]
                                  [--set]

Örnekler

Modül simetrik kimlik doğrulama anahtarlarını yeniden oluşturma

az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""

Gerekli Parametreler

--device-id -d

Hedef Cihaz Kimliği.

--module-id -m

Hedef Modül Kimliği.

İsteğe Bağlı Parametreler

--add

Bir yol ve anahtar değer çiftleri belirterek nesne listesine nesne ekleyin. Örnek: --add property.listProperty <key=value, string or JSON string>.

varsayılan değer: []

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

kabul edilen değerler: key, login

varsayılan değer: key

--etag -e

Kaynağın son durumuna karşılık gelen etag veya varlık etiketi. Etag sağlanmadıysa '*' değeri kullanılır.

--force-string

'set' veya 'add' kullanırken, JSON'a dönüştürmeye çalışmak yerine dize değişmez değerlerini koruyun.

varsayılan değer: False

--hub-name -n

IoT Hub adı veya ana bilgisayar adı. --login sağlanmadıysa gereklidir.

--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. --hub-name sağlanmadıysa gereklidir.

--remove

Bir özelliği veya öğeyi listeden kaldırın. Örnek: --remove property.list <indexToRemove> OR --remove propertyToRemove.

varsayılan değer: []

--resource-group -g

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

--set

Ayarlanacağı özellik yolunu ve değerini belirterek nesneyi güncelleştirin. Örnek: --set property1.property2=<value>.

varsayılan değer: []

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.

--help -h

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

--only-show-errors

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

--output -o

Çıkış biçimi.

kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc

varsayılan değer: json

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayı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.