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/File Service SAS 中內容處置標頭的值。
contentEncoding

Blob/檔案服務 SAS 中內容編碼標頭的值。
contentLanguage

Blob/檔案服務 SAS 中內容長度標頭的值。
contentType

Blob/File Service SAS 中內容類型標頭的值。
correlationId

將會記錄在儲存體診斷記錄中的 GUID 值，可用來將 SAS 產生與儲存體資源存取相互關聯。 這只適用于使用者委派 SAS。
encryptionScope

選擇性。 傳送具有此 SAS URI 授權的要求時要使用的加密範圍。
expiresOn

只有在提供識別碼時，才選擇性。 此 SAS 權杖的到期時間。
identifier

選擇性。 只有 BlobSASSignatureValues) 的已簽署識別碼 (。

請參閱https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange

選擇性。 此 SAS 允許的 IP 範圍。
permissions

只有在提供識別碼時，才選擇性。 如需詳細資訊，請參閱 AccountSASPermissions、 BlobSASPermissions或 ContainerSASPermissions 。
preauthorizedAgentObjectId

GUID 格式的授權 AAD 物件識別碼。 使用者委派金鑰擁有者授權之使用者的 AAD 物件識別碼，以執行 SAS 授與的動作。 Azure 儲存體服務會先確保使用者委派金鑰的擁有者具有必要的許可權，再授與存取權，但不會執行此值中所指定使用者的額外許可權檢查。 這只適用于使用者委派 SAS。
protocol

選擇性。 允許的 HTTP 通訊協定 () 。
resource

選擇性。 指定只有 BlobSASSignatureValues) 才能透過 SAS (存取哪些資源。

請參閱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, 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

僅代表服務 SAS) 的儲存體容器或 Blob (

cacheControl

string

僅代表 Blob/檔案服務 SAS) 的快取控制標頭 (

contentDisposition

string

僅代表 Blob/檔案服務 SAS) 的內容處置標頭 (

contentEncoding

string

僅代表 Blob/檔案服務 SAS) 的內容編碼標頭 (

contentLanguage

string

僅代表 Blob/檔案服務 SAS) 的內容語言標頭 (

contentType

string

只代表 Blob/檔案服務 SAS) 的內容類型標頭 (

userDelegationKey
UserDelegationKey

表示使用者委派索引鍵屬性

preauthorizedAgentObjectId

string

僅代表使用者委派 SAS) 的授權 AAD 物件識別碼 (

correlationId

string

僅代表使用者委派 SAS) 的相互關聯識別碼 (

encryptionScope

string

屬性詳細資料

cacheControl

Blob/檔案服務 SAS 中快取控制標頭的值。

cacheControl?: string

屬性值

string

contentDisposition

Blob/File Service SAS 中內容處置標頭的值。

contentDisposition?: string

屬性值

string

contentEncoding

Blob/檔案服務 SAS 中內容編碼標頭的值。

contentEncoding?: string

屬性值

string

contentLanguage

Blob/檔案服務 SAS 中內容長度標頭的值。

contentLanguage?: string

屬性值

string

contentType

Blob/File Service 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://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、 BlobSASPermissions或 ContainerSASPermissions 。

permissions?: string

屬性值

string

preauthorizedAgentObjectId

GUID 格式的授權 AAD 物件識別碼。 使用者委派金鑰擁有者授權之使用者的 AAD 物件識別碼，以執行 SAS 授與的動作。 Azure 儲存體服務會先確保使用者委派金鑰的擁有者具有必要的許可權，再授與存取權，但不會執行此值中所指定使用者的額外許可權檢查。 這只適用于使用者委派 SAS。

preauthorizedAgentObjectId?: string

屬性值

string

protocol

選擇性。 允許的 HTTP 通訊協定 () 。

protocol?: SASProtocol

屬性值

SASProtocol

resource

選擇性。 指定只有 BlobSASSignatureValues) 才能透過 SAS (存取哪些資源。

請參閱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