az iot hub module-twin

Note

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

IoT cihaz modülü ikizi yapılandırmasını yönetme.

Komutlar

Name	Description	Tür	Durum
az iot hub module-twin replace	Modül ikizi tanımını hedef json ile değiştirin.	Extension	GA
az iot hub module-twin show	Modül ikizi tanımını gösterme.	Extension	GA
az iot hub module-twin update	Modül ikizi istenen özelliklerini ve etiketlerini güncelleştirin.	Extension	GA

az iot hub module-twin replace

Modül ikizi tanımını hedef json ile değiştirin.

JSON'yi doğrudan girin veya bir dosya yolu kullanın.

az iot hub module-twin replace --device-id
                               --json
                               --module-id
                               [--acquire-policy-token]
                               [--auth-type {key, login}]
                               [--change-reference]
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Örnekler

Modül ikizlerini dosya içeriğiyle değiştirin.

az iot hub module-twin replace -d {device_id} -n {iothub_name} -m {module_name} -j ../mymodtwin.json

Gerekli Parametreler

--device-id -d

Hedef Cihaz Kimliği.

--json -j

Mevcut ikizi ile değiştirecek Json. Dosya yolu veya ham json sağlayın.

--module-id -m

Hedef Modül 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

--change-reference

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

Özellik	Değer
Parametre grubu:	Global Policy Arguments

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

Özellik	Değer
Parametre grubu:	IoT Hub Identifier 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. --hub-name sağlanmadıysa gereklidir.

Özellik	Değer
Parametre grubu:	IoT Hub Identifier 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

az iot hub module-twin show

Modül ikizi tanımını gösterme.

az iot hub module-twin 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

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.

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

--hub-name -n

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

Özellik	Değer
Parametre grubu:	IoT Hub Identifier 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. --hub-name sağlanmadıysa gereklidir.

Özellik	Değer
Parametre grubu:	IoT Hub Identifier 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

az iot hub module-twin update

Modül ikizi istenen özelliklerini ve etiketlerini güncelleştirin.

PATCH davranışı için --desired veya --tags bağımsız değişkenlerini sağlayın. Her iki parametre de satır içi json'ı veya json içeriğinin dosya yolunu destekler. Genel güncelleştirme birleştirmelerinin (yani --set) kullanımı PUT davranışını yansıtır ve kullanım dışıdır.

az iot hub module-twin update --device-id
                              --module-id
                              [--acquire-policy-token]
                              [--add]
                              [--auth-type {key, login}]
                              [--change-reference]
                              [--desired]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--tags]

Örnekler

Modül ikizi istenen özelliklere düzeltme eki uygulama.

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'

Modül ikizi etiketlerini düzeltme eki uygulama.

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --tags '{"country": "USA"}'

Json dosya içeriğiyle modül ikizi etiketlerini düzeltme eki uygulama.

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --tags /path/to/file

Üst 'sıcaklık' öğesinden 'kritik' istenen özelliğin düzeltme eki kaldırılması

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --desired '{"condition":{"temperature":{"critical": null}}}'

Gerekli Parametreler

--device-id -d

Hedef Cihaz Kimliği.

--module-id -m

Hedef Modül 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

--add

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

Özellik	Değer
Parametre grubu:	Generic Update Arguments
Default value:	[]

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

--change-reference

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

Özellik	Değer
Parametre grubu:	Global Policy Arguments

--desired

İkiz istenen özellikler.

Özellik	Değer
Parametre grubu:	Twin Patch Arguments

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

Özellik	Değer
Parametre grubu:	Generic Update Arguments
Default value:	False

--hub-name -n

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

Özellik	Değer
Parametre grubu:	IoT Hub Identifier 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. --hub-name sağlanmadıysa gereklidir.

Özellik	Değer
Parametre grubu:	IoT Hub Identifier Arguments

--remove

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

Özellik	Değer
Parametre grubu:	Generic Update Arguments
Default value:	[]

--resource-group -g

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

--set

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

Özellik	Değer
Parametre grubu:	Generic Update Arguments
Default value:	[]

--tags

İkiz etiketleri.

Özellik	Değer
Parametre grubu:	Twin Patch Arguments

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