az iot hub message-route

  • Wersja zapoznawcza

Note

To odwołanie jest częścią rozszerzenia azure-iot dla Azure CLI (wersja 2.70.0 lub nowsza). Rozszerzenie automatycznie zainstaluje polecenie az iot hub message-route. Dowiedz się więcej o rozszerzeniach.

Ta grupa poleceń jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Zarządzanie trasami centrum IoT Hub.

Polecenia

Nazwa Opis Typ Stan
az iot hub message-route create

Dodaj trasę dla IoT Hub.

 Extension Preview
az iot hub message-route delete

Usuń wszystkie trasy lub wymienioną trasę w IoT Hub.

 Extension Preview
az iot hub message-route fallback

Zarządzanie trasą rezerwową centrum IoT Hub.

 Extension Preview
az iot hub message-route fallback set

Włącz lub wyłącz trasę rezerwową w IoT Hub.

 Extension Preview
az iot hub message-route fallback show

Pokaż trasę rezerwową IoT Hub.

 Extension Preview
az iot hub message-route list

Pobierz wszystkie trasy w IoT Hub.

 Extension Preview
az iot hub message-route show

Uzyskaj informacje o trasie w IoT Hub.

 Extension Preview
az iot hub message-route test

Przetestuj wszystkie trasy lub wymienioną trasę w IoT Hub.

 Extension Preview
az iot hub message-route update

Aktualizowanie trasy dla IoT Hub.

 Extension Preview

az iot hub message-route create

Wersja zapoznawcza

Grupa poleceń "iot hub message-route" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Dodaj trasę dla IoT Hub.

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]

Przykłady

Utwórz trasę dla IoT Hub z danym punktem końcowym i typem źródłowym "DeviceMessages".

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

Utwórz trasę dla IoT Hub z wbudowanym punktem końcowym i typem źródłowym "DeviceMessages".

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

Utwórz trasę wyłączoną dla IoT Hub z danym punktem końcowym, typem źródłowym "DigitalTwinChangeEvents" i warunkiem niestandardowym.

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

Parametry wymagane

--en --endpoint --endpoint-name

Nazwa punktu końcowego routingu. W przypadku wbudowanego punktu końcowego użyj nazwy punktu końcowego "events".

--hub-name -n

nazwa IoT Hub.

--rn --route --route-name

Nazwa trasy.

--source-type --type -t

Źródło trasy.

Właściwość Wartość
Dopuszczalne wartości: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--condition -c

Warunek, który jest oceniany w celu zastosowania reguły routingu.

Właściwość Wartość
Domyślna wartość: true
--enabled -e

Wartość logiczna wskazująca, czy włączyć trasę do IoT Hub.

Właściwość Wartość
Domyślna wartość: True
Dopuszczalne wartości: false, true
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az iot hub message-route delete

Wersja zapoznawcza

Grupa poleceń "iot hub message-route" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Usuń wszystkie trasy lub wymienioną trasę w IoT Hub.

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

Przykłady

Usuń trasę z IoT Hub.

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

Usuń wszystkie trasy typu źródłowego "DeviceMessages" z IoT Hub.

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

Usuń wszystkie trasy z IoT Hub.

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--hub-name -n

nazwa IoT Hub.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--rn --route --route-name

Nazwa trasy.

--source-type --type -t

Źródło trasy.

Właściwość Wartość
Dopuszczalne wartości: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--yes -y

Pomiń monity użytkownika. Wskazuje akceptację akcji. Używane głównie w scenariuszach automatyzacji. Wartość domyślna: false.

Właściwość Wartość
Dopuszczalne wartości: false, true
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az iot hub message-route list

Wersja zapoznawcza

Grupa poleceń "iot hub message-route" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Pobierz wszystkie trasy w IoT Hub.

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

Przykłady

Pobierz wszystkie trasy z IoT Hub.

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

Pobierz wszystkie trasy typu źródłowego "DeviceMessages" z IoT Hub.

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--hub-name -n

nazwa IoT Hub.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--source-type --type -t

Źródło trasy.

Właściwość Wartość
Dopuszczalne wartości: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az iot hub message-route show

Wersja zapoznawcza

Grupa poleceń "iot hub message-route" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Uzyskaj informacje o trasie w IoT Hub.

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

Przykłady

Pobieranie informacji o trasach z IoT Hub.

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

Parametry wymagane

--rn --route --route-name

Nazwa trasy.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--hub-name -n

nazwa IoT Hub.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az iot hub message-route test

Wersja zapoznawcza

Grupa poleceń "iot hub message-route" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Przetestuj wszystkie trasy lub wymienioną trasę w IoT Hub.

Aby przetestować trasy, możesz podać przykładowy komunikat.

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]

Przykłady

Przetestuj trasę z IoT Hub.

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

Przetestuj wszystkie trasy typu źródłowego "DeviceMessages" z IoT Hub.

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

Przetestuj całą trasę z IoT Hub za pomocą niestandardowego komunikatu, w tym treści, właściwości aplikacji i właściwości systemu.

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--ap --app-properties

Właściwości aplikacji komunikatu trasy.

--body -b

Treść komunikatu trasy.

--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--hub-name -n

nazwa IoT Hub.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--rn --route --route-name

Nazwa trasy.

--source-type --type -t

Źródło trasy.

Właściwość Wartość
Dopuszczalne wartości: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--sp --system-properties

Właściwości systemowe komunikatu trasy.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az iot hub message-route update

Wersja zapoznawcza

Grupa poleceń "iot hub message-route" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Aktualizowanie trasy dla IoT Hub.

Możesz zmienić stan źródła, punktu końcowego, warunku lub włączonego na trasie.

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]

Przykłady

Zaktualizuj trasę do danego punktu końcowego i typu źródła "DeviceMessages".

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

Wyłącz trasę.

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

Zmień warunek trasy.

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

Parametry wymagane

--rn --route --route-name

Nazwa trasy.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość Wartość
Grupa parametrów: Global Policy Arguments
--condition -c

Warunek, który jest oceniany w celu zastosowania reguły routingu.

--en --endpoint --endpoint-name

Nazwa punktu końcowego routingu. W przypadku wbudowanego punktu końcowego użyj nazwy punktu końcowego "events".

--enabled -e

Wartość logiczna wskazująca, czy włączyć trasę do IoT Hub.

Właściwość Wartość
Dopuszczalne wartości: false, true
--hub-name -n

nazwa IoT Hub.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--source-type --type -t

Źródło trasy.

Właściwość Wartość
Dopuszczalne wartości: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False