az iot edge deployment

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ı, bir az iot edge deployment komutunu ilk kez çalıştırdığınızda otomatik olarak yüklenir. Uzantılar hakkında daha fazla bilgi edinin.

IoT Edge dağıtımlarını uygun ölçekte yönetin.

Komutlar

Name	Description	Tür	Durum
az iot edge deployment create	Hedef IoT Hub'da IoT Edge dağıtımı oluşturun.	Dahili	GA
az iot edge deployment delete	IoT Edge dağıtımını silme.	Dahili	GA
az iot edge deployment list	IoT Hub'da IoT Edge dağıtımlarını listeleme.	Dahili	GA
az iot edge deployment show	IoT Edge dağıtımının ayrıntılarını alın.	Dahili	GA
az iot edge deployment show-metric	IoT Edge dağıtımında tanımlanan hedef sistem ölçümünü değerlendirme.	Dahili	GA
az iot edge deployment update	IoT Edge dağıtımının belirtilen özelliklerini güncelleştirme.	Dahili	GA

az iot edge deployment create

Hedef IoT Hub'da IoT Edge dağıtımı oluşturun.

Dağıtım içeriği json ve {"modulesContent":{...}} biçimindedir veya {"content":{"modulesContent":{...}}.

$edgeAgent ve $edgeHub sistem modüllerinin varsayılan özellikleri, IoT uzantısıyla yüklenen şemalarda doğrulanır. Bu doğrulama temel dağıtımlara yöneliktir. İlgili şema kullanılamıyorsa veya temel dağıtım biçimi algılanmazsa, bu adım atlanır. Şema doğrulaması --no-validation anahtarı kullanılarak devre dışı bırakılabilir.

Bir modülün properties.desired.* tanımlanmışsa uç dağıtımı katmanlı olarak sınıflandırılır. Katmanlı dağıtım tarafından hedeflenen tüm uç cihazlara önce bir temel dağıtım uygulanması gerekir.

Bir cihazı hedefleyen katmanlı dağıtımların, bu cihaz için temel dağıtımdan daha yüksek önceliğe sahip olması gerekir.

Not: Modül ikizinin properties.desired alanı katmanlı bir dağıtımda ayarlanırsa properties.desired, düşük öncelikli dağıtımlarda söz konusu modül için istenen özelliklerin üzerine yazar.

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--cl]
                              [--cmq]
                              [--hub-name]
                              [--lab]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri]
                              [--resource-group]
                              [--target-condition]

Örnekler

'Bina 9' içindeki cihazlar için geçerli olan ve ortamı 'test' olan etiketlerle (bash söz dizimi örneği) bir dağıtım oluşturun.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels '{"key0":"value0", "key1":"value1"}' --target-condition "tags.building=9 and tags.environment='test'" --priority 3

'dev' ortamıyla etiketlenmiş cihazlar için geçerli olan etiketlerle (powershell söz dizimi örneği) bir dağıtım oluşturun.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels "{'key':'value'}" --target-condition "tags.environment='dev'"

'dev' ortamıyla etiketlenmiş cihazlar için geçerli olan katmanlı bir dağıtım oluşturun. Satır içinde tanımlanan hem kullanıcı ölçümleri hem de modül içeriği (powershell söz dizimi örneği). Bunun properties.desired.* tanımlandığı için katmanlı dağıtım biçiminde olduğunu unutmayın.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content "{'modulesContent':{'`$edgeAgent':{
  'properties.desired.modules.mymodule0':{ }},'`$edgeHub':{'properties.desired.routes.myroute0':'FROM /messages/* INTO `$upstream'}}}"
--target-condition "tags.environment='dev'" --priority 10 --metrics "{'queries':{'mymetrik':'SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200'}}"

'Derleme 9' ve 'test' ortamındaki cihazlar için geçerli olan katmanlı bir dağıtım oluşturun. Satır içinde tanımlanan hem kullanıcı ölçümleri hem de modül içeriği (bash söz dizimi örneği). Bunun properties.desired.* tanımlandığı için katmanlı dağıtım biçiminde olduğunu unutmayın.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content '{"modulesContent":{"$edgeAgent":{"properties.desired.modules.mymodule0":{ }},"$edgeHub":{"properties.desired.routes.myroute0":"FROM /messages/* INTO $upstream"}}}' --target-condition "tags.building=9 and tags.environment='test'" --metrics '{"queries":{"mymetrik":"SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200"}}'

'derleme 9' ve 'test' ortamındaki cihazlar için geçerli olan bir dağıtım oluşturun. Dosyadan tanımlanan hem kullanıcı ölçümleri hem de modül içeriği.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics ./metrics_content.json

Etiketlerin ve ölçümlerin kabuktan bağımsız girişiyle tanımı dosyadan gelen bir dağıtım oluşturun.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --custom-labels key0=value0 key1=value1 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Gerekli Parametreler

--content -k

IoT Edge dağıtım içeriği. Dosya yolu veya ham json sağlayın.

--deployment-id -d

Hedef dağıtım 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

varsayılan değer: 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 dağıtıma uygulanacak etiketlerin haritası. Şu biçimi kullanın: '{"key0":"value0", "key1":"value1"}'. --labels yerine --custom-labels kullanılması önerilir.

--layered

Katmanlı dağıtımlar, $edgeAgent, $edgeHub ve temel dağıtımın üzerine katmanlanacak kullanıcı modüllerinde istenen özellikleri tanımlamanızı sağlar. Katmanlı dağıtımda belirtilen özellikler, temel dağıtımın özellikleriyle birleştirilir. Aynı yola sahip özelliklerin üzerine dağıtım önceliğine göre yazılır. Bu seçenek ,no-validation için bir diğer addır.

kabul edilen değerler: false, true

varsayılan değer: False

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

IoT Edge dağıtımı kullanıcı ölçümü tanımları. Dosya yolu veya ham json sağlayın. Kullanıcı ölçümleri {"queries":{...}} biçimindedir veya {"metrics":{"queries":{...}}}. --metrics yerine --custom-metric-queries kullanılması önerilir.

--no-validation

Uç dağıtım oluşturma için istemci tarafı şema doğrulamasını devre dışı bırakır.

kabul edilen değerler: false, true

varsayılan değer: False

--pri --priority

Rakip kurallar (en yüksek galibiyet) durumunda dağıtımın ağırlığı.

varsayılan değer: 0

--resource-group -g

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

--target-condition --tc -t

Uç dağıtımının uygulandığı hedef koşul. Hedef koşul içermeyen dağıtımlar hiçbir cihazı 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

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 edge deployment delete

IoT Edge dağıtımını silme.

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

Gerekli Parametreler

--deployment-id -d

Hedef dağıtım 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

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 edge deployment list

IoT Hub'da IoT Edge dağıtımlarını listeleme.

az iot edge deployment 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

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 en fazla dağıtım sayısı. Varsayılan olarak tüm dağıtımlar 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

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 edge deployment show

IoT Edge dağıtımının ayrıntılarını alın.

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

Gerekli Parametreler

--deployment-id -d

Hedef dağıtım 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

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 edge deployment show-metric

IoT Edge dağıtımında tanımlanan hedef sistem ölçümünü değerlendirme.

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

Örnekler

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

az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system

'myCustomMetric' kullanıcı ölçümünü değerlendirme

az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}

Gerekli Parametreler

--deployment-id -d

Hedef dağıtım 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

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.

--metric-type --mt

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

kabul edilen değerler: system, user

varsayılan değer: 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

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 edge deployment update

IoT Edge dağıtımının belirtilen özelliklerini güncelleştirme.

Dağıtımı güncelleştirmek için --set ve ardından özellik atamaları kullanın.

Not: IoT Edge dağıtım içeriği sabittir. Güncelleştirilebilen dağıtım özellikleri 'etiketler', 'ölçümler', 'öncelik' ve 'targetCondition' şeklindedir.

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

Örnekler

Mevcut uç dağıtımının etiketlerini ve hedef koşulunu değiştirme

az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'

Gerekli Parametreler

--deployment-id -d

Hedef dağıtım 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>.

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.