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

DataLakeSASSignatureValues interface

包:

@azure/storage-file-datalake

仅在 NODE.JS RUNTIME 中可用。

DataLakeSASSignatureValues 用于帮助为容器、Blob、文件系统、目录和文件生成 Blob 和 DataLake 服务 SAS 令牌。

属性

agentObjectId	可选。 从版本 2020-02-10 开始，以 GUID 格式指定未经授权的 AAD 对象 ID。 用户委派密钥的所有者假定未授权的用户的 AAD 对象 ID。 Azure 存储服务将执行额外的 POSIX ACL 检查，以确定用户是否有权执行请求的操作。 这不能用于与 preauthorizedAgentObjectId 的结合。 这仅用于用户委派 SAS。
cacheControl	可选。 SAS 的缓存控制标头。
contentDisposition	可选。 SAS 的内容处置标头。
contentEncoding	可选。 SAS 的内容编码标头。
contentLanguage	可选。 SAS 的内容语言标头。
contentType	可选。 SAS 的内容类型标头。
correlationId	可选。 从版本 2020-02-10 开始，这是将记录在存储诊断日志中的 GUID 值，可用于将 SAS 生成与存储资源访问相关联。 这仅用于用户委派 SAS。
directoryDepth	可选。 从版本 2020-02-10 开始，指示字符串到符号的规范化resource 字段中指定的目录的深度。 目录的深度是根文件夹下的目录数。
encryptionScope	可选。 发送使用此 SAS URI 授权的请求时要使用的加密范围。
expiresOn	仅当提供标识符时才可选。 SAS 不再工作的时间。
fileSystemName	SAS 用户可以访问的文件系统的名称。
identifier	可选。 此 SAS 引用的文件系统上的访问策略的名称（如果有）。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	可选。 此 SAS 中允许的 IP 范围。
isDirectory	可选。 从版本 2020-02-10 开始，此值定义 pathName 是否为目录。 如果此值设置为 true，则路径是目录 SAS 的目录。 如果设置为 false 或默认值，则路径是文件路径 SAS 的文件路径。
pathName	可选。 SAS 用户可访问的目录或文件的路径名称。 如果提供了 snapshotTime，则为必需。
permissions	仅当提供标识符时才可选。 请参阅 FileSystemSASPermissions、 DirectorySASPermissions 或 DataLakeSASPermissions ，具体取决于要访问的资源，以获取有关构造权限字符串的帮助。
preauthorizedAgentObjectId	可选。 从版本 2020-02-10 开始，以 GUID 格式指定授权的 AAD 对象 ID。 用户委派密钥所有者授权以执行 SAS 授予的操作的用户的 AAD 对象 ID。 Azure 存储服务将确保用户委派密钥的所有者在授予访问权限之前具有所需的权限，但不会对此值中指定的用户执行其他权限检查。 这不能用于与 agentObjectId 的 conjuction。 这仅用于用户委派 SAS。
protocol	可选。 SAS 协议、仅限 HTTPS 或 HTTPSandHTTP
snapshotTime	可选。 SAS 用户可以访问的快照时间戳字符串。 仅在 API 版本 2018-11-09 中受支持。
startsOn	可选。 SAS 何时生效。
version	此 SAS 将面向的服务的版本。 如果未指定，它将默认为库所面向的版本。

属性详细信息

agentObjectId

可选。 从版本 2020-02-10 开始，以 GUID 格式指定未经授权的 AAD 对象 ID。 用户委派密钥的所有者假定未授权的用户的 AAD 对象 ID。 Azure 存储服务将执行额外的 POSIX ACL 检查，以确定用户是否有权执行请求的操作。 这不能用于与 preauthorizedAgentObjectId 的结合。 这仅用于用户委派 SAS。

agentObjectId?: string

属性值

string

cacheControl

可选。 SAS 的缓存控制标头。

cacheControl?: string

属性值

string

contentDisposition

可选。 SAS 的内容处置标头。

contentDisposition?: string

属性值

string

contentEncoding

可选。 SAS 的内容编码标头。

contentEncoding?: string

属性值

string

contentLanguage

可选。 SAS 的内容语言标头。

contentLanguage?: string

属性值

string

contentType

可选。 SAS 的内容类型标头。

contentType?: string

属性值

string

correlationId

可选。 从版本 2020-02-10 开始，这是将记录在存储诊断日志中的 GUID 值，可用于将 SAS 生成与存储资源访问相关联。 这仅用于用户委派 SAS。

correlationId?: string

属性值

string

directoryDepth

可选。 从版本 2020-02-10 开始，指示字符串到符号的规范化resource 字段中指定的目录的深度。 目录的深度是根文件夹下的目录数。

directoryDepth?: number

属性值

number

encryptionScope

可选。 发送使用此 SAS URI 授权的请求时要使用的加密范围。

encryptionScope?: string

属性值

string

expiresOn

仅当提供标识符时才可选。 SAS 不再工作的时间。

expiresOn?: Date

属性值

Date

fileSystemName

SAS 用户可以访问的文件系统的名称。

fileSystemName: string

属性值

string

identifier

可选。 此 SAS 引用的文件系统上的访问策略的名称（如果有）。

请参见https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy

identifier?: string

属性值

string

ipRange

可选。 此 SAS 中允许的 IP 范围。

ipRange?: SasIPRange

属性值

SasIPRange

isDirectory

可选。 从版本 2020-02-10 开始，此值定义 pathName 是否为目录。 如果此值设置为 true，则路径是目录 SAS 的目录。 如果设置为 false 或默认值，则路径是文件路径 SAS 的文件路径。

isDirectory?: boolean

属性值

boolean

pathName

可选。 SAS 用户可访问的目录或文件的路径名称。 如果提供了 snapshotTime，则为必需。

pathName?: string

属性值

string

permissions

仅当提供标识符时才可选。 请参阅 FileSystemSASPermissions、 DirectorySASPermissions 或 DataLakeSASPermissions ，具体取决于要访问的资源，以获取有关构造权限字符串的帮助。

permissions?: DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

属性值

DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

preauthorizedAgentObjectId

可选。 从版本 2020-02-10 开始，以 GUID 格式指定授权的 AAD 对象 ID。 用户委派密钥所有者授权以执行 SAS 授予的操作的用户的 AAD 对象 ID。 Azure 存储服务将确保用户委派密钥的所有者在授予访问权限之前具有所需的权限，但不会对此值中指定的用户执行其他权限检查。 这不能用于与 agentObjectId 的 conjuction。 这仅用于用户委派 SAS。

preauthorizedAgentObjectId?: string

属性值

string

protocol

可选。 SAS 协议、仅限 HTTPS 或 HTTPSandHTTP

protocol?: SASProtocol

属性值

SASProtocol

snapshotTime

可选。 SAS 用户可以访问的快照时间戳字符串。 仅在 API 版本 2018-11-09 中受支持。

snapshotTime?: string

属性值

string

startsOn

可选。 SAS 何时生效。

startsOn?: Date

属性值

Date

version

此 SAS 将面向的服务的版本。 如果未指定，它将默认为库所面向的版本。

version?: string

属性值

string