az iot hub message-route

  • Önizleme

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

Bu komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

IoT hub'ının yollarını yönetme.

Komutlar

Name Description Tür Durum
az iot hub message-route create

IoT Hub için bir yol ekleyin.

 Extension Preview
az iot hub message-route delete

bir IoT Hub tüm yolları veya bahsedilen bir yolu silin.

 Extension Preview
az iot hub message-route fallback

IoT hub'ının geri dönüş yolunu yönetin.

 Extension Preview
az iot hub message-route fallback set

bir IoT Hub geri dönüş yolunu etkinleştirin veya devre dışı bırakın.

 Extension Preview
az iot hub message-route fallback show

bir IoT Hub geri dönüş yolunu gösterin.

 Extension Preview
az iot hub message-route list

Bir IoT Hub tüm yolları alın.

 Extension Preview
az iot hub message-route show

bir IoT Hub yol hakkında bilgi edinin.

 Extension Preview
az iot hub message-route test

Bir IoT Hub tüm yolları veya bahsedilen bir yolu test edin.

 Extension Preview
az iot hub message-route update

bir IoT Hub için bir yolu güncelleştirin.

 Extension Preview

az iot hub message-route create

Önizleme

'iot hub message-route' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

IoT Hub için bir yol ekleyin.

az iot hub message-route create --en --endpoint --endpoint-name
                                --hub-name
                                --rn --route --route-name
                                --source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}
                                [--acquire-policy-token]
                                [--change-reference]
                                [--condition]
                                [--enabled {false, true}]
                                [--resource-group]

Örnekler

Verilen uç nokta ve kaynak türü "DeviceMessages" olan bir IoT Hub için bir yol oluşturun.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Yerleşik uç nokta ve kaynak türü "DeviceMessages" olan bir IoT Hub için bir yol oluşturun.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name events --source DeviceMessages

Verilen uç nokta, kaynak türü "DigitalTwinChangeEvents" ve özel koşul olan bir IoT Hub için devre dışı bırakılmış bir yol oluşturun.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DigitalTwinChangeEvents --condition {condition} --enabled false

Gerekli Parametreler

--en --endpoint --endpoint-name

Yönlendirme uç noktasının adı. Yerleşik uç nokta için uç nokta adı 'events' kullanın.

--hub-name -n

IoT Hub adı.

--rn --route --route-name

Yolun adı.

--source-type --type -t

Yolun kaynağı.

Özellik Değer
Kabul edilen değerler: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

İ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
--change-reference

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

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

Yönlendirme kuralını uygulamak için değerlendirilen koşul.

Özellik Değer
Default value: true
--enabled -e

IoT Hub yolunun etkinleştirilip etkinleştirilmeydiğini gösteren boole değeri.

Özellik Değer
Default value: True
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 hub message-route delete

Önizleme

'iot hub message-route' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

bir IoT Hub tüm yolları veya bahsedilen bir yolu silin.

az iot hub message-route delete [--acquire-policy-token]
                                [--change-reference]
                                [--hub-name]
                                [--ids]
                                [--resource-group]
                                [--rn --route --route-name]
                                [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--subscription]
                                [--yes {false, true}]

Örnekler

bir IoT Hub bir yolu silin.

az iot hub message-route delete -n {iothub_name} --route-name {route_name}

Bir IoT Hub "DeviceMessages" kaynak türünün tüm yollarını silin.

az iot hub message-route delete -n {iothub_name} --source DeviceMessages

bir IoT Hub tüm yolları silin.

az iot hub message-route delete -n {iothub_name}

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

Özellik Değer
Parametre grubu: Resource Id Arguments
--ids

Bir veya daha fazla kaynak kimliği (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' parametrelerini vermelisiniz.

Özellik Değer
Parametre grubu: Resource Id Arguments
--resource-group -g

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

Özellik Değer
Parametre grubu: Resource Id Arguments
--rn --route --route-name

Yolun adı.

--source-type --type -t

Yolun kaynağı.

Özellik Değer
Kabul edilen değerler: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

Özellik Değer
Parametre grubu: Resource Id Arguments
--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
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/.

--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 message-route list

Önizleme

'iot hub message-route' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

Bir IoT Hub tüm yolları alın.

az iot hub message-route list [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--subscription]

Örnekler

Bir IoT Hub tüm yolları alın.

az iot hub message-route list -n {iothub_name}

Bir IoT Hub "DeviceMessages" kaynak türünün tüm yollarını alın.

az iot hub message-route list -n {iothub_name} --source DeviceMessages

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

--hub-name -n

IoT Hub adı.

Özellik Değer
Parametre grubu: Resource Id Arguments
--ids

Bir veya daha fazla kaynak kimliği (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' parametrelerini vermelisiniz.

Özellik Değer
Parametre grubu: Resource Id Arguments
--resource-group -g

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

Özellik Değer
Parametre grubu: Resource Id Arguments
--source-type --type -t

Yolun kaynağı.

Özellik Değer
Kabul edilen değerler: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

Özellik Değer
Parametre grubu: Resource Id 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/.

--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 message-route show

Önizleme

'iot hub message-route' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

bir IoT Hub yol hakkında bilgi edinin.

az iot hub message-route show --rn --route --route-name
                              [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--subscription]

Örnekler

Bir IoT Hub yol bilgilerini alın.

az iot hub message-route show -n {iothub_name} --route-name {route_name}

Gerekli Parametreler

--rn --route --route-name

Yolun adı.

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

--hub-name -n

IoT Hub adı.

Özellik Değer
Parametre grubu: Resource Id Arguments
--ids

Bir veya daha fazla kaynak kimliği (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' parametrelerini vermelisiniz.

Özellik Değer
Parametre grubu: Resource Id Arguments
--resource-group -g

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

Özellik Değer
Parametre grubu: Resource Id Arguments
--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

Özellik Değer
Parametre grubu: Resource Id 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/.

--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 message-route test

Önizleme

'iot hub message-route' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

Bir IoT Hub tüm yolları veya bahsedilen bir yolu test edin.

Yollarınızı test etmek için örnek bir ileti sağlayabilirsiniz.

az iot hub message-route test [--acquire-policy-token]
                              [--ap --app-properties]
                              [--body]
                              [--change-reference]
                              [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--rn --route --route-name]
                              [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--sp --system-properties]
                              [--subscription]

Örnekler

bir IoT Hub bir yolu test edin.

az iot hub message-route test -n {iothub_name} --route-name {route_name}

Bir IoT Hub "DeviceMessages" kaynak türünün tüm yollarını test edin.

az iot hub message-route test -n {iothub_name} --source DeviceMessages

Gövde, uygulama özellikleri ve sistem özellikleri dahil olmak üzere özel bir iletiyle bir IoT Hub tüm yolları test edin.

az iot hub message-route test -n {iothub_name} -b {body} --ap {app_properties} --sp {system_properties}

İ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
--ap --app-properties

Yol iletisinin uygulama özellikleri.

--body -b

Yol iletisinin gövdesi.

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

Özellik Değer
Parametre grubu: Resource Id Arguments
--ids

Bir veya daha fazla kaynak kimliği (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' parametrelerini vermelisiniz.

Özellik Değer
Parametre grubu: Resource Id Arguments
--resource-group -g

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

Özellik Değer
Parametre grubu: Resource Id Arguments
--rn --route --route-name

Yolun adı.

--source-type --type -t

Yolun kaynağı.

Özellik Değer
Kabul edilen değerler: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--sp --system-properties

Yol iletisinin sistem özellikleri.

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

Özellik Değer
Parametre grubu: Resource Id 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/.

--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 message-route update

Önizleme

'iot hub message-route' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

bir IoT Hub için bir yolu güncelleştirin.

Rotada kaynak, uç nokta, koşul veya etkin durumu değiştirebilirsiniz.

az iot hub message-route update --rn --route --route-name
                                [--acquire-policy-token]
                                [--change-reference]
                                [--condition]
                                [--en --endpoint --endpoint-name]
                                [--enabled {false, true}]
                                [--hub-name]
                                [--ids]
                                [--resource-group]
                                [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--subscription]

Örnekler

Bir yolu belirli bir uç noktaya ve "DeviceMessages" kaynak türüne güncelleştirin.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Yolu devre dışı bırakın.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --enabled false

Bir yolun koşulunu değiştirme.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --condition {condition}

Gerekli Parametreler

--rn --route --route-name

Yolun adı.

İ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
--change-reference

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

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

Yönlendirme kuralını uygulamak için değerlendirilen koşul.

--en --endpoint --endpoint-name

Yönlendirme uç noktasının adı. Yerleşik uç nokta için uç nokta adı 'events' kullanın.

--enabled -e

IoT Hub yolunun etkinleştirilip etkinleştirilmeydiğini gösteren boole değeri.

Özellik Değer
Kabul edilen değerler: false, true
--hub-name -n

IoT Hub adı.

Özellik Değer
Parametre grubu: Resource Id Arguments
--ids

Bir veya daha fazla kaynak kimliği (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' parametrelerini vermelisiniz.

Özellik Değer
Parametre grubu: Resource Id Arguments
--resource-group -g

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

Özellik Değer
Parametre grubu: Resource Id Arguments
--source-type --type -t

Yolun kaynağı.

Özellik Değer
Kabul edilen değerler: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

Özellik Değer
Parametre grubu: Resource Id 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/.

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