Dela via


DigitalTwinsEventRoute Klass

En väg som dirigerar aviserings- och telemetrihändelser till en slutpunkt. Slutpunkter är ett mål utanför Azure Digital Twins, till exempel en EventHub.

Variabler fylls bara i av servern och ignoreras när en begäran skickas.

Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure.

Arv
DigitalTwinsEventRoute

Konstruktor

DigitalTwinsEventRoute(*, endpoint_name: str, filter: str, **kwargs)

Parametrar

endpoint_name
str

Krävs. Namnet på den slutpunkt som den här händelsevägen är bunden till.

filter
str

Krävs. Ett uttryck som beskriver de händelser som dirigeras till slutpunkten.

Variabler

id
str

ID för händelsevägen.

endpoint_name
str

Krävs. Namnet på den slutpunkt som den här händelsevägen är bunden till.

filter
str

Krävs. Ett uttryck som beskriver de händelser som dirigeras till slutpunkten.

Metoder

as_dict

Returnera en diktamen som kan vara JSONify med hjälp av json.dump.

Avancerad användning kan också använda ett återanrop som parameter:

Nyckeln är det attributnamn som används i Python. Attr_desc är en dikta av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med RestAPI-kodad nyckel. Värdet är det aktuella värdet i det här objektet.

Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.

Se de tre exemplen i den här filen:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

deserialize

Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.

enable_additional_properties_sending
from_dict

Parsa en diktamen med hjälp av en viss nyckelextraktor returnerar en modell.

Som standard bör du överväga viktiga extraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Returnera den JSON som skulle skickas till Azure från den här modellen.

Det här är ett alias för att as_dict(full_restapi_key_transformer, keep_readonly=False).

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

validate

Verifiera den här modellen rekursivt och returnera en lista över ValidationError.

as_dict

Returnera en diktamen som kan vara JSONify med hjälp av json.dump.

Avancerad användning kan också använda ett återanrop som parameter:

Nyckeln är det attributnamn som används i Python. Attr_desc är en dikta av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med RestAPI-kodad nyckel. Värdet är det aktuella värdet i det här objektet.

Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.

Se de tre exemplen i den här filen:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parametrar

key_transformer
<xref:function>

En nyckeltransformatorfunktion.

keep_readonly
standardvärde: True

Returer

Ett dict JSON-kompatibelt objekt

Returtyp

deserialize

Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.

deserialize(data, content_type=None)

Parametrar

data
str
Obligatorisk

En str som använder RestAPI-struktur. JSON som standard.

content_type
str
standardvärde: None

JSON som standard anger du application/xml om XML.

Returer

En instans av den här modellen

Undantag

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parsa en diktamen med hjälp av en viss nyckelextraktor returnerar en modell.

Som standard bör du överväga viktiga extraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parametrar

data
dict
Obligatorisk

En dikta med Hjälp av RestAPI-struktur

content_type
str
standardvärde: None

JSON som standard anger du application/xml om XML.

key_extractors
standardvärde: None

Returer

En instans av den här modellen

Undantag

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Returnera den JSON som skulle skickas till Azure från den här modellen.

Det här är ett alias för att as_dict(full_restapi_key_transformer, keep_readonly=False).

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parametrar

keep_readonly
bool
standardvärde: False

Om du vill serialisera readonly-attributen

Returer

Ett dict JSON-kompatibelt objekt

Returtyp

validate

Verifiera den här modellen rekursivt och returnera en lista över ValidationError.

validate()

Returer

En lista över valideringsfel

Returtyp