az iot hub configuration

Not

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

Büyük ölçekte IoT otomatik cihaz yönetimi yapılandırmasını yönetin.

Komutlar

Name	Description	Tür	Durum
az iot hub configuration create	Hedef IoT Hub'da bir IoT otomatik cihaz yönetimi yapılandırması oluşturun.	Dahili	GA
az iot hub configuration delete	IoT cihaz yapılandırmasını silin.	Dahili	GA
az iot hub configuration list	IoT Hub'ında IoT otomatik cihaz yönetimi yapılandırmalarını listeleme.	Dahili	GA
az iot hub configuration show	IoT otomatik cihaz yönetimi yapılandırmasının ayrıntılarını alın.	Dahili	GA
az iot hub configuration show-metric	IoT cihaz yapılandırmasında tanımlanan hedef kullanıcı veya sistem ölçümünü değerlendirin.	Dahili	GA
az iot hub configuration update	IoT otomatik cihaz yönetimi yapılandırmasının belirtilen özelliklerini güncelleştirin.	Dahili	GA

az iot hub configuration create

Hedef IoT Hub'da bir IoT otomatik cihaz yönetimi yapılandırması oluşturun.

Yapılandırma içeriği json'dır ve cihaz veya modül amacına göre küçük farklılıklar gösterir.

Cihaz yapılandırmaları {"deviceContent":{...}} biçimindedir veya {"content":{"deviceContent":{...}}}

Modül yapılandırmaları {"moduleContent":{...}} biçimindedir veya {"content":{"moduleContent":{...}}}

Yapılandırmalar, isteğe bağlı değerlendirme için kullanıcı tarafından sağlanan ölçümlerle tanımlanabilir. Kullanıcı ölçümleri json ve {"queries":{...}} biçimindedir veya {"metrics":{"queries":{...}}}.

Not: Modüllerin hedef koşulu "devices.modules where adresinden" ile başlamalıdır.

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--cl]
                                [--cmq]
                                [--hub-name]
                                [--lab]
                                [--login]
                                [--metrics]
                                [--pri]
                                [--resource-group]
                                [--target-condition]

Örnekler

9. yapıda bir cihaz etiketlendiğinde ve ortam 'test' olduğunda koşula göre geçerli olan 3 önceliğine sahip bir cihaz yapılandırması oluşturun.

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Etiketlerle bir cihaz yapılandırması oluşturun ve kullanıcı ölçümlerini satır içinde sağlayın (bash söz dizimi örneği).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9" --labels '{"key0":"value0", "key1":"value1"}' --priority 10 --metrics '{"metrics": {"queries": {"mymetric": "select deviceId from devices where tags.location='US'"}}}'

Etiketlerle modül yapılandırması oluşturma ve satır içi kullanıcı ölçümleri sağlama (cmd söz dizimi örneği)

az iot hub configuration create -c {config_name} -n {iothub_name} --content module_content.json --target-condition "from devices.modules where tags.building=9" --labels "{\"key0\":\"value0\", \"key1\":\"value1\"}" --metrics "{\"metrics\": {\"queries\": {\"mymetric\": \"select moduleId from devices.modules where tags.location='US'\"}}}"

satır içi içerik ve kullanıcı ölçümleriyle bir modül yapılandırması oluşturun (powershell söz dizimi örneği).

az iot hub configuration create -c {config_name} -n {iothub_name} --content '{\"moduleContent\": {\"properties.desired.chillerWaterSettings\": {\"temperature\": 38, \"pressure\": 78}}}' --target-condition "from devices.modules where tags.building=9" --priority 1 --metrics '{\"metrics\": {\"queries\": {\"mymetric\":\"select moduleId from devices.modules where tags.location=''US''\"}}}'

Alternatif giriş stili etiketler ve ölçümler (kabuk agnostik) ile bir cihaz yapılandırması oluşturun.

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "from devices.modules where tags.building=9" --custom-labels key0="value0" key1="value1" --priority 10 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Gerekli Parametreler

--config-id -c

Hedef cihaz yapılandırma adı. Küçük harf ve şu özel karakterlere izin verilir: [-+%_*!'].

--content -k

Cihaz yapılandırma içeriği. Dosya yolu veya ham json sağlayın.

İ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

Default value: key

--cl --custom-labels

--labels için alternatif bir giriş stili (boşlukla ayrılmış anahtar=değer çiftleri) ve gelecekte bunu değiştirmek için tasarlanmıştır. Biçim örneği: key1=value1 key2="bu benim değerim".

--cmq --custom-metric-queries

--metrics için alternatif bir giriş stili (boşlukla ayrılmış anahtar=değer çiftleri) ve gelecekte bunu değiştirmek için tasarlanmıştır. Biçim örneği: metric1="tags.location='US'" metric2="select *" olan cihazlardan deviceId'yi seçin.

--hub-name -n

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

--lab --labels

Hedef yapılandırmaya uygulanacak etiketlerin haritası. --labels yerine --custom-labels kullanılması önerilir. Biçim örneği: {"key0":"value0", "key1":"value1"}.

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

--metrics -m

Cihaz yapılandırma ölçümü tanımları. Dosya yolu veya ham json sağlayın. --metrics yerine --custom-metric-queries kullanılması önerilir.

--pri --priority

Rakip kurallar (en yüksek galibiyet) durumunda cihaz yapılandırmasının ağırlığı.

Default value: 0

--resource-group -g

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

--target-condition --tc -t

Cihaz veya modül yapılandırmasının uygulandığı hedef koşul. Hedef koşul içermeyen yapılandırmalar hiçbir cihazı veya modülü hedeflemez. Şu biçimi kullanın: "tags.environment='test'".

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

Default value: 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 configuration delete

IoT cihaz yapılandırmasını silin.

az iot hub configuration delete --config-id
                                [--auth-type {key, login}]
                                [--etag]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Gerekli Parametreler

--config-id -c

Hedef cihaz yapılandırma adı. Küçük harf ve şu özel karakterlere izin verilir: [-+%_*!'].

İ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

Default value: 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

Default value: 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 configuration list

IoT Hub'ında IoT otomatik cihaz yönetimi yapılandırmalarını listeleme.

az iot hub configuration list [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]
                              [--top]

İ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

Default value: 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 en fazla yapılandırma sayısı. Varsayılan olarak tüm yapılandırmalar döndürülür.

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

Default value: 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 configuration show

IoT otomatik cihaz yönetimi yapılandırmasının ayrıntılarını alın.

az iot hub configuration show --config-id
                              [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]

Gerekli Parametreler

--config-id -c

Hedef cihaz yapılandırma adı. Küçük harf ve şu özel karakterlere izin verilir: [-+%_*!'].

İ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

Default value: 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

Default value: 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 configuration show-metric

IoT cihaz yapılandırmasında tanımlanan hedef kullanıcı veya sistem ölçümünü değerlendirin.

az iot hub configuration show-metric --config-id
                                     --metric-id
                                     [--auth-type {key, login}]
                                     [--hub-name]
                                     [--login]
                                     [--metric-type {system, user}]
                                     [--resource-group]

Örnekler

Kullanıcı tanımlı 'warningLimit' ölçümünü değerlendirme

az iot hub configuration show-metric -m warningLimit -c {configuration_name} -n {iothub_name}

Sistem 'appliedCount' ölçümünü değerlendirme

az iot hub configuration show-metric --metric-id appliedCount -c {configuration_name} -n {iothub_name} --metric-type system

Gerekli Parametreler

--config-id -c

Hedef cihaz yapılandırma adı. Küçük harf ve şu özel karakterlere izin verilir: [-+%_*!'].

--metric-id -m

Değerlendirme için hedef ölçüm.

İ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

Default value: 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.

--metric-type --mt

Bir ölçümü ararken hangi ölçüm koleksiyonunun kullanılacağını gösterir.

Kabul edilen değerler: system, user

Default value: user

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

Default value: 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 configuration update

IoT otomatik cihaz yönetimi yapılandırmasının belirtilen özelliklerini güncelleştirin.

Yapılandırmayı güncelleştirmek için --set ve ardından özellik atamaları kullanın.

Not: Yapılandırma içeriği sabittir. Güncelleştirilebilen yapılandırma özellikleri 'etiketler', 'ölçümler', 'öncelik' ve 'targetCondition' şeklindedir.

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

Örnekler

Cihaz yapılandırmasının önceliğini değiştirme ve hedef koşulunu güncelleştirme

az iot hub configuration update -c {configuration_name} -n {iothub_name} --set priority=10 targetCondition="tags.building=43 and tags.environment='dev'"

Gerekli Parametreler

--config-id -c

Hedef cihaz yapılandırma adı. Küçük harf ve şu özel karakterlere izin verilir: [-+%_*!'].

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

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.

Kabul edilen değerler: key, login

Default value: 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.

Default value: 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.

Default value: []

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

Default value: []

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

Default value: 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.