@azure/storage-queue package
類別
| AccountSASPermissions |
僅適用於運行時間NODE.JS。 這是協助程序類別,用來建構代表 AccountSAS 授與之許可權的字串。 將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該作業的許可權。 設定所有值之後,應該使用 toString 串行化,並設定為 <xref:AccountSASSignatureValues> 對象的許可權欄位。 可以建構沒有這個類別的許可權字串,但許可權的順序是特定的,而且這個類別保證正確性。 |
| AccountSASResourceTypes |
僅適用於運行時間NODE.JS。 這是協助程序類別,用來建構代表 AccountSAS 可存取之資源的字串。 將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該資源類型的存取權。 設定所有值之後,應該使用 toString 串行化,並設定為 <xref:AccountSASSignatureValues> 物件上的資源欄位。 可以建構沒有這個類別的資源字串,但資源的順序是特定的,而且這個類別保證正確性。 |
| AccountSASServices |
僅適用於運行時間NODE.JS。 這是協助程序類別,用來建構代表 AccountSAS 可存取之服務的字串。 將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該服務的存取權。 設定所有值之後,應該使用 toString 串行化,並將 設定為 <xref:AccountSASSignatureValues> 物件上的服務欄位。 可以建構沒有這個類別的服務字串,但服務的順序是特別的,而這個類別保證正確性。 |
| AnonymousCredential |
AnonymousCredential 提供用來建立 <xref:CredentialPolicyCreator> 物件的 <xref:AnonymousCredentialPolicy> 成員。 <xref:AnonymousCredentialPolicy> 會與讀取公用資源的 HTTP(S) 要求搭配使用,或與共用存取簽章搭配使用(SAS)。 |
| AnonymousCredentialPolicy |
AnonymousCredentialPolicy 會與讀取公用資源的 HTTP(S) 要求搭配使用,或用於共用存取簽章(SAS)。 |
| Credential |
Credential 是 Azure 記憶體 HTTP 要求簽署的抽象類。 此類別會裝載一個 credentialPolicyCreator Factory,其會產生 CredentialPolicy。 |
| CredentialPolicy |
在傳送之前,用來簽署 HTTP(S) 要求的認證原則。 這是抽象類。 |
| Pipeline |
包含 HTTP 要求原則的 Pipeline 類別。 您可以呼叫 newPipeline() 來建立預設管線。 或者,您可以透過管線的建構函式,使用您自己的原則建立管線。 在實作自定義管線之前,請參閱 newPipeline() 並提供的原則作為參考。 |
| QueueClient |
QueueClient 代表 Azure 記憶體佇列訊息的 URL,可讓您作其訊息。 |
| QueueSASPermissions |
僅適用於運行時間NODE.JS。 這是協助程序類別,用來建構字串,代表 ServiceSAS 授與佇列的許可權。 將值設定為 true 表示任何使用這些許可權的 SAS 都會授與該作業的許可權。 設定所有值之後,應該使用 toString 串行化,並設定為 <xref:QueueSASSignatureValues> 對象的許可權欄位。 可以建構沒有這個類別的許可權字串,但許可權的順序是特定的,而且這個類別保證正確性。 |
| QueueServiceClient |
QueueServiceClient 代表 Azure 記憶體佇列服務的 URL,可讓您作佇列。 |
| SASQueryParameters |
表示組成 Azure 記憶體 SAS 查詢參數的元件。 使用者不會直接建構此類型;它只會由 <xref:AccountSASSignatureValues> 和 <xref:QueueSASSignatureValues> 類型產生。 產生之後,它可以編碼成 <xref:String> 並直接附加至 URL(不過,如果現有的查詢參數存在,則應該在這裡小心,這可能會影響附加這些查詢參數的適當方法)。 注意:這個類別的實例是不可變的。 |
| StorageBrowserPolicy |
StorageBrowserPolicy 會處理 Node.js 與瀏覽器運行時間之間的差異,包括:
|
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory 是一種處理站類別,可協助產生 <xref:StorageBrowserPolicy> 物件。 |
| StorageClient |
StorageClient 代表 <xref:QueueServiceClient>、<xref:QueueClient> 等的型客戶端類別。 |
| StorageClientContext | |
| StorageRetryPolicy |
重試原則,並實作指數重試和線性重試。 |
| StorageRetryPolicyFactory |
StorageRetryPolicyFactory 是一種處理站類別,可協助產生 <xref:StorageRetryPolicy> 物件。 |
| StorageSharedKeyCredential |
僅適用於運行時間NODE.JS。 Azure 記憶體服務帳戶密鑰授權的 StorageSharedKeyCredential。 |
| StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy 是用來使用共用密鑰簽署 HTTP 要求的原則。 |
介面
| AccessPolicy |
存取原則 |
| AccountSASSignatureValues |
僅適用於運行時間NODE.JS。 AccountSASSignatureValues 可用來產生 Azure 記憶體帳戶的共用存取簽章(SAS)。 一旦適當地設定這裡的所有值,請呼叫 generateSASQueryParameters() 以取得實際可以套用至佇列 URL 的 SAS 表示法。 注意:此類別和 <xref:SASQueryParameters> 都存在,因為前者是可變的,而邏輯表示法則是固定的,而且用來產生實際的 REST 要求。 |
| CommonOptions |
每個遠端作業通用選項的介面。 |
| CorsRule |
CORS 是一項 HTTP 功能,可讓一個網域下執行的 Web 應用程式存取另一個網域中的資源。 網頁瀏覽器會實作稱為相同來源原則的安全性限制,以防止網頁在不同的網域中呼叫 API;CORS 提供安全的方式,允許一個網域(原始網域)在另一個網域中呼叫 API |
| DequeuedMessageItem |
在佇列上呼叫 Get Messages 時,QueueMessageList 陣列中傳回的物件。 |
| EnqueuedMessage |
在佇列上呼叫 Put Message 時,QueueMessageList 陣列中傳回的物件 |
| GeoReplication |
次要記憶體服務的 Geo-Replication 資訊 |
| ListQueuesSegmentResponse |
在佇列服務上呼叫清單佇列時傳回的物件。 |
| Logging |
Azure Analytics 記錄設定。 |
| MessageIdDeleteHeaders |
定義MessageId_delete作業的標頭。 |
| MessageIdUpdateHeaders |
定義MessageId_update作業的標頭。 |
| MessagesClearHeaders |
定義Messages_clear作業的標頭。 |
| MessagesDequeueHeaders |
定義Messages_dequeue作業的標頭。 |
| MessagesDequeueOptionalParams |
選擇性參數。 |
| MessagesEnqueueHeaders |
定義Messages_enqueue作業的標頭。 |
| MessagesEnqueueOptionalParams |
選擇性參數。 |
| MessagesPeekHeaders |
定義Messages_peek作業的標頭。 |
| MessagesPeekOptionalParams |
選擇性參數。 |
| Metadata |
索引鍵/值字串組的集合。 |
| Metrics |
表示計量的介面。 |
| PeekedMessageItem |
在佇列上呼叫查看訊息時,QueueMessageList 陣列中傳回的物件 |
| PipelineOptions |
管線建構函式的選項介面。 |
| QueueClearMessagesOptions |
設定 <xref:QueueClient.clearMessages> 作業的選項 |
| QueueCreateHeaders |
定義Queue_create作業的標頭。 |
| QueueCreateIfNotExistsResponse |
包含 <xref:QueueClient.createIfNotExists> 作業的響應數據。 |
| QueueCreateOptions |
設定 <xref:QueueClient.create> 作業的選項 |
| QueueDeleteHeaders |
定義Queue_delete作業的標頭。 |
| QueueDeleteIfExistsResponse |
包含 <xref:QueueClient.deleteIfExists> 作業的響應數據。 |
| QueueDeleteMessageOptions |
設定 <xref:QueueClient.deleteMessage> 作業的選項 |
| QueueDeleteOptions |
設定 <xref:QueueClient.delete> 作業的選項 |
| QueueExistsOptions |
設定 <xref:QueueClient.exists> 作業的選項 |
| QueueGenerateSasUrlOptions |
設定 <xref:QueueClient.generateSasUrl> 作業的選項。 |
| QueueGetAccessPolicyHeaders |
定義Queue_getAccessPolicy作業的標頭。 |
| QueueGetAccessPolicyOptions |
設定 <xref:QueueClient.getAccessPolicy> 作業的選項 |
| QueueGetPropertiesHeaders |
定義Queue_getProperties作業的標頭。 |
| QueueGetPropertiesOptions |
設定 <xref:QueueClient.getProperties> 作業的選項 |
| QueueItem |
Azure 記憶體佇列。 |
| QueuePeekMessagesOptions |
設定 <xref:QueueClient.peekMessages> 作業的選項 |
| QueueReceiveMessageOptions |
設定 <xref:QueueClient.receiveMessages> 作業的選項 |
| QueueSASSignatureValues |
僅適用於運行時間NODE.JS。 QueueSASSignatureValues 可用來協助產生佇列服務的 SAS 令牌。 |
| QueueSendMessageOptions |
設定 <xref:QueueClient.sendMessage> 作業的選項 |
| QueueServiceProperties |
記憶體服務屬性。 |
| QueueServiceStatistics |
記憶體服務的統計數據。 |
| QueueSetAccessPolicyHeaders |
定義Queue_setAccessPolicy作業的標頭。 |
| QueueSetAccessPolicyOptions |
設定 <xref:QueueClient.setAccessPolicy> 作業的選項 |
| QueueSetMetadataHeaders |
定義Queue_setMetadata作業的標頭。 |
| QueueSetMetadataOptions |
設定 <xref:QueueClient.setMetadata> 作業的選項 |
| QueueUpdateMessageOptions |
設定 <xref:QueueClient.updateMessage> 作業的選項 |
| RetentionPolicy |
保留原則 |
| SasIPRange |
SAS 允許的IP範圍。 |
| ServiceGenerateAccountSasUrlOptions |
設定 <xref:QueueServiceClient.generateAccountSasUrl> 作業的選項。 |
| ServiceGetPropertiesHeaders |
定義Service_getProperties作業的標頭。 |
| ServiceGetPropertiesOptions |
設定 <xref:QueueServiceClient.getProperties> 作業的選項 |
| ServiceGetStatisticsHeaders |
定義Service_getStatistics作業的標頭。 |
| ServiceGetStatisticsOptions |
設定 <xref:QueueServiceClient.getStatistics> 作業的選項 |
| ServiceListQueuesOptions |
設定 <xref:QueueServiceClient.listQueues> 作業的選項 |
| ServiceListQueuesSegmentHeaders |
定義Service_listQueuesSegment作業的標頭。 |
| ServiceSetPropertiesHeaders |
定義Service_setProperties作業的標頭。 |
| ServiceSetPropertiesOptions |
設定 <xref:QueueServiceClient.setProperties> 作業的選項 |
| SignedIdentifier |
帶正負號的標識碼。 |
| SignedIdentifierModel |
帶正負號的標識碼 |
| StorageClientOptionalParams |
選擇性參數。 |
| StoragePipelineOptions |
newPipeline() 方法的選項介面。 |
| StorageRetryOptions |
記憶體佇列重試選項介面。 |
類型別名
| CredentialPolicyCreator |
建立使用所提供 nextPolicy 之新 CredentialPolicy 的 Factory 函式。 |
| GeoReplicationStatusType |
定義 GeoReplicationStatusType 的值。 |
| ListQueuesIncludeType |
定義 ListQueuesIncludeType 的值。 可能的值包括:'metadata' |
| MessageIdDeleteResponse |
包含刪除作業的回應數據。 |
| MessageIdUpdateResponse |
包含更新作業的回應數據。 |
| MessagesClearResponse |
包含清除作業的響應數據。 |
| QueueClearMessagesResponse |
包含 <xref:QueueClient.clearMessages> 作業的響應數據。 |
| QueueCreateResponse |
包含建立作業的響應數據。 |
| QueueDeleteMessageResponse |
包含 <xref:QueueClient.deleteMessage> 作業的響應數據。 |
| QueueDeleteResponse |
包含刪除作業的回應數據。 |
| QueueGetAccessPolicyResponse |
包含 <xref:QueueClient.getAccessPolicy> 作業的響應數據。 |
| QueueGetPropertiesResponse |
包含 getProperties 作業的響應數據。 |
| QueuePeekMessagesResponse |
包含 <xref:QueueClient.peekMessages> 作業的響應數據。 |
| QueueReceiveMessageResponse |
包含 <xref:QueueClient.receiveMessages> 作業的響應數據。 |
| QueueSendMessageResponse |
包含 <xref:QueueClient.sendMessage> 作業的響應數據。 |
| QueueSetAccessPolicyResponse |
包含 setAccessPolicy 作業的響應數據。 |
| QueueSetMetadataResponse |
包含 setMetadata 作業的響應數據。 |
| QueueUpdateMessageResponse |
包含 <xref:QueueClient.updateMessage> 作業的響應數據。 |
| ReceivedMessageItem |
呼叫 |
| ServiceGetPropertiesResponse |
包含 getProperties 作業的響應數據。 |
| ServiceGetStatisticsResponse |
包含 getStatistics 作業的響應數據。 |
| ServiceListQueuesSegmentResponse |
包含 listQueuesSegment 作業的響應數據。 |
| ServiceSetPropertiesResponse |
包含 setProperties 作業的響應數據。 |
列舉
| SASProtocol |
產生的 SAS 通訊協定。 |
| StorageRetryPolicyType |
RetryPolicy 類型。 |
函式
| generate |
僅適用於運行時間NODE.JS。 產生 <xref:SASQueryParameters> 物件,其中包含發出實際 REST 要求所需的所有 SAS 查詢參數。 |
| generate |
僅適用於運行時間NODE.JS。 建立 SASQueryParameters 的實例。 只接受建立 SAS 所需的必要設定。 如需選擇性設定,請直接設定對應的屬性,例如許可權、startsOn 和標識符。 警告:未提供標識符時,需要許可權和 expiresOn。 如果您以這個建構函式初始,您必須將值指派給標識碼或 expiresOn & 許可權。 |
| new |
使用提供的認證建立新的 Pipeline 物件。 |
函式詳細資料
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
僅適用於運行時間NODE.JS。 產生 <xref:SASQueryParameters> 物件,其中包含發出實際 REST 要求所需的所有 SAS 查詢參數。
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
參數
- accountSASSignatureValues
- AccountSASSignatureValues
帳戶的 SAS 簽章值
- sharedKeyCredential
- StorageSharedKeyCredential
共用金鑰認證。
傳回
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)
僅適用於運行時間NODE.JS。 建立 SASQueryParameters 的實例。
只接受建立 SAS 所需的必要設定。 如需選擇性設定,請直接設定對應的屬性,例如許可權、startsOn 和標識符。
警告:未提供標識符時,需要許可權和 expiresOn。 如果您以這個建構函式初始,您必須將值指派給標識碼或 expiresOn & 許可權。
function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
參數
- queueSASSignatureValues
- QueueSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
傳回
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
使用提供的認證建立新的 Pipeline 物件。
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)
參數
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
例如 AnonymousCredential、StorageSharedKeyCredential 或任何來自 @azure/identity 套件的認證,以驗證對服務的要求。 您也可以提供實作 TokenCredential 介面的物件。 如果未指定,則會使用 AnonymousCredential。
- pipelineOptions
- StoragePipelineOptions
選項。
傳回
新的 Pipeline 物件。