通过

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

tables 包

  • 参考

包

aio

类

AccountSasPermissions

AccountSasPermissions 要与 generate_account_sas 一起使用的类
EntityProperty

实体属性。 用于在必要时显式设置 EdmType 。

需要显式键入的值是 GUID、INT64 和 BINARY。 其他 EdmType 可以显式创建为 EntityProperty 对象，但不需要。 例如，以下两者都在实体上创建 STRING 类型化属性：


   entity = TableEntity()
   entity.a = 'b'
   entity.x = EntityProperty('y', EdmType.STRING)
RequestTooLargeError

状态代码为 413 的错误响应 - 请求实体太大
ResourceTypes

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

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

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

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

Azure Analytics 日志记录设置。

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

用于与 Azure 表帐户中的特定表交互的客户端。

从凭据创建 TableClient。
TableCorsRule

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

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

包含其他元数据的实体字典
TableItem

表示 Azure TableItem。 由 TableServiceClient.list_tables 和 TableServiceClient.query_tables 返回。
TableMetrics

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

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

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

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

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

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

从凭据创建 TablesBaseClient。
TableTransactionError

事务操作失败。

枚举

EdmType

EntityProperty用于表示由表服务存储的实体属性的类型。
SASProtocol
TableErrorCode
TransactionOperation
UpdateMode

函数

generate_account_sas

为表服务生成共享访问签名。 将返回的签名与 TableService 的 sas_token 参数一起使用。

generate_account_sas(credential: AzureNamedKeyCredential, resource_types: ResourceTypes, permission: str | AccountSasPermissions, expiry: datetime | str, **kwargs) -> str

参数

credential
AzureNamedKeyCredential
必需

Azure 帐户的凭据

resource_types
ResourceTypes
必需

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

permission
str 或 AccountSasPermissions
必需

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

expiry
datetime 或 str
必需

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

start
datetime 或 str

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

ip_address_or_range
str

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

protocol
str 或 SASProtocol

指定允许发出的请求的协议。

返回

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

返回类型

str

generate_table_sas

为表服务生成共享访问签名。 将返回的签名与 TableService 的 sas_token 参数一起使用。

generate_table_sas(credential: AzureNamedKeyCredential, table_name: str, **kwargs) -> str

参数

credential
AzureNamedKeyCredential
必需

用于创建共享访问签名的凭据

table_name
str
必需

表名称

permission
TableSasPermissions

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

expiry
datetime 或 str

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

start
datetime 或 str

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

ip_address_or_range
str

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

policy_id
str

访问策略 ID。

protocol
str 或 SASProtocol

指定允许发出的请求的协议。

start_rk
str

开始行键

start_pk
str

启动分区键

end_rk
str

结束行键

end_pk
str

结束分区键

返回

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

返回类型

str