你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

CorsRule 类

CORS 是一项 HTTP 功能,使在一个域中运行的 Web 应用程序能够访问另一个域中的资源。 Web 浏览器实施一种称为同源策略的安全限制,以防止网页调用另一个域中的 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 进行序列化的 dict。

高级用法可以选择使用回调作为参数:

Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。 当前包含具有 msrest 类型的“type”和包含 RestAPI 编码键的“key”。 值是此对象中的当前值。

返回的字符串将用于序列化密钥。 如果返回类型是列表,则这被视为分层结果听写。

请参阅此文件中的三个示例:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

如果需要 XML 序列化,可以传递 kwargs is_xml=True。

deserialize

使用 RestAPI 语法分析 str 并返回模型。

enable_additional_properties_sending
from_dict

使用给定的键提取程序分析 dict 返回一个模型。

默认情况下,请考虑密钥提取程序 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

返回将从此模型发送到 azure 的 JSON。

这是as_dict (full_restapi_key_transformer的别名 ,keep_readonly=False)

如果需要 XML 序列化,可以传递 kwargs is_xml=True。

as_dict

返回可使用 json.dump 进行序列化的 dict。

高级用法可以选择使用回调作为参数:

Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。 当前包含具有 msrest 类型的“type”和包含 RestAPI 编码键的“key”。 值是此对象中的当前值。

返回的字符串将用于序列化密钥。 如果返回类型是列表,则这被视为分层结果听写。

请参阅此文件中的三个示例:

  • 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

返回

与 dict JSON 兼容的对象

返回类型

deserialize

使用 RestAPI 语法分析 str 并返回模型。

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

参数

data
str
必需

使用 RestAPI 结构的 str。 默认情况下为 JSON。

content_type
str
默认值: None

默认情况下,如果 XML,则设置 application/xml。

返回

此模型的实例

例外

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

使用给定的键提取程序分析 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 结构的 dict

content_type
str
默认值: None

默认情况下,如果 XML,则设置 application/xml。

key_extractors
默认值: None

返回

此模型的实例

例外

DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

返回将从此模型发送到 azure 的 JSON。

这是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

如果要序列化只读属性

返回

与 dict JSON 兼容的对象

返回类型

属性

allowed_headers

允许作为跨域请求一部分的标头列表的逗号分隔字符串表示形式。

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