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

SASQueryParameters class

参考

包:: @azure/storage-file-datalake

表示构成 Azure 存储 SAS 查询参数的组件。此类型不是由用户直接构造的;它仅由 AccountSASSignatureValues 和 <xref:BlobSASSignatureValues> 类型生成。生成后，可以将其编码为并 toString() 直接追加到 URL (不过，如果存在现有的查询参数，这可能会影响) 追加这些查询参数的适当方式，但此处应小心谨慎。

注意：此类的实例是不可变的。

构造函数

SASQueryParameters(string, string, SASQueryParametersOptions)	创建 SASQueryParameters 的实例。
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, number, string, string, string, string)	创建 SASQueryParameters 的实例。

属性

agentObjectId	GUID 格式的未经授权的 AAD 对象 ID。用户委派密钥的所有者假定未授权的用户的 AAD 对象 ID。 Azure 存储服务将执行额外的 POSIX ACL 检查，以确定用户是否有权执行请求的操作。这不能用于与 <xref:signedAuthorizedUserObjectId>的结合。这仅用于用户委派 SAS。
cacheControl	Blob/文件服务 SAS 中缓存控制标头的值。
contentDisposition	Blob/文件服务 SAS 中内容处置标头的值。
contentEncoding	Blob/文件服务 SAS 中内容编码标头的值。
contentLanguage	Blob/文件服务 SAS 中内容长度标头的值。
contentType	Blob/文件服务 SAS 中内容类型标头的值。
correlationId	一个 GUID 值，该值将记录在存储诊断日志中，可用于将 SAS 生成与存储资源访问相关联。这仅用于用户委派 SAS。
directoryDepth	指示字符串到签名的规范化resource 字段中指定的目录的深度。目录的深度是根文件夹下的目录数。
encryptionScope	可选。发送使用此 SAS URI 授权的请求时要使用的加密范围。
expiresOn	仅当提供标识符时才可选。此 SAS 令牌的到期时间。
identifier	可选。签名标识符仅 () <xref:BlobSASSignatureValues> 。请参见https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	可选。此 SAS 允许的 IP 范围。
permissions	仅当提供标识符时才可选。有关详细信息，请参阅 AccountSASPermissions、 <xref:BlobSASPermissions>或 <xref:ContainerSASPermissions> 。
preauthorizedAgentObjectId	GUID 格式的授权 AAD 对象 ID。用户委派密钥所有者授权执行 SAS 授予的操作的用户的 AAD 对象 ID。 Azure 存储服务将确保用户委派密钥的所有者在授予访问权限之前具有所需的权限，但不会对此值中指定的用户执行其他权限检查。这不能用于与 <xref:signedUnauthorizedUserObjectId>的结合。这仅用于用户委派 SAS。
protocol	可选。允许的 HTTP 协议 () 。
resource	可选。指定只能通过 SAS (访问 <xref:BlobSASSignatureValues>) 的资源。请参见https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
resourceTypes	可选。仅帐户 SAS) (访问的存储资源类型。有关更多详细信息，请参阅 AccountSASResourceTypes 。
services	可选。仅帐户 SAS) (访问的存储服务。有关更多详细信息，请参阅 AccountSASServices 。
signature	SAS 令牌的签名。
startsOn	可选。此 SAS 令牌的开始时间。
version	存储 API 版本。

方法

toString()

将所有 SAS 查询参数编码为可以追加到 URL 的字符串。

构造函数详细信息

SASQueryParameters(string, string, SASQueryParametersOptions)

创建 SASQueryParameters 的实例。

new SASQueryParameters(version: string, signature: string, options?: SASQueryParametersOptions)

参数

version: string

表示存储版本

signature: string

表示 SAS 令牌的签名

options: SASQueryParametersOptions

可选。用于构造 SASQueryParameters 的选项。

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, number, string, string, string, string)

创建 SASQueryParameters 的实例。

new SASQueryParameters(version: string, signature: string, permissions?: string, services?: string, resourceTypes?: string, protocol?: SASProtocol, startsOn?: Date, expiresOn?: Date, ipRange?: SasIPRange, identifier?: string, resource?: string, cacheControl?: string, contentDisposition?: string, contentEncoding?: string, contentLanguage?: string, contentType?: string, userDelegationKey?: UserDelegationKey, directoryDepth?: number, preauthorizedAgentObjectId?: string, agentObjectId?: string, correlationId?: string, encryptionScope?: string)

参数

version: string

表示存储版本

signature: string

表示 SAS 令牌的签名

permissions: string

表示存储权限

services: string

表示仅针对帐户 SAS) (访问的存储服务

resourceTypes: string

表示仅针对帐户 SAS) (访问的存储资源类型

protocol: SASProtocol

表示允许的 HTTP 协议 ()

startsOn: Date

表示此 SAS 令牌的开始时间

expiresOn: Date

表示此 SAS 令牌的到期时间

ipRange: SasIPRange

表示此 SAS 令牌的有效 IP 地址范围

identifier: string

仅表示服务 SAS) 的签名标识符 (

resource: string

仅表示服务 SAS) 的存储容器或 blob (

cacheControl: string

仅表示 Blob/文件服务 SAS) 的缓存控制标头 (

contentDisposition: string

仅表示 Blob/文件服务 SAS) 的内容处置标头 (

contentEncoding: string

仅表示 Blob/文件服务 SAS) 的内容编码标头 (

contentLanguage: string

仅表示 Blob/文件服务 SAS) 的内容语言标头 (

contentType: string

仅表示 Blob/文件服务 SAS) 的内容类型标头 (

userDelegationKey: UserDelegationKey

表示用户委派密钥属性

directoryDepth: number

preauthorizedAgentObjectId: string

仅表示用户委派 SAS (授权的 AAD 对象 ID)

agentObjectId: string

仅表示用户委派 SAS) (未经授权的 AAD 对象 ID

correlationId: string

仅表示用户委派 SAS) 的相关 ID (

encryptionScope: string

属性详细信息

agentObjectId

GUID 格式的未经授权的 AAD 对象 ID。用户委派密钥的所有者假定未授权的用户的 AAD 对象 ID。 Azure 存储服务将执行额外的 POSIX ACL 检查，以确定用户是否有权执行请求的操作。这不能用于与 <xref:signedAuthorizedUserObjectId>的结合。这仅用于用户委派 SAS。

agentObjectId?: string

属性值

string

cacheControl

Blob/文件服务 SAS 中缓存控制标头的值。

cacheControl?: string

属性值

string

contentDisposition

Blob/文件服务 SAS 中内容处置标头的值。

contentDisposition?: string

属性值

string

contentEncoding

Blob/文件服务 SAS 中内容编码标头的值。

contentEncoding?: string

属性值

string

contentLanguage

Blob/文件服务 SAS 中内容长度标头的值。

contentLanguage?: string

属性值

string

contentType

Blob/文件服务 SAS 中内容类型标头的值。

contentType?: string

属性值

string

correlationId

一个 GUID 值，该值将记录在存储诊断日志中，可用于将 SAS 生成与存储资源访问相关联。这仅用于用户委派 SAS。

correlationId?: string

属性值

string

directoryDepth

指示字符串到签名的规范化resource 字段中指定的目录的深度。目录的深度是根文件夹下的目录数。

directoryDepth?: number

属性值

number

encryptionScope

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

encryptionScope?: string

属性值

string

expiresOn

仅当提供标识符时才可选。此 SAS 令牌的到期时间。

expiresOn?: Date

属性值

Date

identifier

可选。签名标识符仅 () <xref:BlobSASSignatureValues> 。

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

identifier?: string

属性值

string

ipRange

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

undefined | SasIPRange ipRange

属性值

undefined | SasIPRange

permissions

仅当提供标识符时才可选。有关详细信息，请参阅 AccountSASPermissions、 <xref:BlobSASPermissions>或 <xref:ContainerSASPermissions> 。

permissions?: string

属性值

string

preauthorizedAgentObjectId

GUID 格式的授权 AAD 对象 ID。用户委派密钥所有者授权执行 SAS 授予的操作的用户的 AAD 对象 ID。 Azure 存储服务将确保用户委派密钥的所有者在授予访问权限之前具有所需的权限，但不会对此值中指定的用户执行其他权限检查。这不能用于与 <xref:signedUnauthorizedUserObjectId>的结合。这仅用于用户委派 SAS。

preauthorizedAgentObjectId?: string

属性值

string

protocol

可选。允许的 HTTP 协议 () 。

protocol?: SASProtocol

属性值

SASProtocol

resource

可选。指定只能通过 SAS (访问 <xref:BlobSASSignatureValues>) 的资源。

请参见https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only

resource?: string

属性值

string

resourceTypes

可选。仅帐户 SAS) (访问的存储资源类型。有关更多详细信息，请参阅 AccountSASResourceTypes 。

resourceTypes?: string

属性值

string

services

可选。仅帐户 SAS) (访问的存储服务。有关更多详细信息，请参阅 AccountSASServices 。

services?: string

属性值

string

signature

SAS 令牌的签名。

signature: string

属性值

string

startsOn

可选。此 SAS 令牌的开始时间。

startsOn?: Date

属性值

Date

version

存储 API 版本。

version: string

属性值

string

方法详细信息

toString()

将所有 SAS 查询参数编码为可以追加到 URL 的字符串。

function toString(): string

string

通过

SASQueryParameters class

构造函数

属性

方法

构造函数详细信息

SASQueryParameters(string, string, SASQueryParametersOptions)

参数

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, number, string, string, string, string)

参数

属性详细信息

agentObjectId

属性值

cacheControl

属性值

contentDisposition

属性值

contentEncoding

属性值

contentLanguage

属性值

contentType

属性值

correlationId

属性值

directoryDepth

属性值

encryptionScope

属性值

expiresOn

属性值

identifier

属性值

ipRange

属性值

permissions

属性值

preauthorizedAgentObjectId

属性值

protocol

属性值

resource

属性值

resourceTypes

属性值

services

属性值

signature

属性值

startsOn

属性值

version

属性值

方法详细信息

toString()

返回

其他资源