az iot hub module-twin

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-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.	Dahili	GA
az iot hub module-twin show	Modül ikizi tanımını gösterme.	Dahili	GA
az iot hub module-twin update	Modül ikizi istenen özelliklerini ve etiketlerini güncelleştirin.	Dahili	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
                               [--auth-type {key, login}]
                               [--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

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

--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-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
                              [--add]
                              [--auth-type {key, login}]
                              [--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

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

--desired

İkiz istenen özellikler.

--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: []

--tags

İkiz etiketleri.

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.