CorsOptions Klasse

  • Referenz

Definiert Optionen zum Steuern der ressourcenübergreifenden Ressourcenfreigabe (Cross-Origin Resource Sharing, CORS) für einen Index.

Zum Senden an Azure müssen alle erforderlichen Parameter aufgefüllt werden.

Vererbung
azure.search.documents.indexes._generated._serialization.Model
CorsOptions

Konstruktor

CorsOptions(*, allowed_origins: List[str], max_age_in_seconds: int | None = None, **kwargs: Any)

Keyword-Only Parameter

Name Beschreibung
allowed_origins
list[str]

Die Liste der Ursprünge, aus denen JavaScript-Code Zugriff auf Ihren Index erhält. Kann eine Liste von Hosts der Form {protocol}://{fully-qualified-domain-name}[:{port#}] oder eine einzelne * enthalten, um alle Ursprünge zuzulassen (nicht empfohlen). Erforderlich.
max_age_in_seconds
int

Die Dauer, für die Browser CORS-Preflight-Antworten zwischenspeichern sollen. Die Standardwerte sind 5 Minuten.

Variablen

Name Beschreibung
allowed_origins
list[str]

Die Liste der Ursprünge, aus denen JavaScript-Code Zugriff auf Ihren Index erhält. Kann eine Liste von Hosts der Form {protocol}://{fully-qualified-domain-name}[:{port#}] oder eine einzelne * enthalten, um alle Ursprünge zuzulassen (nicht empfohlen). Erforderlich.
max_age_in_seconds
int

Die Dauer, für die Browser CORS-Preflight-Antworten zwischenspeichern sollen. Die Standardwerte sind 5 Minuten.

Methoden

as_dict

Gibt ein Diktat zurück, das mithilfe von json.dump serialisiert werden kann.

Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden:

Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Dict von Metadaten. Enthält derzeit "type" mit dem msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt.

Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchisches Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.
deserialize

Analysieren Sie einen Str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.
enable_additional_properties_sending
from_dict

Analysieren eines Diktats mithilfe des angegebenen Schlüsselextraktors gibt ein Modell zurück.

Standardmäßig werden Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor) berücksichtigt.
is_xml_model
serialize

Gibt den JSON-Code zurück, der von diesem Modell an den Server gesendet würde.

Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False).

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

as_dict

Gibt ein Diktat zurück, das mithilfe von json.dump serialisiert werden kann.

Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden:

Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Dict von Metadaten. Enthält derzeit "type" mit dem msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt.

Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchisches Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Parameter

Name Beschreibung
key_transformer
<xref:function>

Eine Schlüsseltransformerfunktion.
keep_readonly
Standardwert: True

Gibt zurück

Typ Beschreibung
dict

Ein JSON-kompatibles Objekt mit Dict

deserialize

Analysieren Sie einen Str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Parameter

Name Beschreibung
data
Erforderlich
str

Eine Str-Instanz mit RestAPI-Struktur. JSON standardmäßig.
content_type
str

JSON standardmäßig, legen Sie application/xml if XML fest.

Standardwert: None

Gibt zurück

Typ Beschreibung

Ein instance dieses Modells

Ausnahmen

Typ Beschreibung
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Analysieren eines Diktats mithilfe des angegebenen Schlüsselextraktors gibt ein Modell zurück.

Standardmäßig werden Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor) berücksichtigt.

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Parameter

Name Beschreibung
data
Erforderlich
dict

Ein Diktat mithilfe der RestAPI-Struktur
content_type
str

JSON standardmäßig, legen Sie application/xml if XML fest.

Standardwert: None
key_extractors
Standardwert: None

Gibt zurück

Typ Beschreibung

Ein instance dieses Modells

Ausnahmen

Typ Beschreibung
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Gibt den JSON-Code zurück, der von diesem Modell an den Server gesendet würde.

Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False).

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parameter

Name Beschreibung
keep_readonly
bool

Wenn Sie die schreibgeschützten Attribute serialisieren möchten

Standardwert: False

Gibt zurück

Typ Beschreibung
dict

Ein JSON-kompatibles Objekt mit Dict