你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
filedatalake 包
包
| aio |
类
| AccessControlChangeCounters |
AccessControlChangeCounters 包含以递归方式更改访问控制列表的操作计数。 |
| AccessControlChangeFailure |
表示未能更新访问控制列表的条目。 |
| AccessControlChangeResult |
AccessControlChangeResult 包含以递归方式更改访问控制列表的操作的结果。 |
| AccessControlChanges |
AccessControlChanges 包含以递归方式更改访问控制列表的操作的批处理计数和累积计数。 此外，它还公开在这些操作进行时未能更新的路径条目。 |
| AccessPolicy |
集使用的 Access Policy 类，并获取每个服务中的访问策略方法。 存储访问策略可以指定与其关联的共享访问签名的开始时间、到期时间和权限。 根据控制对资源的访问的方式，可以在存储访问策略中指定所有这些参数，并从共享访问签名的 URL 中省略这些参数。 这样一来，你可以随时修改关联的签名的行为以及撤消签名。 或者，还可在存储访问策略中指定一个或多个访问策略参数，并在 URL 上指定其他参数。 最后，可以在 URL 上指定所有参数。 在这种情况下，你可以使用存储访问策略来撤消签名，但不修改其行为。 共享访问签名和存储访问策略都必须包含对签名进行身份验证所需的所有字段。 如果缺少任何必需的字段，则请求将失败。 同样地，如果在共享访问签名 URL 和存储访问策略中指定了字段，则请求将失败，状态代码为 400（错误的请求）。 |
| AccountSasPermissions | |
| AnalyticsLogging |
Azure Analytics 日志记录设置。 |
| ArrowDialect |
箭头架构的字段。 必须填充所有必需的参数才能发送到 Azure。 |
| ContentSettings |
文件或目录的内容设置。 |
| CorsRule |
CORS 是一项 HTTP 功能，使在一个域中运行的 Web 应用程序能够访问另一个域中的资源。 Web 浏览器实施一种称为同源策略的安全限制，以防止网页调用另一个域中的 API；CORS 提供了一种安全的方法来允许一个域（源域）调用另一个域中的 API。 |
| CustomerProvidedEncryptionKey |
Azure 存储中的所有数据都使用帐户级加密密钥进行静态加密。 在 2021-06-08 及更新版本中，可以通过在对存储服务的请求中提供 AES-256 加密密钥来管理用于加密每个文件的文件内容和应用程序元数据的密钥。 使用客户提供的密钥时，Azure 存储不会管理或保留密钥。 将数据写入文件时，所提供的密钥用于加密数据，然后再将数据写入磁盘。 加密密钥的 SHA-256 哈希与文件内容一起写入，用于验证针对文件的所有后续操作是否使用相同的加密密钥。 此哈希不能用于检索加密密钥或解密文件的内容。 读取文件时，提供的密钥用于在从磁盘读取数据后解密数据。 在这两种情况下，一旦加密或解密过程完成，提供的加密密钥就会被安全丢弃。 |
| DataLakeDirectoryClient |
与 DataLake 目录交互的客户端，即使该目录可能尚不存在。 对于与目录下的特定子目录或文件相关的操作，可以使用 或 get_file_client 函数检索get_sub_directory_client目录客户端或文件客户端。 |
| DataLakeFileClient |
与 DataLake 文件交互的客户端，即使该文件可能尚不存在也是如此。 |
| DataLakeFileQueryError |
错误发生在快速查询操作期间。 |
| DataLakeLeaseClient |
创建新的 DataLakeLeaseClient。 此客户端在 FileSystemClient、DataLakeDirectoryClient 或 DataLakeFileClient 上提供租用操作。 |
| DataLakeServiceClient |
在帐户级别与 DataLake 服务交互的客户端。 此客户端提供检索和配置帐户属性以及列出、创建和删除帐户中的文件系统的操作。 对于与特定文件系统、目录或文件相关的操作，也可以使用 get_client 函数检索这些实体的客户端。 |
| DeletedPathProperties |
为已删除路径填充的属性。 |
| DelimitedJsonDialect |
定义 datalake 查询的输入或输出 JSON 序列化。 关键字 (keyword) str 分隔符：行分隔符字符，默认值为 ' ' |
| DelimitedTextDialect |
定义数据湖查询请求的序列化 (CSV) 序列化的输入或输出。 关键字 (keyword) str 分隔符：列分隔符，默认为“，”。 关键字 (keyword) str quotechar：字段引号，默认值为“”。 关键字 (keyword) str lineterminator：记录分隔符，默认为 ” '. 关键字 (keyword) str 转义字符：转义字符，默认为空。 关键字 (keyword) bool has_header：blob 数据是否在第一行中包含标头。 默认值为 False，这意味着将返回包含第一行的数据。 如果设置为 True，则返回的数据将不包含第一行。 |
| DirectoryProperties | |
| DirectorySasPermissions |
要与 函数一起使用的 generate_directory_sas DirectorySasPermissions 类。 |
| EncryptionScopeOptions |
文件系统的默认加密范围配置。 此作用域隐式用于文件系统中的所有将来写入，但可以按 Blob 操作重写。 版本 12.9.0 中的新增功能。 |
| ExponentialRetry |
指数重试。 构造指数重试对象。 initial_backoff用于第一次重试。 后续重试在 initial_backoff + increment_power^retry_count 秒后重试。 |
| FileProperties | |
| FileSasPermissions |
要与 函数一 generate_file_sas 起使用的 FileSasPermissions 类。 |
| FileSystemClient |
要与特定文件系统交互的客户端，即使该文件系统可能尚不存在。 对于与此文件系统中的特定目录或文件相关的操作，可以使用 或 get_file_client 函数检索get_directory_client目录客户端或文件客户端。 |
| FileSystemProperties |
文件系统属性类。 返回的 |
| FileSystemPropertiesPaged |
文件系统属性的可迭代项。 |
| FileSystemSasPermissions |
要与 generate_file_system_sas 函数一起使用的 FileSystemSasPermissions 类。 |
| LeaseProperties |
DataLake 租约属性。 |
| LinearRetry |
线性重试。 构造线性重试对象。 |
| LocationMode |
指定请求应发送到的位置。 此模式仅适用于允许辅助读取访问的 RA-GRS 帐户。 所有其他帐户类型必须使用 PRIMARY。 |
| Metrics |
按 API 按小时或分钟聚合分组的请求统计信息摘要。 |
| PathProperties |
get_paths api 列出的路径属性。 |
| ResourceTypes |
指定可通过帐户 SAS 访问的资源类型。 |
| RetentionPolicy |
确定关联数据应保留多长时间的保留策略。 |
| StaticWebsite |
使帐户能够托管静态网站的属性。 |
| StorageStreamDownloader |
要从 Azure 存储下载的流式处理对象。 |
| UserDelegationKey |
表示用户委托密钥，该密钥由 Azure 存储基于其 Azure Active Directory 访问令牌提供给用户。 字段保存为简单字符串，因为用户不必与此对象交互;若要生成标识 SAS，用户只需将其传递给正确的 API 即可。 |
枚举
| ArrowType | |
| PublicAccess |
指定是否可以公开访问文件系统中的数据以及访问级别。 |
| QuickQueryDialect |
指定快速查询输入/输出方言。 |
| StorageErrorCode |
函数
generate_account_sas
为 DataLake 服务生成共享访问签名。
使用返回的签名作为任何 DataLakeServiceClient、FileSystemClient、DataLakeDirectoryClient 或 DataLakeFileClient 的凭据参数。
generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str | None, **kwargs: Any) -> str参数
- permission
- str 或 AccountSasPermissions
与共享访问签名关联的权限。 用户只能执行权限允许的操作。 必需，除非提供了引用包含此字段的存储访问策略的 ID。 如果已在关联的存储访问策略中指定，则必须省略此字段。
共享访问签名失效的时间。 必需，除非提供了引用包含此字段的存储访问策略的 ID。 如果已在关联的存储访问策略中指定，则必须省略此字段。 Azure 始终会将值转换为 UTC。 如果传入的日期没有时区信息，则假定该日期为 UTC。
共享访问签名生效的时间。 如果省略，将假定此调用的开始时间就是存储服务收到请求的时间。 Azure 始终会将值转换为 UTC。 如果传入的日期没有时区信息，则假定该日期为 UTC。
- ip
- str
指定要从中接受请求的 IP 地址或 IP 地址范围。 如果请求源自的 IP 地址与 SAS 令牌上指定的 IP 地址或地址范围不匹配，则不会对请求进行身份验证。 例如，在 SAS 上指定 ip=168.1.5.65 或 ip=168.1.5.60-168.1.5.70 会将请求限制为这些 IP 地址。
- protocol
- str
指定所发出请求所允许的协议。 默认值为 https。
- encryption_scope
- str
指定所发出的请求的加密范围，以便对所有写入操作进行服务加密。
返回
共享访问签名 (sas) 令牌。
返回类型
generate_directory_sas
为目录生成共享访问签名。
将返回的签名与任何 DataLakeServiceClient、FileSystemClient、DataLakeDirectoryClient 或 DataLakeFileClient 的凭据参数一起使用。
generate_directory_sas(account_name: str, file_system_name: str, directory_name: str, credential: str | UserDelegationKey, permission: DirectorySasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> str参数
- credential
- str 或 UserDelegationKey
凭据可以是帐户密钥或用户委派密钥。 如果使用帐户密钥作为凭据，则凭据类型应为 str。 用户还可以传入用户委托密钥，而不是帐户密钥。 可以通过使用 AAD 标识进行身份验证，从服务获取用户委托密钥;这可以通过调用 get_user_delegation_key来实现。 如果存在，则使用用户委托密钥对 SAS 进行签名。
- permission
- str 或 DirectorySasPermissions
与共享访问签名关联的权限。 用户只能执行权限允许的操作。 权限必须按 racwdlmeop 排序。 必需，除非提供了引用包含此字段的存储访问策略的 ID。 如果已在关联的存储访问策略中指定，则必须省略此字段。
共享访问签名失效的时间。 必需，除非提供了引用包含此字段的存储访问策略的 ID。 如果已在关联的存储访问策略中指定，则必须省略此字段。 Azure 始终会将值转换为 UTC。 如果传入的日期没有时区信息，则假定该日期为 UTC。
共享访问签名生效的时间。 如果省略，将假定此调用的开始时间就是存储服务收到请求的时间。 Azure 始终会将值转换为 UTC。 如果传入的日期没有时区信息，则假定该日期为 UTC。
- ip
- str
指定要从中接受请求的 IP 地址或 IP 地址范围。 如果请求源自的 IP 地址与 SAS 令牌上指定的 IP 地址或地址范围不匹配，则不会对请求进行身份验证。 例如，在 SAS 上指定 ip=168.1.5.65 或 ip=168.1.5.60-168.1.5.70 会将请求限制为这些 IP 地址。
- protocol
- str
指定所发出请求所允许的协议。 默认值为 https。
- cache_control
- str
使用此共享访问签名访问资源时Cache-Control的响应标头值。
- content_disposition
- str
使用此共享访问签名访问资源时 Content-Disposition 的响应标头值。
- content_encoding
- str
使用此共享访问签名访问资源时内容编码的响应标头值。
- content_language
- str
使用此共享访问签名访问资源时，Content-Language 的响应标头值。
- content_type
- str
使用此共享访问签名访问资源时，Content-Type 的响应标头值。
- preauthorized_agent_object_id
- str
假定用户委派密钥所有者授权执行 SAS 令牌授予的操作的用户的 AAD 对象 ID。 该服务将验证 SAS 令牌，并确保用户委派密钥的所有者在授予访问权限之前具有所需的权限，但不会对代理对象 ID 执行任何其他权限检查。
- agent_object_id
- str
用户的 AAD 对象 ID，该用户被用户委派密钥的所有者假定为未授权，以执行 SAS 令牌授予的操作。 该服务将验证 SAS 令牌，并确保用户委派密钥的所有者在授予访问权限之前具有所需的权限，并且该服务将执行额外的 POSIX ACL 检查，以确定此用户是否有权执行请求的操作。
- correlation_id
- str
用于将存储审核日志与生成和分发 SAS 的主体使用的审核日志关联的关联 ID。
- encryption_scope
- str
指定所发出的请求的加密范围，以便对所有写入操作进行服务加密。
返回
共享访问签名 (sas) 令牌。
返回类型
generate_file_sas
为文件生成共享访问签名。
将返回的签名与任何 BDataLakeServiceClient、FileSystemClient、DataLakeDirectoryClient 或 DataLakeFileClient 的凭据参数一起使用。
generate_file_sas(account_name: str, file_system_name: str, directory_name: str, file_name: str, credential: str | UserDelegationKey, permission: FileSasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> str参数
- credential
- str 或 UserDelegationKey
凭据可以是帐户密钥或用户委派密钥。 如果使用帐户密钥作为凭据，则凭据类型应为 str。 用户还可以传入用户委托密钥，而不是帐户密钥。 可以通过使用 AAD 标识进行身份验证，从服务获取用户委托密钥;这可以通过调用 get_user_delegation_key来实现。 如果存在，则使用用户委托密钥对 SAS 进行签名。
- permission
- str 或 FileSasPermissions
与共享访问签名关联的权限。 用户只能执行权限允许的操作。 权限必须按 racwdlmeop 排序。 必需，除非提供了引用包含此字段的存储访问策略的 ID。 如果已在关联的存储访问策略中指定，则必须省略此字段。
共享访问签名失效的时间。 必需，除非提供了引用包含此字段的存储访问策略的 ID。 如果已在关联的存储访问策略中指定，则必须省略此字段。 Azure 始终会将值转换为 UTC。 如果传入的日期没有时区信息，则假定该日期为 UTC。
共享访问签名生效的时间。 如果省略，将假定此调用的开始时间就是存储服务收到请求的时间。 Azure 始终会将值转换为 UTC。 如果传入的日期没有时区信息，则假定该日期为 UTC。
- ip
- str
指定要从中接受请求的 IP 地址或 IP 地址范围。 如果请求源自的 IP 地址与 SAS 令牌上指定的 IP 地址或地址范围不匹配，则不会对请求进行身份验证。 例如，在 SAS 上指定 ip=168.1.5.65 或 ip=168.1.5.60-168.1.5.70 会将请求限制为这些 IP 地址。
- protocol
- str
指定所发出请求所允许的协议。 默认值为 https。
- cache_control
- str
使用此共享访问签名访问资源时Cache-Control的响应标头值。
- content_disposition
- str
使用此共享访问签名访问资源时 Content-Disposition 的响应标头值。
- content_encoding
- str
使用此共享访问签名访问资源时内容编码的响应标头值。
- content_language
- str
使用此共享访问签名访问资源时，Content-Language 的响应标头值。
- content_type
- str
使用此共享访问签名访问资源时，Content-Type 的响应标头值。
- preauthorized_agent_object_id
- str
假定用户委派密钥所有者授权执行 SAS 令牌授予的操作的用户的 AAD 对象 ID。 该服务将验证 SAS 令牌，并确保用户委派密钥的所有者在授予访问权限之前具有所需的权限，但不会对代理对象 ID 执行任何其他权限检查。
- agent_object_id
- str
用户的 AAD 对象 ID，该用户被用户委派密钥的所有者假定为未授权，以执行 SAS 令牌授予的操作。 该服务将验证 SAS 令牌，并确保用户委派密钥的所有者在授予访问权限之前具有所需的权限，并且该服务将执行额外的 POSIX ACL 检查，以确定此用户是否有权执行请求的操作。
- correlation_id
- str
用于将存储审核日志与生成和分发 SAS 的主体使用的审核日志关联的关联 ID。 这只能在生成具有委派密钥的 SAS 时使用。
- encryption_scope
- str
指定所发出的请求的加密范围，以便对所有写入操作进行服务加密。
返回
共享访问签名 (sas) 令牌。
返回类型
generate_file_system_sas
为文件系统生成共享访问签名。
将返回的签名与任何 DataLakeServiceClient、FileSystemClient、DataLakeDirectoryClient 或 DataLakeFileClient 的凭据参数一起使用。
generate_file_system_sas(account_name: str, file_system_name: str, credential: str | UserDelegationKey, permission: FileSystemSasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> str参数
- credential
- str 或 UserDelegationKey
凭据可以是帐户密钥或用户委派密钥。 如果使用帐户密钥作为凭据，则凭据类型应为 str。 用户还可以传入用户委托密钥，而不是帐户密钥。 可以通过使用 AAD 标识进行身份验证，从服务获取用户委托密钥;这可以通过调用 get_user_delegation_key来实现。 如果存在，则使用用户委托密钥对 SAS 进行签名。
- permission
- str 或 FileSystemSasPermissions
与共享访问签名关联的权限。 用户只能执行权限允许的操作。 权限必须按 racwdlmeop 排序。 必需，除非提供了引用包含此字段的存储访问策略的 ID。 如果已在关联的存储访问策略中指定，则必须省略此字段。
共享访问签名失效的时间。 必需，除非提供了引用包含此字段的存储访问策略的 ID。 如果已在关联的存储访问策略中指定，则必须省略此字段。 Azure 始终会将值转换为 UTC。 如果传入的日期没有时区信息，则假定该日期为 UTC。
共享访问签名生效的时间。 如果省略，将假定此调用的开始时间就是存储服务收到请求的时间。 Azure 始终会将值转换为 UTC。 如果传入的日期没有时区信息，则假定该日期为 UTC。
- ip
- str
指定要从中接受请求的 IP 地址或 IP 地址范围。 如果请求源自的 IP 地址与 SAS 令牌上指定的 IP 地址或地址范围不匹配，则不会对请求进行身份验证。 例如，在 SAS 上指定 ip=168.1.5.65 或 ip=168.1.5.60-168.1.5.70 会将请求限制为这些 IP 地址。
- protocol
- str
指定所发出请求所允许的协议。 默认值为 https。
- cache_control
- str
使用此共享访问签名访问资源时Cache-Control的响应标头值。
- content_disposition
- str
使用此共享访问签名访问资源时 Content-Disposition 的响应标头值。
- content_encoding
- str
使用此共享访问签名访问资源时内容编码的响应标头值。
- content_language
- str
使用此共享访问签名访问资源时，Content-Language 的响应标头值。
- content_type
- str
使用此共享访问签名访问资源时，Content-Type 的响应标头值。
- preauthorized_agent_object_id
- str
假定用户委派密钥所有者授权执行 SAS 令牌授予的操作的用户的 AAD 对象 ID。 该服务将验证 SAS 令牌，并确保用户委派密钥的所有者在授予访问权限之前具有所需的权限，但不会对代理对象 ID 执行任何其他权限检查。
- agent_object_id
- str
用户的 AAD 对象 ID，该用户被用户委派密钥的所有者假定为未授权，以执行 SAS 令牌授予的操作。 该服务将验证 SAS 令牌，并确保用户委派密钥的所有者在授予访问权限之前具有所需的权限，并且该服务将执行额外的 POSIX ACL 检查，以确定此用户是否有权执行请求的操作。
- correlation_id
- str
用于将存储审核日志与生成和分发 SAS 的主体使用的审核日志关联的关联 ID。
- encryption_scope
- str
指定所发出的请求的加密范围，以便对所有写入操作进行服务加密。
返回
共享访问签名 (sas) 令牌。
