az iot device c2d-message

Note

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

Buluttan cihaza mesajlaşma komutları.

Komutlar

Name Description Tür Durum
az iot device c2d-message abandon

Buluttan cihaza ileti bırakma.

Extension GA
az iot device c2d-message complete

Buluttan cihaza bir ileti tamamlayın.

Extension GA
az iot device c2d-message purge

Hedef cihaz için buluttan cihaza ileti kuyruğu temizleme.

Extension GA
az iot device c2d-message receive

Buluttan cihaza bir ileti alın.

Extension GA
az iot device c2d-message reject

Buluttan cihaza ileti reddetme veya yeniden oluşturma.

Extension GA
az iot device c2d-message send

Buluttan cihaza ileti gönderme.

Extension GA

az iot device c2d-message abandon

Buluttan cihaza ileti bırakma.

az iot device c2d-message abandon --device-id
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Gerekli Parametreler

--device-id -d

Hedef Cihaz 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 Policy belirteci alma.

Özellik Değer
Parametre grubu: Global Policy Arguments
--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 connection string destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık connection string hem de ad sağlanırsa, connection string ö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 device c2d-message complete

Buluttan cihaza bir ileti tamamlayın.

az iot device c2d-message complete --device-id
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--etag]
                                   [--hub-name]
                                   [--login]
                                   [--resource-group]

Gerekli Parametreler

--device-id -d

Hedef Cihaz 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 Policy belirteci alma.

Özellik Değer
Parametre grubu: Global Policy Arguments
--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 connection string destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık connection string hem de ad sağlanırsa, connection string ö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 device c2d-message purge

Hedef cihaz için buluttan cihaza ileti kuyruğu temizleme.

az iot device c2d-message purge --device-id
                                [--acquire-policy-token]
                                [--change-reference]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Gerekli Parametreler

--device-id -d

Hedef Cihaz 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 Policy belirteci alma.

Özellik Değer
Parametre grubu: Global Policy Arguments
--change-reference

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

Özellik Değer
Parametre grubu: Global Policy Arguments
--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 connection string destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık connection string hem de ad sağlanırsa, connection string ö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 device c2d-message receive

Buluttan cihaza bir ileti alın.

Alınan ileti gövdesinin kodu yalnızca içerik kodlaması 'utf-8', 'utf-16' veya 'utf-32' olarak ayarlandığında çözülecektir. İçerik kodlaması yukarıdakilerden birine ayarlanmadığında veya içerik kodlama yukarıdakilerden birine ayarlandığında bile kodu çözülemediğinde ileti yükü {{kodu çözülemeyen yük}} olarak görüntülenir.

Not: [--complete, --reject, --abandon] tek bir ileti bağımsız değişkeni kabul edilir.

az iot device c2d-message receive --device-id
                                  [--abandon {false, true}]
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--complete {false, true}]
                                  [--hub-name]
                                  [--lock-timeout --lt]
                                  [--login]
                                  [--reject {false, true}]
                                  [--resource-group]

Örnekler

Temel kullanım

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group}

bir ileti alın ve bu ileti için 30 saniyelik bir kilit zaman aşımı ayarlayın

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --lt {30}

Bir ileti alın ve alındıktan sonra 'tamamlandı' olarak gönderin

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --complete

Bir ileti alma ve alındıktan sonra reddetme

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --reject

Gerekli Parametreler

--device-id -d

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

--abandon

Alındıktan sonra buluttan cihaza iletisini bırakın.

Özellik Değer
Parametre grubu: Message Ack Arguments
Default value: False
Kabul edilen değerler: false, true
--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure Policy belirteci alma.

Özellik Değer
Parametre grubu: Global Policy Arguments
--change-reference

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

Özellik Değer
Parametre grubu: Global Policy Arguments
--complete

Alındıktan sonra buluttan cihaza iletisini tamamlayın.

Özellik Değer
Parametre grubu: Message Ack Arguments
Default value: False
Kabul edilen değerler: false, true
--hub-name -n

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

Özellik Değer
Parametre grubu: IoT Hub Identifier Arguments
--lock-timeout --lt

İletinin diğer alma çağrıları için ne kadar süreyle görünmez olacağını belirtir.

Özellik Değer
Default value: 60
--login -l

Bu komut, eylem gerçekleştirme haklarına sahip bir varlık connection string destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık connection string hem de ad sağlanırsa, connection string öncelik alır. --hub-name sağlanmadıysa gereklidir.

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

Alındıktan sonra buluttan cihaza iletisini reddedin.

Özellik Değer
Parametre grubu: Message Ack Arguments
Default value: False
Kabul edilen değerler: false, true
--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 device c2d-message reject

Buluttan cihaza ileti reddetme veya yeniden oluşturma.

az iot device c2d-message reject --device-id
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--etag]
                                 [--hub-name]
                                 [--login]
                                 [--resource-group]

Gerekli Parametreler

--device-id -d

Hedef Cihaz 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 Policy belirteci alma.

Özellik Değer
Parametre grubu: Global Policy Arguments
--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 connection string destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık connection string hem de ad sağlanırsa, connection string ö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 device c2d-message send

Buluttan cihaza ileti gönderme.

AMQP aracılığıyla bir hedef cihaza buluttan cihaza ileti gönderin.

Not: İçerik kodlama varsayılan olarak utf-8 olarak ayarlanır. komut, içerik kodlama özelliği utf-8, utf-16 veya utf-32 olduğunda ileti gövdesini kodlama eylemiyle gönderir. İçerik kodlama değeri bunlardan biri değilse, özellik kodlama eylemi yapılmadan gönderilmeye devam eder.

İkili ileti gövdesi gönderilirken, içerik bir dosyadan (aracılığıyla --data-file-path) sağlanmalıdır ve içerik türü olarak application/octet-streamayarlanmalıdır.

az iot device c2d-message send --device-id
                               [--ack {full, negative, positive}]
                               [--acquire-policy-token]
                               [--auth-type {key, login}]
                               [--ce --content-encoding]
                               [--change-reference]
                               [--cid --correlation-id]
                               [--content-type --ct]
                               [--da --data]
                               [--data-file-path --dfp]
                               [--expiry --expiry-time-utc]
                               [--hub-name]
                               [--login]
                               [--message-id --mid]
                               [--properties --props]
                               [--resource-group]
                               [--uid --user-id]
                               [--wait {false, true}]
                               [--yes {false, true}]

Örnekler

Varsayılan ileti gövdesi ile temel kullanım

az iot device c2d-message send -d {device_id} -n {iothub_name}

Özel veriler ve özelliklerle buluttan cihaza ileti gönderme.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data 'Hello World' --props 'key0=value0;key1=value1'

C2D iletisi gönderin ve cihazın onaylanmasını bekleyin

az iot device c2d-message send -d {device_id} -n {iothub_name} --ack full --wait

Dosyadan ikili biçimde bir C2D iletisi gönderin.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/octet-stream'

Bir dosyadan JSON biçiminde bir C2D iletisi gönderin.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/json'

Gerekli Parametreler

--device-id -d

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

--ack

İletinin son durumuyla ilgili ileti başına geri bildirimin teslimini isteyin. ack değerlerinin açıklaması aşağıdaki gibidir. Pozitif: c2d iletisi Tamamlandı durumuna ulaşırsa IoT Hub bir geri bildirim iletisi oluşturur. Negatif: c2d iletisi Ölü harfli durumuna ulaşırsa IoT Hub bir geri bildirim iletisi oluşturur. Tam: IoT Hub her iki durumda da bir geri bildirim iletisi oluşturur. Varsayılan olarak, istekte bulunmaz.

Özellik Değer
Kabul edilen değerler: full, negative, positive
--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure Policy 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
--ce --content-encoding

C2D ileti gövdesi için kodlama.

Özellik Değer
Default value: utf-8
--change-reference

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

Özellik Değer
Parametre grubu: Global Policy Arguments
--cid --correlation-id

C2D iletisiyle ilişkili bağıntı kimliği.

--content-type --ct

C2D ileti gövdesi için içerik türü.

--da --data

İleti gövdesi. Metin veya ham json sağlayın.

Özellik Değer
Default value: Ping from Az CLI IoT Extension
--data-file-path --dfp
Önizleme

İleti gövdesi yükü için dosyanın yolunu belirtin. Yükün ikili biçimde gönderilmesi gerektiğinde içerik türünü application/octet-stream olarak ayarlayın.

--expiry --expiry-time-utc

Unix dönemlerinden bu yana birimler milisaniyedir. Zaman belirtilmemişse varsayılan IoT Hub C2D iletisi TTL 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 connection string destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık connection string hem de ad sağlanırsa, connection string öncelik alır. --hub-name sağlanmadıysa gereklidir.

Özellik Değer
Parametre grubu: IoT Hub Identifier Arguments
--message-id --mid

C2D ileti kimliği. İleti kimliği sağlanmazsa bir UUID oluşturulur.

--properties --props -p

Anahtar-değer çiftlerinde şu biçime sahip ileti özelliği paketi: a=b; c=d.

--resource-group -g

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

--uid --user-id

C2D iletisi, kullanıcı kimliği özelliği.

--wait -w

Ayarlanırsa, cihaz geri bildirimi alınana kadar c2d gönderme işlemi engellenir.

Özellik Değer
Default value: False
Kabul edilen değerler: false, true
--yes -y

Kullanıcı istemlerini atlayın. Eylemin kabul edilmesini gösterir. Öncelikle otomasyon senaryoları için kullanılır. Varsayılan: false.

Özellik Değer
Default value: False
Kabul edilen değerler: false, true
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