Partilhar via


RouteProperties Classe

As propriedades de uma regra de encaminhamento que o hub IoT utiliza para encaminhar mensagens para pontos finais.

Todos os parâmetros necessários têm de ser preenchidos para enviar para o Azure.

Herança
azure.mgmt.iothub._serialization.Model
RouteProperties

Construtor

RouteProperties(*, name: str, source: str | _models.RoutingSource, endpoint_names: List[str], is_enabled: bool, condition: str | None = None, **kwargs: Any)

Parâmetros Só de Palavra-Chave

Name Description
name
str

O nome da rota. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes, tem um comprimento máximo de 64 carateres e tem de ser exclusivo. Obrigatório.

source

A origem à qual a regra de encaminhamento deve ser aplicada, como DeviceMessages. Obrigatório. Os valores conhecidos são: "Inválido", "DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", "DeviceJobLifecycleEvents", "DigitalTwinChangeEvents" e "DeviceConnectionStateEvents".

condition
str

A condição que é avaliada para aplicar a regra de encaminhamento. Se não for fornecida nenhuma condição, é avaliada como verdadeira por predefinição. Para obter a gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

endpoint_names

A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, só é permitido um ponto final. Obrigatório.

is_enabled

Utilizado para especificar se uma rota está ativada. Obrigatório.

Variáveis

Name Description
name
str

O nome da rota. O nome só pode incluir carateres alfanuméricos, períodos, carateres de sublinhado, hífenes, tem um comprimento máximo de 64 carateres e tem de ser exclusivo. Obrigatório.

source

A origem à qual a regra de encaminhamento deve ser aplicada, como DeviceMessages. Obrigatório. Os valores conhecidos são: "Inválido", "DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", "DeviceJobLifecycleEvents", "DigitalTwinChangeEvents" e "DeviceConnectionStateEvents".

condition
str

A condição que é avaliada para aplicar a regra de encaminhamento. Se não for fornecida nenhuma condição, é avaliada como verdadeira por predefinição. Para obter a gramática, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

endpoint_names

A lista de pontos finais para os quais as mensagens que satisfazem a condição são encaminhadas. Atualmente, só é permitido um ponto final. Obrigatório.

is_enabled

Utilizado para especificar se uma rota está ativada. Obrigatório.