CorsOptions Classe

Definisce le opzioni per controllare la condivisione di risorse tra le origini (CORS) per un indice.

Tutti i parametri obbligatori devono essere popolati per l'invio ad Azure.

Ereditarietà

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

CorsOptions

Costruttore

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

Parametri solo parole chiave

Nome	Descrizione
allowed_origins	list[str] Elenco di origini da cui al codice JavaScript verrà concesso l'accesso all'indice. Può contenere un elenco di host del modulo {protocol}://{fully-qualified-domain-name}[:{port#}], oppure un singolo * per consentire tutte le origini (scelta non consigliata). Obbligatorio.
max_age_in_seconds	int Durata per cui i browser devono memorizzare nella cache le risposte preliminari CORS. Il valore predefinito è 5 minuti.

Variabili

Nome	Descrizione
allowed_origins	list[str] Elenco di origini da cui al codice JavaScript verrà concesso l'accesso all'indice. Può contenere un elenco di host del modulo {protocol}://{fully-qualified-domain-name}[:{port#}], oppure un singolo * per consentire tutte le origini (scelta non consigliata). Obbligatorio.
max_age_in_seconds	int Durata per cui i browser devono memorizzare nella cache le risposte preliminari CORS. Il valore predefinito è 5 minuti.

Metodi

as_dict	Restituisce un dict che può essere serializzato usando json.dump. L'utilizzo avanzato può facoltativamente usare un callback come parametro: Key è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Value è il valore corrente in questo oggetto. La stringa restituita verrà utilizzata per serializzare la chiave. Se il tipo restituito è un elenco, si tratta di un risultato gerarchico dict. Vedere i tre esempi in questo file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.
deserialize	Analizzare uno str usando la sintassi RestAPI e restituire un modello.
enable_additional_properties_sending
from_dict	Analizzare un dict usando un estrattore di chiave specificato restituisce un modello. Per impostazione predefinita, considerare gli estrattori di chiave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Restituisce il codice JSON che verrebbe inviato al server da questo modello. Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False). Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.

as_dict

Restituisce un dict che può essere serializzato usando json.dump.

L'utilizzo avanzato può facoltativamente usare un callback come parametro:

Key è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Value è il valore corrente in questo oggetto.

La stringa restituita verrà utilizzata per serializzare la chiave. Se il tipo restituito è un elenco, si tratta di un risultato gerarchico dict.

Vedere i tre esempi in questo file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.

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]

Parametri

Nome	Descrizione
key_transformer	<xref:function> Funzione di trasformatore di tasti.
keep_readonly	valore predefinito: True

Restituisce

Tipo	Descrizione
dict	Oggetto compatibile con JSON dict

deserialize

Analizzare uno str usando la sintassi RestAPI e restituire un modello.

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

Parametri

Nome	Descrizione
data Necessario	str Str che usa la struttura RestAPI. JSON per impostazione predefinita.
content_type	str JSON per impostazione predefinita, impostare application/xml se XML. valore predefinito: None

Restituisce

Tipo	Descrizione
	Istanza di questo modello

Eccezioni

Tipo	Descrizione
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analizzare un dict usando un estrattore di chiave specificato restituisce un modello.

Per impostazione predefinita, considerare gli estrattori di chiave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

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

Parametri

Nome	Descrizione
data Necessario	dict Oggetto dict using RestAPI structure (Struttura RESTAPI)
content_type	str JSON per impostazione predefinita, impostare application/xml se XML. valore predefinito: None
key_extractors	valore predefinito: None

Restituisce

Tipo	Descrizione
	Istanza di questo modello

Eccezioni

Tipo	Descrizione
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Restituisce il codice JSON che verrebbe inviato al server da questo modello.

Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).

Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.

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

Parametri

Nome	Descrizione
keep_readonly	bool Se si desidera serializzare gli attributi readonly valore predefinito: False

Restituisce

Tipo	Descrizione
dict	Oggetto compatibile con JSON dict