SASQueryParameters class

套件:

@azure/storage-queue

表示組成 Azure 記憶體 SAS 查詢參數的元件。 使用者不會直接建構此類型;它只會由 AccountSASSignatureValues 和 QueueSASSignatureValues 類型產生。 產生之後，它可以編碼成 toString() 並直接附加至 URL（不過，如果現有的查詢參數存在，則應該在這裡小心，這可能會影響附加這些查詢參數的適當方法）。

注意：這個類別的實例是不可變的。

建構函式

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

建立 SASQueryParameters 的實例。

屬性

expiresOn	只有在提供標識符時，才為選擇性。 此 SAS 令牌的到期時間。
identifier	自選。 帶正負號的標識碼（僅適用於 queueSASSignatureValues）。 請參閱 https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	自選。 此 SAS 允許的IP範圍。
permissions	只有在提供標識符時，才為選擇性。 如需詳細資訊，請參閱 AccountSASPermissions、QueueSASPermissions。
protocol	自選。 允許的 HTTP 通訊協定（s）。
resource	自選。 記憶體佇列 （僅適用於 QueueSASSignatureValues）。
resourceTypes	自選。 要存取的記憶體資源類型（僅適用於帳戶 SAS）。 如需詳細資訊，請參閱 AccountSASResourceTypes。
services	自選。 要存取的記憶體服務（僅適用於帳戶 SAS）。 如需詳細資訊，請參閱 AccountSASServices。
signature	SAS 令牌的簽章。
startsOn	自選。 此 SAS 令牌的開始時間。
version	記憶體 API 版本。

方法

toString()

將所有 SAS 查詢參數編碼為可附加至 URL 的字串。

建構函式詳細資料

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, 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)

參數

version

string

代表記憶體版本

signature

string

表示 SAS 令牌的簽章

permissions

string

代表記憶體許可權

services

string

代表正在存取的記憶體服務（僅適用於帳戶 SAS）

resourceTypes

string

代表要存取的記憶體資源類型（僅適用於帳戶 SAS）

protocol

SASProtocol

表示允許的 HTTP 通訊協定（s）

startsOn

Date

表示此 SAS 令牌的開始時間

expiresOn

Date

表示此 SAS 令牌的到期時間

ipRange

SasIPRange

表示此 SAS 令牌的有效 IP 位址範圍

identifier

string

代表已簽署的識別碼（僅適用於服務 SAS）

resource

string

代表記憶體佇列（僅適用於服務 SAS）

屬性詳細資料

expiresOn

只有在提供標識符時，才為選擇性。 此 SAS 令牌的到期時間。

expiresOn?: Date

屬性值

Date

identifier

自選。 帶正負號的標識碼（僅適用於 queueSASSignatureValues）。

請參閱 https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy

identifier?: string

屬性值

string

ipRange

自選。 此 SAS 允許的IP範圍。

undefined | SasIPRange ipRange

屬性值

undefined | SasIPRange

permissions

只有在提供標識符時，才為選擇性。 如需詳細資訊，請參閱 AccountSASPermissions、QueueSASPermissions。

permissions?: string

屬性值

string

protocol

自選。 允許的 HTTP 通訊協定（s）。

protocol?: SASProtocol

屬性值

SASProtocol

resource

自選。 記憶體佇列 （僅適用於 QueueSASSignatureValues）。

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