CorsRule Класс

CORS является функцией HTTP, которая позволяет веб-приложению, работающему в одном домене, обращаться к ресурсам из другого домена. Веб-браузеры имеют ограничение безопасности под названием политика одного источника, которое не позволяет веб-странице вызывать API из других доменов. CORS обеспечивают безопасный способ, с помощью которого один домен (исходный домен) может вызывать API из другого домена.

Для отправки в Azure необходимо заполнить все необходимые параметры.

Наследование
azure.storage.queue._generated.models._models_py3.CorsRule
CorsRule

Конструктор

CorsRule(allowed_origins: List[str], allowed_methods: List[str], **kwargs: Any)

Параметры

allowed_origins
List[str]
Обязательно

Список доменов источника, которые будут разрешены через CORS, или "*", чтобы разрешить все домены. Список должен содержать по крайней мере одну запись. Ограничен 64 доменами источников. Каждый разрешенный источник может содержать до 256 символов.

allowed_methods
List[str]
Обязательно

Список методов HTTP, которые могут выполняться источником. Список должен содержать по крайней мере одну запись. Для хранилища Azure разрешенные методы: DELETE, GET, HEAD, MERGE, POST, OPTIONS и PUT.

max_age_in_seconds
int

Количество секунд, в течение которых клиент или браузер должны кэшировать ответ перед полетом.

exposed_headers
List[str]

По умолчанию используется пустой список. Список заголовков ответов для предоставления клиентам CORS. Ограничен 64 определенными заголовками и 2 заголовками с префиксами. Каждый заголовок может содержать до 256 символов.

allowed_headers
List[str]

По умолчанию используется пустой список. Список заголовков, которые могут быть частью запроса независимо от источника. Ограничен 64 определенными заголовками и 2 заголовками с префиксами. Каждый заголовок может содержать до 256 символов.

Методы

as_dict

Возвращает дикт, который можно сериализовать с помощью json.dump.

Дополнительное использование может использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит "тип" с типом msrest и "key" с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.

См. три примера в этом файле:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Если требуется xml-сериализация, можно передать kwargs is_xml=True.

deserialize

Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели.

enable_additional_properties_sending
from_dict

Синтаксический анализ дикта с помощью заданного средства извлечения ключа возвращает модель.

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).

is_xml_model
serialize

Возвращает json, который будет отправлен в Azure из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется xml-сериализация, можно передать kwargs is_xml=True.

as_dict

Возвращает дикт, который можно сериализовать с помощью json.dump.

Дополнительное использование может использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит "тип" с типом msrest и "key" с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.

См. три примера в этом файле:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Если требуется xml-сериализация, можно передать 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]

Параметры

key_transformer
<xref:function>

Функция преобразователя ключей.

keep_readonly
значение по умолчанию: True

Возвращаемое значение

Объект, совместимый с JSON для дикта

Возвращаемый тип

deserialize

Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели.

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

Параметры

data
str
Обязательно

Строка, использующий структуру RestAPI. JSON по умолчанию.

content_type
str
значение по умолчанию: None

JSON по умолчанию задайте значение application/xml if XML.

Возвращаемое значение

Экземпляр этой модели

Исключения

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Синтаксический анализ дикта с помощью заданного средства извлечения ключа возвращает модель.

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и 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

Параметры

data
dict
Обязательно

Словарь, использующий структуру RestAPI

content_type
str
значение по умолчанию: None

JSON по умолчанию задайте значение application/xml if XML.

key_extractors
значение по умолчанию: None

Возвращаемое значение

Экземпляр этой модели

Исключения

DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Возвращает json, который будет отправлен в Azure из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется xml-сериализация, можно передать kwargs is_xml=True.

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

Параметры

keep_readonly
bool
значение по умолчанию: False

Если вы хотите сериализовать атрибуты только для чтения

Возвращаемое значение

Объект, совместимый с JSON для дикта

Возвращаемый тип

Атрибуты

allowed_headers

Строковое представление списка заголовков с разделителями-запятыми, которые могут быть частью запроса cross-origin.

allowed_headers: str

allowed_methods

Строковое представление разделенных запятыми методов HTTP списка, которые могут выполняться источником.

allowed_methods: str

allowed_origins

Строковое представление с разделителями-запятыми списка доменов источника, которые будут разрешены через CORS, или "*", чтобы разрешить все домены.

allowed_origins: str

exposed_headers

Строковое представление списка заголовков ответов, предоставляемых клиентам CORS, с разделителями-запятыми.

exposed_headers: str

max_age_in_seconds

Количество секунд, в течение которых клиент или браузер должны кэшировать ответ перед полетом.

max_age_in_seconds: int