你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
AccessPolicy 类
集使用的 Access Policy 类并获取访问策略方法。
存储访问策略可以指定与其关联的共享访问签名的开始时间、到期时间和权限。 根据想要控制对资源的访问的方式,可以在存储访问策略中指定所有这些参数,并从共享访问签名的 URL 中省略这些参数。 这样一来,你可以随时修改关联的签名的行为以及撤消签名。 或者,还可在存储访问策略中指定一个或多个访问策略参数,并在 URL 上指定其他参数。 最后,可以在 URL 上指定所有参数。 在这种情况下,你可以使用存储访问策略来撤消签名,但不修改其行为。
共享访问签名和存储访问策略都必须包含对签名进行身份验证所需的所有字段。 如果缺少任何必需的字段,则请求将失败。 同样地,如果在共享访问签名 URL 和存储访问策略中指定了字段,则请求将失败,状态代码为 400(错误的请求)。
- 继承
-
azure.storage.queue._generated.models._models_py3.AccessPolicyAccessPolicy
构造函数
AccessPolicy(permission: QueueSasPermissions | str | None = None, expiry: datetime | str | None = None, start: datetime | str | None = None)
参数
名称 | 说明 |
---|---|
permission
|
与共享访问签名关联的权限。 用户只能执行权限允许的操作。 必需,除非提供了引用包含此字段的存储访问策略的 ID。 如果已在关联的存储访问策略中指定,则必须省略此字段。 默认值: None
|
expiry
|
共享访问签名变为无效的时间。 必需,除非提供了引用包含此字段的存储访问策略的 ID。 如果已在关联的存储访问策略中指定,则必须省略此字段。 Azure 将始终将值转换为 UTC。 如果传入的日期没有时区信息,则假定该日期为 UTC。 默认值: None
|
start
|
共享访问签名生效的时间。 如果省略,将假定此调用的开始时间就是存储服务收到请求的时间。 Azure 将始终将值转换为 UTC。 如果传入的日期没有时区信息,则假定该日期为 UTC。 默认值: None
|
方法
as_dict |
返回可使用 json.dump 进行序列化的 dict。 高级用法可以选择使用回调作为参数: Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。 当前包含具有 msrest 类型的“type”和包含 RestAPI 编码键的“key”。 值是此对象中的当前值。 返回的字符串将用于序列化密钥。 如果返回类型是列表,则这被视为分层结果听写。 请参阅此文件中的三个示例:
如果需要 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
必需
|
使用 RestAPI 结构的 str。 默认情况下为 JSON。 |
content_type
|
默认情况下,如果 XML,则设置 application/xml。 默认值: None
|
返回
类型 | 说明 |
---|---|
此模型的实例 |
例外
类型 | 说明 |
---|---|
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
必需
|
使用 RestAPI 结构的 dict |
content_type
|
默认情况下,如果 XML,则设置 application/xml。 默认值: None
|
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
|
如果要序列化只读属性 默认值: False
|
返回
类型 | 说明 |
---|---|
与 dict JSON 兼容的对象 |
属性
expiry
共享访问签名变为无效的时间。
expiry: datetime | str | None
permission
与共享访问签名关联的权限。 用户只能执行权限允许的操作。
permission: QueueSasPermissions | str | None
start
共享访问签名生效的时间。
start: datetime | str | None