@azure/storage-queue package
類別
AccountSASPermissions |
僅適用於 NODE.JS 運行時間。 這是協助程序類別,用來建構代表 AccountSAS 授與之許可權的字串。 將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該作業的許可權。 設定所有值之後,這應該使用 toString 串行化,並設定為 AccountSASSignatureValues 對象的許可權欄位。 可以建構沒有這個類別的許可權字串,但許可權的順序是特定的,而且這個類別保證正確性。 |
AccountSASResourceTypes |
僅適用於 NODE.JS 運行時間。 這是協助程序類別,可建構代表 AccountSAS 可存取之資源的字串。 將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該資源類型的存取權。 設定所有值之後,這應該使用 toString 串行化,並設定為 AccountSASSignatureValues 物件上的資源字段。 可以建構不含此類別的資源字串,但資源的順序是特定的,而且此類別保證正確性。 |
AccountSASServices |
僅適用於 NODE.JS 運行時間。 這是協助程序類別,可建構代表 AccountSAS 可存取之服務的字串。 將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該服務的存取權。 設定所有值之後,這應該使用 toString 串行化,並設定為 AccountSASSignatureValues 物件上的服務字段。 可以建構不含此類別的服務字串,但服務的順序是特定的,而且此類別保證正確性。 |
AnonymousCredential |
AnonymousCredential 提供 CredentialPolicyCreator 成員,用來建立 AnonymousCredentialPolicy 物件。 AnonymousCredentialPolicy 會搭配 HTTP (S) 要求使用,這些要求會讀取公用資源,或用於共用存取簽章 (SAS) 。 |
AnonymousCredentialPolicy |
AnonymousCredentialPolicy 會搭配 HTTP (S) 要求使用,這些要求會讀取公用資源,或用於共用存取簽章 (SAS) 。 |
BaseRequestPolicy |
從中衍生所有要求原則的基類。 |
Credential |
Credential 是 Azure 記憶體 HTTP 要求簽署的抽象類。 此類別會裝載 credentialPolicyCreator Factory,以產生 CredentialPolicy。 |
CredentialPolicy |
用來在傳送之前簽署 HTTP (S) 要求的認證原則。 這是 abstract 類別。 |
HttpHeaders |
HTTP 標頭索引鍵/值組的集合。 |
Pipeline |
包含 HTTP 要求原則的 Pipeline 類別。 您可以呼叫 newPipeline () 來建立預設管線。 或者,您也可以使用管線的建構函式,使用自己的原則建立管線。 在實作自定義管線之前,請參閱 newPipeline () 並提供原則作為參考。 |
QueueClient |
QueueClient 代表 Azure 記憶體佇列訊息的 URL,可讓您操作其訊息。 |
QueueSASPermissions |
僅適用於 NODE.JS 運行時間。 這是協助程序類別,用來建構字串,代表 ServiceSAS 授與佇列的許可權。 將值設定為 true 表示使用這些許可權的任何 SAS 都會授與該作業的許可權。 設定所有值之後,這應該使用 toString 串行化,並設定為 QueueSASSignatureValues 對象的許可權欄位。 可以建構沒有這個類別的許可權字串,但許可權的順序是特定的,而且這個類別保證正確性。 |
QueueServiceClient |
QueueServiceClient 代表 Azure 記憶體佇列服務的 URL,可讓您操作佇列。 |
RequestPolicyOptions |
建立 RequestPolicy 時可以使用的選擇性屬性。 |
RestError |
從 HTTP 要求到服務端點所產生的錯誤。 |
SASQueryParameters |
代表組成 Azure 記憶體 SAS 查詢參數的元件。 使用者不會直接建構此類型;它只會由 AccountSASSignatureValues 和 QueueSASSignatureValues 類型產生。 產生之後,就可以將它編碼為 toString() ,並直接附加至 URL (不過,如果有現有的查詢參數,這可能會影響附加這些查詢參數的適當方法) 。 注意:此類別的實例是不可變的。 |
StorageBrowserPolicy |
StorageBrowserPolicy 會處理 Node.js 與瀏覽器運行時間之間的差異,包括:
|
StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory 是一種處理站類別,可協助產生 StorageBrowserPolicy 物件。 |
StorageRetryPolicy |
實作指數重試和線性重試的重試原則。 |
StorageRetryPolicyFactory |
StorageRetryPolicyFactory 是一種處理站類別,可協助產生 StorageRetryPolicy 物件。 |
StorageSharedKeyCredential |
僅適用於 NODE.JS 運行時間。 Azure 記憶體服務帳戶密鑰授權的 StorageSharedKeyCredential。 |
StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy 是用來使用共用密鑰簽署 HTTP 要求的原則。 |
WebResource |
建立新的 WebResource 物件。 這個類別提供 REST 呼叫的抽象概念,其方式是連結庫/實作無關,並包裝必要的屬性來起始要求。 |
介面
類型別名
列舉
SASProtocol |
所產生 SAS 的通訊協定。 |
StorageQueueAudience |
定義記憶體的已知雲端物件。 |
StorageRetryPolicyType |
RetryPolicy 類型。 |
函數
deserialization |
建立新的串行化 RequestPolicyCreator,以在通過 HTTP 管線時串行化 HTTP 要求主體。 |
generate |
僅適用於 NODE.JS 運行時間。 產生 SASQueryParameters 物件,其中包含發出實際 REST 要求所需的所有 SAS 查詢參數。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas |
generate |
僅適用於 NODE.JS 運行時間。 建立 SASQueryParameters 的實例。 只接受建立 SAS 所需的必要設定。 針對選擇性設定,請直接設定對應的屬性,例如許可權、startsOn 和標識符。 警告:未提供標識符時,需要許可權和 expiresOn。 如果您一開始使用這個建構函式,則必須將值指派給標識碼或到期 & 許可權。 |
get |
|
new |
使用提供的 Credential 建立新的 Pipeline 物件。 |
函式詳細資料
deserializationPolicy(DeserializationContentTypes, SerializerOptions)
建立新的串行化 RequestPolicyCreator,以在通過 HTTP 管線時串行化 HTTP 要求主體。
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory
參數
- deserializationContentTypes
- DeserializationContentTypes
- parsingOptions
- SerializerOptions
傳回
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
僅適用於 NODE.JS 運行時間。
產生 SASQueryParameters 物件,其中包含發出實際 REST 要求所需的所有 SAS 查詢參數。
請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
參數
- accountSASSignatureValues
- AccountSASSignatureValues
帳戶的 SAS 簽章值
- sharedKeyCredential
- StorageSharedKeyCredential
共用金鑰認證。
傳回
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)
僅適用於 NODE.JS 運行時間。
建立 SASQueryParameters 的實例。
只接受建立 SAS 所需的必要設定。 針對選擇性設定,請直接設定對應的屬性,例如許可權、startsOn 和標識符。
警告:未提供標識符時,需要許可權和 expiresOn。 如果您一開始使用這個建構函式,則必須將值指派給標識碼或到期 & 許可權。
function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
參數
- queueSASSignatureValues
- QueueSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
傳回
getQueueServiceAccountAudience(string)
function getQueueServiceAccountAudience(storageAccountName: string): string
參數
- storageAccountName
-
string
傳回
string
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
使用提供的 Credential 建立新的 Pipeline 物件。
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline
參數
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
例如 AnonymousCredential、StorageSharedKeyCredential 或任何來自封裝的 @azure/identity
認證,以驗證對服務的要求。 您也可以提供實作 TokenCredential 介面的物件。 如果未指定,則會使用 AnonymousCredential。
- pipelineOptions
- StoragePipelineOptions
選項。
傳回
新的 Pipeline 物件。