Share via

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

queue 包

  • 参考

包

aio

类

AccessPolicy

集使用的 Access Policy 类并获取访问策略方法。

存储访问策略可以指定与其关联的共享访问签名的开始时间、到期时间和权限。 根据想要控制对资源的访问的方式，可以在存储访问策略中指定所有这些参数，并从共享访问签名的 URL 中省略这些参数。 这样一来，你可以随时修改关联的签名的行为以及撤消签名。 或者，还可在存储访问策略中指定一个或多个访问策略参数，并在 URL 上指定其他参数。 最后，可以在 URL 上指定所有参数。 在这种情况下，你可以使用存储访问策略来撤消签名，但不修改其行为。

共享访问签名和存储访问策略都必须包含对签名进行身份验证所需的所有字段。 如果缺少任何必需的字段，则请求将失败。 同样地，如果在共享访问签名 URL 和存储访问策略中指定了字段，则请求将失败，状态代码为 400（错误的请求）。
AccountSasPermissions

ResourceTypes 类与 generate_account_sas 函数一起使用，以及用于与 set_*_acl 一起使用的 AccessPolicies。 有两种类型的 SAS 可用于授予资源访问权限。 一种是授予对特定资源的访问权限 (特定于资源的) 。 另一种是授予对特定帐户整个服务的访问权限，并允许基于此处找到的权限执行某些操作。
BinaryBase64DecodePolicy

将基本 64 编码的消息的消息解码策略转换为字节。

将 base64 编码的消息解码为字节。 如果输入内容不是有效的 base 64，则会引发 DecodeError。
BinaryBase64EncodePolicy

二进制消息的 Base 64 消息编码策略。

将二进制消息编码为 base 64。 如果输入内容不是字节，则将引发 TypeError。
CorsRule

CORS 是一项 HTTP 功能，使在一个域中运行的 Web 应用程序能够访问另一个域中的资源。 Web 浏览器实施一种称为同源策略的安全限制，以防止网页调用另一个域中的 API；CORS 提供了一种安全的方法来允许一个域（源域）调用另一个域中的 API。

必须填充所有必需的参数才能发送到 Azure。
ExponentialRetry

指数重试。

构造指数重试对象。 initial_backoff用于第一次重试。 后续重试在 initial_backoff + increment_power^retry_count 秒后重试。
LinearRetry

线性重试。

构造线性重试对象。
LocationMode

指定请求应发送到的位置。 此模式仅适用于允许辅助读取访问的 RA-GRS 帐户。 所有其他帐户类型必须使用 PRIMARY。
Metrics

按 API 按小时或分钟聚合分组的请求统计信息摘要。

必须填充所有必需的参数才能发送到 Azure。
QueueAnalyticsLogging

Azure Analytics 日志记录设置。

必须填充所有必需的参数才能发送到 Azure。
QueueClient

要与特定队列交互的客户端。

有关更多可选配置，请 单击此处。
QueueMessage

表示队列消息。
QueueProperties

队列属性。
QueueSasPermissions

QueueSasPermissions 类与 函数一起使用， generate_queue_sas 以及用于与 一起使用 set_queue_access_policy的 AccessPolicies。
QueueServiceClient

在帐户级别与队列服务交互的客户端。

此客户端提供用于检索和配置帐户属性以及列出、创建和删除帐户中的队列的操作。 对于与特定队列相关的操作，可以使用 函数检索此实体的 get_queue_client 客户端。

有关更多可选配置，请 单击此处。
ResourceTypes

指定可通过帐户 SAS 访问的资源类型。
RetentionPolicy

确定关联数据应保留多长时间的保留策略。

必须填充所有必需的参数才能发送到 Azure。
TextBase64DecodePolicy

将基本 64 编码的消息的消息解码策略转换为文本。

将 base64 编码的消息解码为文本 (unicode) 。 如果输入内容不是有效的 base 64，则会引发 DecodeError。 消息数据必须支持 UTF-8。
TextBase64EncodePolicy

文本消息的 Base 64 消息编码策略。

将文本 (unicode) 消息编码为 base 64。 如果输入内容不是文本，则会引发 TypeError。 输入文本必须支持 UTF-8。

枚举

StorageErrorCode

函数

generate_account_sas

为队列服务生成共享访问签名。

将返回的签名与任何队列服务的凭据参数一起使用。

generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str, start: datetime | str | None = None, ip: str | None = None, **kwargs: Any) -> str

参数

account_name
str
必需

用于生成共享访问签名的存储帐户名称。

account_key
str
必需

帐户密钥（也称为共享密钥或访问密钥）用于生成共享访问签名。

resource_types
ResourceTypes
必需

指定可通过帐户 SAS 访问的资源类型。

permission
AccountSasPermissions 或 str
必需

与共享访问签名关联的权限。 用户只能执行权限允许的操作。

expiry
datetime 或 str
必需

共享访问签名变为无效的时间。 Azure 将始终将值转换为 UTC。 如果传入的日期没有时区信息，则假定该日期为 UTC。

start
datetime 或 str
默认值: None

共享访问签名生效的时间。 如果省略，将假定此调用的开始时间就是存储服务收到请求的时间。 Azure 将始终将值转换为 UTC。 如果传入的日期没有时区信息，则假定该日期为 UTC。

ip
str
默认值: None

指定从中接受请求的 IP 地址或 IP 地址范围。 如果请求源自的 IP 地址与 SAS 令牌上指定的 IP 地址或地址范围不匹配，则不会对请求进行身份验证。 例如，在 SAS 上指定 sip=168.1.5.65 或 sip=168.1.5.60-168.1.5.70 会将请求限制为这些 IP 地址。

protocol
str

指定允许发出的请求的协议。 默认值为 https。

返回

共享访问签名 (sas) 令牌。

返回类型

str

generate_queue_sas

为队列生成共享访问签名。

将返回的签名与任何队列服务的凭据参数一起使用。

generate_queue_sas(account_name: str, queue_name: str, account_key: str, permission: QueueSasPermissions | str | None = None, expiry: datetime | str | None = None, start: datetime | str | None = None, policy_id: str | None = None, ip: str | None = None, **kwargs: Any) -> str

参数

account_name
str
必需

用于生成共享访问签名的存储帐户名称。

queue_name
str
必需

队列的名称。

account_key
str
必需

帐户密钥（也称为共享密钥或访问密钥）用于生成共享访问签名。

permission
QueueSasPermissions 或 str
默认值: None

与共享访问签名关联的权限。 用户只能执行权限允许的操作。 必需，除非提供了引用包含此字段的存储访问策略的policy_id。 如果已在关联的存储访问策略中指定，则必须省略此字段。

expiry
datetime 或 str
默认值: None

共享访问签名变为无效的时间。 必需，除非提供了引用包含此字段的存储访问策略的policy_id。 如果已在关联的存储访问策略中指定，则必须省略此字段。 Azure 将始终将值转换为 UTC。 如果传入的日期没有时区信息，则假定该日期为 UTC。

start
datetime 或 str
默认值: None

共享访问签名生效的时间。 如果省略，将假定此调用的开始时间就是存储服务收到请求的时间。 Azure 将始终将值转换为 UTC。 如果传入的日期没有时区信息，则假定该日期为 UTC。

policy_id
str
默认值: None

一个唯一值，长度最多为 64 个字符，与存储访问策略相关。 若要创建存储访问策略，请使用 set_queue_access_policy。

ip
str
默认值: None

指定从中接受请求的 IP 地址或 IP 地址范围。 如果请求源自的 IP 地址与 SAS 令牌上指定的 IP 地址或地址范围不匹配，则不会对请求进行身份验证。 例如，在 SAS 上指定 sip='168.1.5.65' 或 sip='168.1.5.60-168.1.5.70' 会将请求限制为这些 IP 地址。

protocol
str

指定允许发出的请求的协议。 默认值为 https。

返回

共享访问签名 (sas) 令牌。

返回类型

str

示例

生成 sas 令牌。


   from azure.storage.queue import generate_queue_sas
   sas_token = generate_queue_sas(
       queue.account_name,
       queue.queue_name,
       queue.credential.account_key,
       policy_id='my-access-policy-id'
   )