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

SASQueryParameters class

包:

@azure/storage-blob

表示构成 Azure 存储 SAS 查询参数的组件。 此类型不是由用户直接构造的;它仅由 AccountSASSignatureValues 和 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, string, string, string)	创建 SASQueryParameters 的实例。

属性

cacheControl	Blob/文件服务 SAS 中的缓存控制标头的值。
contentDisposition	Blob/文件服务 SAS 中内容处置标头的值。
contentEncoding	Blob/文件服务 SAS 中内容编码标头的值。
contentLanguage	Blob/文件服务 SAS 中内容长度标头的值。
contentType	Blob/文件服务 SAS 中内容类型标头的值。
correlationId	将在存储诊断日志中记录的 GUID 值，可用于将 SAS 生成与存储资源访问相关联。 这仅用于用户委派 SAS。
encryptionScope	自选。 发送经此 SAS URI 授权的请求时要使用的加密范围。
expiresOn	仅当提供标识符时才可选。 此 SAS 令牌的到期时间。
identifier	自选。 签名标识符（仅适用于 BlobSASSignatureValues）。 请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	自选。 此 SAS 允许的 IP 范围。
permissions	仅当提供标识符时才可选。 有关详细信息，请参阅 AccountSASPermissions、BlobSASPermissions或 ContainerSASPermissions。
preauthorizedAgentObjectId	GUID 格式的授权 AAD 对象 ID。 由用户委托密钥所有者授权执行 SAS 授予的作的用户的 AAD 对象 ID。 Azure 存储服务将确保在授予访问权限之前，用户委托密钥的所有者具有所需的权限，但不会对此值中指定的用户执行其他权限检查。 这仅用于用户委派 SAS。
protocol	自选。 允许的 HTTP 协议（s）。
resource	自选。 指定通过 SAS 访问哪些资源（仅适用于 BlobSASSignatureValues）。 请参阅 https://learn.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, 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, preauthorizedAgentObjectId?: 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

表示存储容器或 Blob（仅适用于服务 SAS）

cacheControl

string

表示缓存控制标头（仅适用于 Blob/文件服务 SAS）

contentDisposition

string

表示内容处置标头（仅适用于 Blob/文件服务 SAS）

contentEncoding

string

表示内容编码标头（仅适用于 Blob/文件服务 SAS）

contentLanguage

string

表示内容语言标头（仅适用于 Blob/文件服务 SAS）

contentType

string

表示内容类型标头（仅适用于 Blob/文件服务 SAS）

userDelegationKey

UserDelegationKey

表示用户委托密钥属性

preauthorizedAgentObjectId

string

表示授权的 AAD 对象 ID（仅适用于用户委派 SAS）

correlationId

string

表示相关 ID（仅适用于用户委派 SAS）

encryptionScope

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

encryptionScope

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

encryptionScope?: string

属性值

string

expiresOn

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

expiresOn?: Date

属性值

Date

identifier

自选。 签名标识符（仅适用于 BlobSASSignatureValues）。

请参阅 https://learn.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、BlobSASPermissions或 ContainerSASPermissions。

permissions?: string

属性值

string

preauthorizedAgentObjectId

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

preauthorizedAgentObjectId?: string

属性值

string

protocol

自选。 允许的 HTTP 协议（s）。

protocol?: SASProtocol

属性值

SASProtocol

resource

自选。 指定通过 SAS 访问哪些资源（仅适用于 BlobSASSignatureValues）。

请参阅 https://learn.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