QueueService class

リファレンス

パッケージ:: azure-storage

Extends: azure-storage.export=.common.services.storageserviceclient.StorageServiceClient

コンストラクター

QueueService(string, string, string | StorageHost, string, string)

新しい QueueService オブジェクトを作成します。

QueueService クラスは、Microsoft Azure Queue Service に対して操作を実行するために使用されます。

キューサービスの使用の詳細と、Node.js アプリケーションからのキューサービスの使用に関するタスクに重点を置いた情報については、「How to Use the Queue Service from Node.js」を参照してください。キューサービスでは、次の既定値を設定できます。 messageEncoder QueueService がキューメッセージをエンコードおよびデコードする方法を指定するメッセージエンコーダー。既定値は [TextXmlQueueMessageEncoder](xref:azure-storage.export=.services.queue.QueueMessageEncoder.TextXmlQueueMessageEncoder) です。 defaultTimeoutIntervalInMs キューサービスを介して行われた要求に使用する既定のタイムアウト間隔 (ミリ秒単位)。 defaultClientRequestTimeoutInMs キューサービスを介して行われた要求に使用するクライアント要求の既定のタイムアウト (ミリ秒単位)。 defaultMaximumExecutionTimeInMs キューサービス経由で行われた要求に対する、すべての再試行の既定の最大実行時間。 defaultLocationMode キューサービスを介して行われた要求の既定の場所モード。 useNagleAlgorithm キューサービスを介して行われた要求に Nagle アルゴリズムを使用するかどうかを決定します。を使用する場合は true
Nagle アルゴリズム;それ以外の場合は false。既定値は false です。 enableGlobalHttpAgent グローバル HTTP エージェントが有効かどうかを判断します。グローバル HTTP エージェントを使用する場合は true。それ以外の場合は、http を使用する場合は false。Agent({keepAlive:true})。接続文字列または storageaccount と storageaccesskey が指定されていない場合は、AZURE_STORAGE_CONNECTION_STRINGまたはAZURE_STORAGE_ACCOUNTとAZURE_STORAGE_ACCESS_KEY環境変数が使用されます。

プロパティ

messageEncoder

継承されたプロパティ

defaultClientRequestTimeoutInMs	要求に使用するクライアント要求の既定のタイムアウト (ミリ秒単位)。
defaultLocationMode	サービスを介して行われた要求の既定の場所モード。
defaultMaximumExecutionTimeInMs	サービス経由で行われた要求に対するすべての再試行の既定の最大実行時間。
defaultTimeoutIntervalInMs	サービス経由で行われた要求に使用する既定のタイムアウト間隔 (ミリ秒単位)。
enableGlobalHttpAgent	グローバル HTTP エージェントが有効かどうかを判断します。グローバル HTTP エージェントを使用する場合は true。それ以外の場合は、http を使用する場合は false。Agent({keepAlive:true})。
logger	ログ設定オブジェクト。
proxy	呼び出し元によって指定されたプロキシオブジェクト。
useNagleAlgorithm	キューサービスを介して行われた要求に Nagle アルゴリズムを使用するかどうかを決定します。Nagle アルゴリズムを使用する場合は true。それ以外の場合は false。既定値は false です。

メソッド

clearMessages(string, ErrorOrResponse)	すべてのメッセージをキューからクリアします。
clearMessages(string, RequestOptions, ErrorOrResponse)	すべてのメッセージをキューからクリアします。
createMessage(string, string \| Buffer, CreateMessageRequestOptions, ErrorOrResult<QueueMessageResult>)	メッセージキューの背面に新しいメッセージを追加します。エンコードされたメッセージの最大サイズは、バージョン 2011-08-18 以降では 64 KB、これより前のバージョンでは 8 KB です。エンコードされていないメッセージは、UTF-8 エンコードを使用して XML 要求に含めることができる形式である必要があります。キューメッセージは既定でエンコードされます。エンコードの既定値を設定するには、「queueService.messageEncoder」を参照してください。例 `var azure = require('azure-storage'); var queueService = azure.createQueueService(); queueService.createMessage('taskqueue', 'Hello world!', function(error) { if(!error) { // Message inserted } });`
createMessage(string, string \| Buffer, ErrorOrResult<QueueMessageResult>)	メッセージキューの背面に新しいメッセージを追加します。エンコードされたメッセージの最大サイズは、バージョン 2011-08-18 以降では 64 KB、これより前のバージョンでは 8 KB です。エンコードされていないメッセージは、UTF-8 エンコードを使用して XML 要求に含めることができる形式である必要があります。キューメッセージは既定でエンコードされます。エンコードの既定値を設定するには、「queueService.messageEncoder」を参照してください。例 `var azure = require('azure-storage'); var queueService = azure.createQueueService(); queueService.createMessage('taskqueue', 'Hello world!', function(error) { if(!error) { // Message inserted } });`
createQueue(string, CreateQueueRequestOptions, ErrorOrResult<QueueResult>)	指定したアカウントの下位に新しいキューを作成します。
createQueue(string, ErrorOrResult<QueueResult>)	指定したアカウントの下位に新しいキューを作成します。
createQueueIfNotExists(string, CreateQueueRequestOptions, ErrorOrResult<QueueResult>)	指定されたアカウントの下に新しいキューが存在しない場合は作成します。例 `var azure = require('azure-storage'); var queueService = azure.createQueueService(); queueService.createQueueIfNotExists('taskqueue', function(error) { if(!error) { // Queue created or exists } });`
createQueueIfNotExists(string, ErrorOrResult<QueueResult>)	指定されたアカウントの下に新しいキューが存在しない場合は作成します。例 `var azure = require('azure-storage'); var queueService = azure.createQueueService(); queueService.createQueueIfNotExists('taskqueue', function(error) { if(!error) { // Queue created or exists } });`
deleteMessage(string, string, string, ErrorOrResponse)	指定したメッセージをキューから削除します。
deleteMessage(string, string, string, RequestOptions, ErrorOrResponse)	指定したメッセージをキューから削除します。
deleteQueue(string, ErrorOrResponse)	指定したキューを完全に削除します。
deleteQueue(string, RequestOptions, ErrorOrResponse)	指定したキューを完全に削除します。
deleteQueueIfExists(string, ErrorOrResult<boolean>)	指定したキューが存在する場合は、完全に削除します。
deleteQueueIfExists(string, RequestOptions, ErrorOrResult<boolean>)	指定したキューが存在する場合は、完全に削除します。
doesQueueExist(string, ErrorOrResult<QueueResult>)	キューが存在するかどうかを確認します。
doesQueueExist(string, RequestOptions, ErrorOrResult<QueueResult>)	キューが存在するかどうかを確認します。
generateSharedAccessSignature(string, SharedAccessPolicy)	共有アクセス署名トークンを取得します。
generateSharedAccessSignatureWithVersion(string, SharedAccessPolicy, string)	共有アクセス署名トークンを取得します。
getMessage(string, ErrorOrResult<QueueMessageResult>)	キューからメッセージを取得し、コンシューマーから参照不可にします。例 `var azure = require('azure-storage'); var queueService = azure.createQueueService(); var queueName = 'taskqueue'; queueService.getMessage(queueName, function(error, serverMessages) { if(!error) { // Process the message in less than 30 seconds, the message // text is available in serverMessages.messagetext queueService.deleteMessage(queueName, serverMessages.messageId, serverMessages.popReceipt, function(error) { if(!error){ // Message deleted } }); } });`
getMessage(string, GetMessageRequestOptions, ErrorOrResult<QueueMessageResult>)	キューからメッセージを取得し、コンシューマーから参照不可にします。例 `var azure = require('azure-storage'); var queueService = azure.createQueueService(); var queueName = 'taskqueue'; queueService.getMessage(queueName, function(error, serverMessage) { if(!error) { // Process the message in less than 30 seconds, the message // text is available in serverMessage.messagetext queueService.deleteMessage(queueName, serverMessage.messageId, serverMessage.popReceipt, function(error) { if(!error){ // Message deleted } }); } });`
getMessages(string, ErrorOrResult<QueueMessageResult[]>)	キューからメッセージを取得し、他のコンシューマーからメッセージを非表示にします。例 `var azure = require('azure-storage'); var queueService = azure.createQueueService(); var queueName = 'taskqueue'; queueService.getMessages(queueName, function(error, serverMessages) { if(!error) { // Process the message in less than 30 seconds, the message // text is available in serverMessages[0].messagetext queueService.deleteMessage(queueName, serverMessages[0].messageId, serverMessages[0].popReceipt, function(error) { if(!error){ // Message deleted } }); } });`
getMessages(string, GetMessagesRequestOptions, ErrorOrResult<QueueMessageResult[]>)	キューからメッセージを取得し、他のコンシューマーからメッセージを非表示にします。例 `var azure = require('azure-storage'); var queueService = azure.createQueueService(); var queueName = 'taskqueue'; queueService.getMessages(queueName, function(error, serverMessages) { if(!error) { // Process the message in less than 30 seconds, the message // text is available in serverMessages[0].messagetext queueService.deleteMessage(queueName, serverMessages[0].messageId, serverMessages[0].popReceipt, function(error) { if(!error){ // Message deleted } }); } });`
getQueueAcl(string, ErrorOrResult<QueueResult>)	キューの ACL を取得します。
getQueueAcl(string, RequestOptions, ErrorOrResult<QueueResult>)	キューの ACL を取得します。
getQueueMetadata(string, ErrorOrResult<QueueResult>)	ユーザー定義のメタデータを含むキューのプロパティを返します。
getQueueMetadata(string, RequestOptions, ErrorOrResult<QueueResult>)	ユーザー定義のメタデータを含むキューのプロパティを返します。
getServiceProperties(ErrorOrResult<ServiceProperties>)	Microsoft Azure Storage Analytics を含むストレージアカウントの Queue サービスのプロパティを取得します。
getServiceProperties(RequestOptions, ErrorOrResult<ServiceProperties>)	Microsoft Azure Storage Analytics を含むストレージアカウントの Queue サービスのプロパティを取得します。
getServiceStats(ErrorOrResult<ServiceStats>)	ストレージアカウントの Queue サービスのサービス統計を取得します。
getServiceStats(RequestOptions, ErrorOrResult<ServiceStats>)	ストレージアカウントの Queue サービスのサービス統計を取得します。
getUrl(string, string, boolean)
listQueuesSegmented(ContinuationToken, ErrorOrResult<ListQueueResult>)	指定されたアカウントの指定したプレフィックスで始まる名前を持つキュー項目のコレクションを含むセグメントを一覧表示します。
listQueuesSegmented(ContinuationToken, ListQueuesRequestOptions, ErrorOrResult<ListQueueResult>)	指定されたアカウントの指定したプレフィックスで始まる名前を持つキュー項目のコレクションを含むセグメントを一覧表示します。
listQueuesSegmentedWithPrefix(string, ContinuationToken, ErrorOrResult<ListQueueResult>)	指定されたアカウントのキュー項目のコレクションを含むセグメントを一覧表示します。
listQueuesSegmentedWithPrefix(string, ContinuationToken, ListQueuesRequestOptions, ErrorOrResult<ListQueueResult>)	指定されたアカウントのキュー項目のコレクションを含むセグメントを一覧表示します。
peekMessage(string, ErrorOrResult<QueueMessageResult>)	メッセージの可視性は変更せずに、キューの先頭からメッセージを取得します。
peekMessage(string, RequestOptions, ErrorOrResult<QueueMessageResult>)	メッセージの可視性は変更せずに、キューの先頭からメッセージを取得します。
peekMessages(string, ErrorOrResult<QueueMessageResult[]>)	メッセージの可視性を変更せずに、キューの先頭からメッセージを取得します。
peekMessages(string, PeekMessagesRequestOptions, ErrorOrResult<QueueMessageResult[]>)	メッセージの可視性を変更せずに、キューの先頭からメッセージを取得します。
setQueueAcl(string, {[key: string]: common.AccessPolicy}, ErrorOrResult<QueueResult>)	キューの ACL を更新します。例 var azure = require('azure-storage'); var SharedAccessPermissions = azure.QueueUtilities.SharedAccessPermissions; var queueService = azure.createQueueService(); var sharedAccessPolicy = [ {AccessPolicy: { Permissions: PROCESS, Start: startDate, Expiry: expiryDate }, Id: processOnly, }, {AccessPolicy: { Permissions: SharedAccessPermissions.PROCESS + SharedAccessPermissions.DELETE, Start: startDate, Expiry: expiryDate }, Id: processAndDelete, }]; queueService.setQueueAcl(queueName, sharedAccessPolicy, function(error, queueResult, response) { // do whatever });
setQueueAcl(string, {[key: string]: common.AccessPolicy}, RequestOptions, ErrorOrResult<QueueResult>)	キューの ACL を更新します。例 var azure = require('azure-storage'); var SharedAccessPermissions = azure.QueueUtilities.SharedAccessPermissions; var queueService = azure.createQueueService(); var sharedAccessPolicy = [ {AccessPolicy: { Permissions: PROCESS, Start: startDate, Expiry: expiryDate }, Id: processOnly, }, {AccessPolicy: { Permissions: SharedAccessPermissions.PROCESS + SharedAccessPermissions.DELETE, Start: startDate, Expiry: expiryDate }, Id: processAndDelete, }]; queueService.setQueueAcl(queueName, sharedAccessPolicy, function(error, queueResult, response) { // do whatever });
setQueueMetadata(string, {[key: string]: string}, ErrorOrResult<QueueResult>)	指定したキューにユーザー定義メタデータを設定します。メタデータは、名前と値のペアとしてキューに関連付けられます。
setQueueMetadata(string, {[key: string]: string}, RequestOptions, ErrorOrResult<QueueResult>)	指定したキューにユーザー定義メタデータを設定します。メタデータは、名前と値のペアとしてキューに関連付けられます。
setServiceProperties(ServiceProperties, ErrorOrResponse)	Microsoft Azure Storage Analytics を含むストレージアカウントの Queue サービスのプロパティを設定します。また、この操作を使用して、バージョンが指定されていないすべての受信要求用の既定の要求バージョンも設定できます。
setServiceProperties(ServiceProperties, RequestOptions, ErrorOrResponse)	Microsoft Azure Storage Analytics を含むストレージアカウントの Queue サービスのプロパティを設定します。また、この操作を使用して、バージョンが指定されていないすべての受信要求用の既定の要求バージョンも設定できます。
updateMessage(string, string, string, number, ErrorOrResult<QueueMessageResult>)	メッセージの表示タイムアウトを更新します。この操作を使用して、メッセージの内容を更新することもできます。メッセージは、UTF-8 エンコーディングされた XML 要求に含めることのできる形式である必要があります。エンコーディングされたメッセージの最大サイズは 64 KB です。
updateMessage(string, string, string, number, UpdateMessageRequestOptions, ErrorOrResult<QueueMessageResult>)	メッセージの表示タイムアウトを更新します。この操作を使用して、メッセージの内容を更新することもできます。メッセージは、UTF-8 エンコーディングされた XML 要求に含めることのできる形式である必要があります。エンコーディングされたメッセージの最大サイズは 64 KB です。
withFilter(IFilter)	フィルター処理操作をこの QueueService に関連付けます。フィルター処理の操作には、ログ記録、自動再試行などが含まれます。フィルター操作は、シグネチャを持つメソッドを実装するオブジェクトです。 `"function handle (requestOptions, next)".` 要求オプションに対して前処理を行った後、メソッドは"next" を呼び出し、シグネチャを使用してコールバックを渡す必要があります。 `"function (returnObject, finalCallback, next)"` このコールバックで、returnObject (サーバーへの要求からの応答) の処理の後に、コールバックは next を呼び出すか (他のフィルターの処理を続けるために next が存在する場合)、単に finalCallback を呼び出す必要があります (サービス呼び出しを終了する場合)。

継承されたメソッド

addListener(string, Function)
emit(string, any[])
listenerCount(EventEmitter, string)
listeners(string)
on(string, Function)
once(string, Function)
removeAllListeners(string)
removeListener(string, Function)
setMaxListeners(number)
setProxy(Proxy)	呼び出し元によって指定されたプロキシオブジェクトを設定します。

コンストラクターの詳細

QueueService(string, string, string | StorageHost, string, string)

新しい QueueService オブジェクトを作成します。

QueueService クラスは、Microsoft Azure Queue Service に対して操作を実行するために使用されます。

new QueueService(storageAccountOrConnectionString?: string, storageAccessKey?: string, host?: string | StorageHost, sasToken?: string, endpointSuffix?: string)

パラメーター

storageAccountOrConnectionString: string

ストレージアカウントまたは接続文字列。

storageAccessKey: string

ストレージアクセスキー。

host: string | azure-storage.export=.StorageHost

ホストアドレス。プライマリのみを定義するには、文字列を渡します。それ以外の場合、'host.primaryHost' はプライマリホストを定義し、'host.secondaryHost' はセカンダリホストを定義します。

sasToken: string

Shared Access Signature トークン。

endpointSuffix: string

エンドポイントサフィックス。

プロパティの詳細

messageEncoder

messageEncoder: QueueMessageEncoder

プロパティ値

azure-storage.export=.services.queue.QueueMessageEncoder

継承されたプロパティの詳細

defaultClientRequestTimeoutInMs

要求に使用するクライアント要求の既定のタイムアウト (ミリ秒単位)。

defaultClientRequestTimeoutInMs: number

プロパティ値

number

StorageServiceClient.defaultClientRequestTimeoutInMsから継承

defaultLocationMode

サービスを介して行われた要求の既定の場所モード。

defaultLocationMode: LocationMode

プロパティ値

azure-storage.export=.common.util.storageutilities.LocationMode

StorageServiceClient.defaultLocationModeから継承

defaultMaximumExecutionTimeInMs

サービス経由で行われた要求に対するすべての再試行の既定の最大実行時間。

defaultMaximumExecutionTimeInMs: number

プロパティ値

number

StorageServiceClient.defaultMaximumExecutionTimeInMsから継承

defaultTimeoutIntervalInMs

サービス経由で行われた要求に使用する既定のタイムアウト間隔 (ミリ秒単位)。

defaultTimeoutIntervalInMs: number

プロパティ値

number

StorageServiceClient.defaultTimeoutIntervalInMsから継承

enableGlobalHttpAgent

グローバル HTTP エージェントが有効かどうかを判断します。グローバル HTTP エージェントを使用する場合は true。それ以外の場合は、http を使用する場合は false。Agent({keepAlive:true})。

enableGlobalHttpAgent: boolean

プロパティ値

boolean

StorageServiceClient.enableGlobalHttpAgentから継承

logger

ログ設定オブジェクト。

logger: Logger

プロパティ値

azure-storage.export=.common.diagnostics.logger.Logger

StorageServiceClient.loggerから継承

proxy

呼び出し元によって指定されたプロキシオブジェクト。

proxy: Proxy

プロパティ値

azure-storage.export=.common.services.storageserviceclient.Proxy

StorageServiceClient.proxyから継承

useNagleAlgorithm

キューサービスを介して行われた要求に Nagle アルゴリズムを使用するかどうかを決定します。Nagle アルゴリズムを使用する場合は true。それ以外の場合は false。既定値は false です。

useNagleAlgorithm: boolean

プロパティ値

boolean

StorageServiceClient.useNagleAlgorithmから継承

メソッドの詳細

clearMessages(string, ErrorOrResponse)

すべてのメッセージをキューからクリアします。

function clearMessages(queue: string, callback: ErrorOrResponse)

パラメーター

queue: string

キュー名。

callback: azure-storage.export=.ErrorOrResponse

error には、エラーが発生した場合に情報が含まれます。それ以外の場合 response は、この操作に関連する情報が含まれます。

clearMessages(string, RequestOptions, ErrorOrResponse)

すべてのメッセージをキューからクリアします。

function clearMessages(queue: string, options?: RequestOptions, callback: ErrorOrResponse)

パラメーター

queue: string

キュー名。

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResponse

error には、エラーが発生した場合に情報が含まれます。それ以外の場合 response は、この操作に関連する情報が含まれます。

createMessage(string, string | Buffer, CreateMessageRequestOptions, ErrorOrResult<QueueMessageResult>)

メッセージキューの背面に新しいメッセージを追加します。エンコードされたメッセージの最大サイズは、バージョン 2011-08-18 以降では 64 KB、これより前のバージョンでは 8 KB です。エンコードされていないメッセージは、UTF-8 エンコードを使用して XML 要求に含めることができる形式である必要があります。キューメッセージは既定でエンコードされます。エンコードの既定値を設定するには、「queueService.messageEncoder」を参照してください。

例

var azure = require('azure-storage');
var queueService = azure.createQueueService();
queueService.createMessage('taskqueue', 'Hello world!', function(error) {
  if(!error) {
    // Message inserted
  }
});

function createMessage(queue: string, messageText: string | Buffer, options?: CreateMessageRequestOptions, callback?: ErrorOrResult<QueueMessageResult>)

パラメーター

queue: string

キュー名。

messageText: string | Buffer

メッセージテキスト。

options: azure-storage.export=.services.queue.QueueService.CreateMessageRequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueMessageResult>

error には、エラーが発生した場合に情報が含まれます。それ以外の場合 [result](xref:azure-storage.export=.services.queue.QueueService.QueueMessageResult) は、メッセージが含まれます。 response には、この操作に関連する情報が含まれます。

createMessage(string, string | Buffer, ErrorOrResult<QueueMessageResult>)

例

var azure = require('azure-storage');
var queueService = azure.createQueueService();
queueService.createMessage('taskqueue', 'Hello world!', function(error) {
  if(!error) {
    // Message inserted
  }
});

function createMessage(queue: string, messageText: string | Buffer, callback?: ErrorOrResult<QueueMessageResult>)

パラメーター

queue: string

キュー名。

messageText: string | Buffer

メッセージテキスト。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueMessageResult>

error には、エラーが発生した場合に情報が含まれます。それ以外の場合 response は、この操作に関連する情報が含まれます。

createQueue(string, CreateQueueRequestOptions, ErrorOrResult<QueueResult>)

指定したアカウントの下位に新しいキューを作成します。

function createQueue(queue: string, optionsOrCallback: CreateQueueRequestOptions, callback?: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

optionsOrCallback: azure-storage.export=.services.queue.QueueService.CreateQueueRequestOptions

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

error には、エラーが発生した場合に情報が含まれます。それ以外の場合 result は、キュー情報が含まれます。 response には、この操作に関連する情報が含まれます。

createQueue(string, ErrorOrResult<QueueResult>)

指定したアカウントの下位に新しいキューを作成します。

function createQueue(queue: string, callback?: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

createQueueIfNotExists(string, CreateQueueRequestOptions, ErrorOrResult<QueueResult>)

指定されたアカウントの下に新しいキューが存在しない場合は作成します。

例

var azure = require('azure-storage');
var queueService = azure.createQueueService();
queueService.createQueueIfNotExists('taskqueue', function(error) {
  if(!error) {
    // Queue created or exists
  }
});

function createQueueIfNotExists(queue: string, optionsOrCallback: CreateQueueRequestOptions, callback?: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

optionsOrCallback: azure-storage.export=.services.queue.QueueService.CreateQueueRequestOptions

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

error には、エラーが発生した場合に情報が含まれます。それ以外の場合 result 、キューがこの操作によって作成された場合は true、そうでない場合は false になり、 response この操作に関連する情報が含まれます。

createQueueIfNotExists(string, ErrorOrResult<QueueResult>)

指定されたアカウントの下に新しいキューが存在しない場合は作成します。

例

var azure = require('azure-storage');
var queueService = azure.createQueueService();
queueService.createQueueIfNotExists('taskqueue', function(error) {
  if(!error) {
    // Queue created or exists
  }
});

function createQueueIfNotExists(queue: string, callback?: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

deleteMessage(string, string, string, ErrorOrResponse)

指定したメッセージをキューから削除します。

function deleteMessage(queue: string, messageId: string, popReceipt: string, callback: ErrorOrResponse)

パラメーター

queue: string

キュー名。

messageId: string

削除するメッセージのメッセージ識別子。

popReceipt: string

メッセージの取得またはメッセージの更新操作の以前の呼び出しから返される有効なポップレシート値

callback: azure-storage.export=.ErrorOrResponse

error には、エラーが発生した場合に情報が含まれます。 response には、この操作に関連する情報が含まれます。

deleteMessage(string, string, string, RequestOptions, ErrorOrResponse)

指定したメッセージをキューから削除します。

function deleteMessage(queue: string, messageId: string, popReceipt: string, options?: RequestOptions, callback: ErrorOrResponse)

パラメーター

queue: string

キュー名。

messageId: string

削除するメッセージのメッセージ識別子。

popReceipt: string

メッセージの取得またはメッセージの更新操作の以前の呼び出しから返される有効なポップレシート値

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResponse

error には、エラーが発生した場合に情報が含まれます。 response には、この操作に関連する情報が含まれます。

deleteQueue(string, ErrorOrResponse)

指定したキューを完全に削除します。

function deleteQueue(queue: string, callback: ErrorOrResponse)

パラメーター

queue: string

キュー名。

callback: azure-storage.export=.ErrorOrResponse

error には、エラーが発生した場合に情報が含まれます。 response には、この操作に関連する情報が含まれます。

deleteQueue(string, RequestOptions, ErrorOrResponse)

指定したキューを完全に削除します。

function deleteQueue(queue: string, options?: RequestOptions, callback: ErrorOrResponse)

パラメーター

queue: string

キュー名。

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResponse

error には、エラーが発生した場合に情報が含まれます。 response には、この操作に関連する情報が含まれます。

deleteQueueIfExists(string, ErrorOrResult<boolean>)

指定したキューが存在する場合は、完全に削除します。

function deleteQueueIfExists(queue: string, callback: ErrorOrResult<boolean>)

パラメーター

queue: string

キュー名。

callback: azure-storage.export=.ErrorOrResult<boolean>

error には、エラーが発生した場合に情報が含まれます。それ以外の場合 result 、キューが削除された場合は 'true' が含まれ、キューが存在しない場合は 'false' が含まれます。 response には、この操作に関連する情報が含まれます。

deleteQueueIfExists(string, RequestOptions, ErrorOrResult<boolean>)

指定したキューが存在する場合は、完全に削除します。

function deleteQueueIfExists(queue: string, options?: RequestOptions, callback: ErrorOrResult<boolean>)

パラメーター

queue: string

キュー名。

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<boolean>

doesQueueExist(string, ErrorOrResult<QueueResult>)

キューが存在するかどうかを確認します。

function doesQueueExist(queue: string, callback?: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

error には、エラーが発生した場合に情報が含まれます。それ以外の場合、 result キューが存在する場合は true、存在しない場合は false になり、 response この操作に関連する情報が含まれます。

doesQueueExist(string, RequestOptions, ErrorOrResult<QueueResult>)

キューが存在するかどうかを確認します。

function doesQueueExist(queue: string, options?: RequestOptions, callback?: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

generateSharedAccessSignature(string, SharedAccessPolicy)

共有アクセス署名トークンを取得します。

function generateSharedAccessSignature(queue: string, sharedAccessPolicy: SharedAccessPolicy): string

パラメーター

queue: string

キュー名。

sharedAccessPolicy: azure-storage.export=.common.SharedAccessPolicy

共有アクセスポリシー。

戻り値

string

Shared Access Signature クエリ文字列。この文字列には先頭の "?" が含まれていないことに注意してください。

generateSharedAccessSignatureWithVersion(string, SharedAccessPolicy, string)

共有アクセス署名トークンを取得します。

function generateSharedAccessSignatureWithVersion(queue: string, sharedAccessPolicy: SharedAccessPolicy, sasVersion?: string): string

パラメーター

queue: string

キュー名。

sharedAccessPolicy: azure-storage.export=.common.SharedAccessPolicy

共有アクセスポリシー。

sasVersion: string

使用する SAS バージョンを示す省略可能な文字列。値は 2012-02-12 以降である必要があります。

戻り値

string

Shared Access Signature クエリ文字列。この文字列には先頭の "?" が含まれていないことに注意してください。

getMessage(string, ErrorOrResult<QueueMessageResult>)

キューからメッセージを取得し、コンシューマーから参照不可にします。

例

var azure = require('azure-storage');
var queueService = azure.createQueueService();
var queueName = 'taskqueue';
queueService.getMessage(queueName, function(error, serverMessages) {
  if(!error) {
    // Process the message in less than 30 seconds, the message
    // text is available in serverMessages.messagetext
    queueService.deleteMessage(queueName, serverMessages.messageId, serverMessages.popReceipt, function(error) {
      if(!error){
          // Message deleted
      }
    });
  }
});

function getMessage(queue: string, callback?: ErrorOrResult<QueueMessageResult>)

パラメーター

queue: string

キュー名。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueMessageResult>

error には、エラーが発生した場合に情報が含まれます。それ以外の場合 result は、メッセージが含まれます。 response には、この操作に関連する情報が含まれます。

getMessage(string, GetMessageRequestOptions, ErrorOrResult<QueueMessageResult>)

キューからメッセージを取得し、コンシューマーから参照不可にします。

例

var azure = require('azure-storage');
var queueService = azure.createQueueService();
var queueName = 'taskqueue';
queueService.getMessage(queueName, function(error, serverMessage) {
  if(!error) {
    // Process the message in less than 30 seconds, the message
    // text is available in serverMessage.messagetext
    queueService.deleteMessage(queueName, serverMessage.messageId, serverMessage.popReceipt, function(error) {
      if(!error){
          // Message deleted
      }
    });
  }
});

function getMessage(queue: string, options?: GetMessageRequestOptions, callback?: ErrorOrResult<QueueMessageResult>)

パラメーター

queue: string

キュー名。

options: azure-storage.export=.services.queue.QueueService.GetMessageRequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueMessageResult>

getMessages(string, ErrorOrResult<QueueMessageResult[]>)

キューからメッセージを取得し、他のコンシューマーからメッセージを非表示にします。

例

var azure = require('azure-storage');
var queueService = azure.createQueueService();
var queueName = 'taskqueue';
queueService.getMessages(queueName, function(error, serverMessages) {
  if(!error) {
    // Process the message in less than 30 seconds, the message
    // text is available in serverMessages[0].messagetext
    queueService.deleteMessage(queueName, serverMessages[0].messageId, serverMessages[0].popReceipt, function(error) {
      if(!error){
          // Message deleted
      }
    });
  }
});

function getMessages(queue: string, callback?: ErrorOrResult<QueueMessageResult[]>)

パラメーター

queue: string

キュー名。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueMessageResult[]>

getMessages(string, GetMessagesRequestOptions, ErrorOrResult<QueueMessageResult[]>)

キューからメッセージを取得し、他のコンシューマーからメッセージを非表示にします。

例

var azure = require('azure-storage');
var queueService = azure.createQueueService();
var queueName = 'taskqueue';
queueService.getMessages(queueName, function(error, serverMessages) {
  if(!error) {
    // Process the message in less than 30 seconds, the message
    // text is available in serverMessages[0].messagetext
    queueService.deleteMessage(queueName, serverMessages[0].messageId, serverMessages[0].popReceipt, function(error) {
      if(!error){
          // Message deleted
      }
    });
  }
});

function getMessages(queue: string, options?: GetMessagesRequestOptions, callback?: ErrorOrResult<QueueMessageResult[]>)

パラメーター

queue: string

キュー名。

options: azure-storage.export=.services.queue.QueueService.GetMessagesRequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueMessageResult[]>

getQueueAcl(string, ErrorOrResult<QueueResult>)

キューの ACL を取得します。

function getQueueAcl(queue: string, callback: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

error には、エラーが発生した場合に情報が含まれます。それ以外の場合 result は、キューの情報が含まれます。 response には、この操作に関連する情報が含まれます。

getQueueAcl(string, RequestOptions, ErrorOrResult<QueueResult>)

キューの ACL を取得します。

function getQueueAcl(queue: string, options?: RequestOptions, callback: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

getQueueMetadata(string, ErrorOrResult<QueueResult>)

ユーザー定義のメタデータを含むキューのプロパティを返します。

function getQueueMetadata(queue: string, callback: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

getQueueMetadata(string, RequestOptions, ErrorOrResult<QueueResult>)

ユーザー定義のメタデータを含むキューのプロパティを返します。

function getQueueMetadata(queue: string, options?: RequestOptions, callback: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

getServiceProperties(ErrorOrResult<ServiceProperties>)

Microsoft Azure Storage Analytics を含むストレージアカウントの Queue サービスのプロパティを取得します。

function getServiceProperties(callback?: ErrorOrResult<ServiceProperties>)

パラメーター

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.common.models.ServicePropertiesResult.ServiceProperties>

error には、エラーが発生した場合に情報が含まれます。それ以外の場合、 errorOrResult にはプロパティが含まれており、 response この操作に関連する情報が含まれます。

getServiceProperties(RequestOptions, ErrorOrResult<ServiceProperties>)

Microsoft Azure Storage Analytics を含むストレージアカウントの Queue サービスのプロパティを取得します。

function getServiceProperties(options?: RequestOptions, callback?: ErrorOrResult<ServiceProperties>)

パラメーター

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.common.models.ServicePropertiesResult.ServiceProperties>

getServiceStats(ErrorOrResult<ServiceStats>)

ストレージアカウントの Queue サービスのサービス統計を取得します。

function getServiceStats(callback: ErrorOrResult<ServiceStats>)

パラメーター

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.common.models.ServiceStats>

error には、エラーが発生した場合に情報が含まれます。それ以外の場合、 result には統計が含まれており、 response この操作に関連する情報が含まれます。

getServiceStats(RequestOptions, ErrorOrResult<ServiceStats>)

ストレージアカウントの Queue サービスのサービス統計を取得します。

function getServiceStats(options?: RequestOptions, callback: ErrorOrResult<ServiceStats>)

パラメーター

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.common.models.ServiceStats>

getUrl(string, string, boolean)

function getUrl(queue: string, sasToken?: string, primary?: boolean): string

パラメーター

queue: string

sasToken: string

primary: boolean

戻り値

string

listQueuesSegmented(ContinuationToken, ErrorOrResult<ListQueueResult>)

指定されたアカウントの指定したプレフィックスで始まる名前を持つキュー項目のコレクションを含むセグメントを一覧表示します。

function listQueuesSegmented(currentToken: ContinuationToken, callback: ErrorOrResult<ListQueueResult>)

パラメーター

currentToken: azure-storage.export=.common.ContinuationToken

前の一覧作成操作によって返された継続トークンです。これが最初の操作である場合は、'null' または 'undefined' を使用してください。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.ListQueueResult>

errorには、エラーが発生した場合に情報が含まれます。それ以外の場合resultは、とがcontinuationToken含まれますentries。 entries はキューのリストを提供し、 continuationToken は次のリスト操作に使用されます。 response には、この操作に関連する情報が含まれます。

listQueuesSegmented(ContinuationToken, ListQueuesRequestOptions, ErrorOrResult<ListQueueResult>)

指定されたアカウントの指定したプレフィックスで始まる名前を持つキュー項目のコレクションを含むセグメントを一覧表示します。

function listQueuesSegmented(currentToken: ContinuationToken, options?: ListQueuesRequestOptions, callback: ErrorOrResult<ListQueueResult>)

パラメーター

currentToken: azure-storage.export=.common.ContinuationToken

前の一覧作成操作によって返された継続トークンです。これが最初の操作である場合は、'null' または 'undefined' を使用してください。

options: azure-storage.export=.services.queue.QueueService.ListQueuesRequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.ListQueueResult>

listQueuesSegmentedWithPrefix(string, ContinuationToken, ErrorOrResult<ListQueueResult>)

指定されたアカウントのキュー項目のコレクションを含むセグメントを一覧表示します。

function listQueuesSegmentedWithPrefix(prefix: string, currentToken: ContinuationToken, callback: ErrorOrResult<ListQueueResult>)

パラメーター

prefix: string

キュー名のプレフィックス。

currentToken: azure-storage.export=.common.ContinuationToken

前の一覧作成操作によって返された継続トークンです。これが最初の操作である場合は、'null' または 'undefined' を使用してください。*

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.ListQueueResult>

listQueuesSegmentedWithPrefix(string, ContinuationToken, ListQueuesRequestOptions, ErrorOrResult<ListQueueResult>)

指定されたアカウントのキュー項目のコレクションを含むセグメントを一覧表示します。

function listQueuesSegmentedWithPrefix(prefix: string, currentToken: ContinuationToken, options?: ListQueuesRequestOptions, callback: ErrorOrResult<ListQueueResult>)

パラメーター

prefix: string

キュー名のプレフィックス。

currentToken: azure-storage.export=.common.ContinuationToken

前の一覧作成操作によって返された継続トークンです。これが最初の操作である場合は、'null' または 'undefined' を使用してください。*

options: azure-storage.export=.services.queue.QueueService.ListQueuesRequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.ListQueueResult>

peekMessage(string, ErrorOrResult<QueueMessageResult>)

メッセージの可視性は変更せずに、キューの先頭からメッセージを取得します。

function peekMessage(queue: string, callback?: ErrorOrResult<QueueMessageResult>)

パラメーター

queue: string

キュー名。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueMessageResult>

peekMessage(string, RequestOptions, ErrorOrResult<QueueMessageResult>)

メッセージの可視性は変更せずに、キューの先頭からメッセージを取得します。

function peekMessage(queue: string, options?: RequestOptions, callback?: ErrorOrResult<QueueMessageResult>)

パラメーター

queue: string

キュー名。

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueMessageResult>

peekMessages(string, ErrorOrResult<QueueMessageResult[]>)

メッセージの可視性を変更せずに、キューの先頭からメッセージを取得します。

function peekMessages(queue: string, callback?: ErrorOrResult<QueueMessageResult[]>)

パラメーター

queue: string

キュー名。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueMessageResult[]>

peekMessages(string, PeekMessagesRequestOptions, ErrorOrResult<QueueMessageResult[]>)

メッセージの可視性を変更せずに、キューの先頭からメッセージを取得します。

function peekMessages(queue: string, options?: PeekMessagesRequestOptions, callback?: ErrorOrResult<QueueMessageResult[]>)

パラメーター

queue: string

キュー名。

options: azure-storage.export=.services.queue.QueueService.PeekMessagesRequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueMessageResult[]>

setQueueAcl(string, {[key: string]: common.AccessPolicy}, ErrorOrResult<QueueResult>)

キューの ACL を更新します。

例

var azure = require('azure-storage');
var SharedAccessPermissions = azure.QueueUtilities.SharedAccessPermissions;
var queueService = azure.createQueueService();
var sharedAccessPolicy = [
{AccessPolicy: {
    Permissions: PROCESS,
    Start: startDate,
    Expiry: expiryDate
  },
  Id: processOnly,
},
{AccessPolicy: {
    Permissions: SharedAccessPermissions.PROCESS + SharedAccessPermissions.DELETE,
    Start: startDate,
    Expiry: expiryDate
  },
  Id: processAndDelete,
}];

queueService.setQueueAcl(queueName, sharedAccessPolicy, function(error, queueResult, response) {
    // do whatever
});

function setQueueAcl(queue: string, signedIdentifiers: {[key: string]: common.AccessPolicy}, callback?: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

signedIdentifiers: {[key: string]: azure-storage.export=.common.AccessPolicy}

署名付き識別子。符号付き識別子は配列内に存在する必要があります。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

setQueueAcl(string, {[key: string]: common.AccessPolicy}, RequestOptions, ErrorOrResult<QueueResult>)

キューの ACL を更新します。

例

var azure = require('azure-storage');
var SharedAccessPermissions = azure.QueueUtilities.SharedAccessPermissions;
var queueService = azure.createQueueService();
var sharedAccessPolicy = [
{AccessPolicy: {
    Permissions: PROCESS,
    Start: startDate,
    Expiry: expiryDate
  },
  Id: processOnly,
},
{AccessPolicy: {
    Permissions: SharedAccessPermissions.PROCESS + SharedAccessPermissions.DELETE,
    Start: startDate,
    Expiry: expiryDate
  },
  Id: processAndDelete,
}];

queueService.setQueueAcl(queueName, sharedAccessPolicy, function(error, queueResult, response) {
    // do whatever
});

function setQueueAcl(queue: string, signedIdentifiers: {[key: string]: common.AccessPolicy}, options?: RequestOptions, callback?: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

signedIdentifiers: {[key: string]: azure-storage.export=.common.AccessPolicy}

署名付き識別子。符号付き識別子は配列内に存在する必要があります。

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

setQueueMetadata(string, {[key: string]: string}, ErrorOrResult<QueueResult>)

指定したキューにユーザー定義メタデータを設定します。メタデータは、名前と値のペアとしてキューに関連付けられます。

function setQueueMetadata(queue: string, metadata: {[key: string]: string}, callback: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

metadata: {[key: string]: string}

メタデータキーと値のペア。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

setQueueMetadata(string, {[key: string]: string}, RequestOptions, ErrorOrResult<QueueResult>)

指定したキューにユーザー定義メタデータを設定します。メタデータは、名前と値のペアとしてキューに関連付けられます。

function setQueueMetadata(queue: string, metadata: {[key: string]: string}, options?: RequestOptions, callback: ErrorOrResult<QueueResult>)

パラメーター

queue: string

キュー名。

metadata: {[key: string]: string}

メタデータキーと値のペア。

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueResult>

setServiceProperties(ServiceProperties, ErrorOrResponse)

Microsoft Azure Storage Analytics を含むストレージアカウントの Queue サービスのプロパティを設定します。また、この操作を使用して、バージョンが指定されていないすべての受信要求用の既定の要求バージョンも設定できます。

function setServiceProperties(serviceProperties: ServiceProperties, callback?: ErrorOrResponse)

パラメーター

serviceProperties: azure-storage.export=.common.models.ServicePropertiesResult.ServiceProperties

サービスのプロパティ。

callback: azure-storage.export=.ErrorOrResponse

error には、エラーが発生した場合に情報が含まれます。それ以外の場合は、 response この操作に関連する情報が含まれます。

setServiceProperties(ServiceProperties, RequestOptions, ErrorOrResponse)

function setServiceProperties(serviceProperties: ServiceProperties, options?: RequestOptions, callback?: ErrorOrResponse)

パラメーター

serviceProperties: azure-storage.export=.common.models.ServicePropertiesResult.ServiceProperties

サービスのプロパティ。

options: azure-storage.export=.common.RequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResponse

error には、エラーが発生した場合に情報が含まれます。それ以外の場合は、 response この操作に関連する情報が含まれます。

updateMessage(string, string, string, number, ErrorOrResult<QueueMessageResult>)

メッセージの表示タイムアウトを更新します。この操作を使用して、メッセージの内容を更新することもできます。メッセージは、UTF-8 エンコーディングされた XML 要求に含めることのできる形式である必要があります。エンコーディングされたメッセージの最大サイズは 64 KB です。

function updateMessage(queue: string, messageId: string, popReceipt: string, visibilityTimeout: number, callback?: ErrorOrResult<QueueMessageResult>)

パラメーター

queue: string

キュー名。

messageId: string

更新するメッセージのメッセージ識別子。

popReceipt: string

メッセージの取得またはメッセージの更新操作の以前の呼び出しから返される有効なポップレシート値

visibilityTimeout: number

サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。新しい値は、0 以上の 7 日を超えない値である必要があります。メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueMessageResult>

error には、エラーが発生した場合に情報が含まれます。それ以外の場合 result は、メッセージの結果情報が含まれます。 response には、この操作に関連する情報が含まれます。

updateMessage(string, string, string, number, UpdateMessageRequestOptions, ErrorOrResult<QueueMessageResult>)

function updateMessage(queue: string, messageId: string, popReceipt: string, visibilityTimeout: number, options?: UpdateMessageRequestOptions, callback: ErrorOrResult<QueueMessageResult>)

パラメーター

queue: string

キュー名。

messageId: string

更新するメッセージのメッセージ識別子。

popReceipt: string

メッセージの取得またはメッセージの更新操作の以前の呼び出しから返される有効なポップレシート値

visibilityTimeout: number

options: azure-storage.export=.services.queue.QueueService.UpdateMessageRequestOptions

要求オプション。

callback: azure-storage.export=.ErrorOrResult<azure-storage.export=.services.queue.QueueService.QueueMessageResult>

withFilter(IFilter)

フィルター処理操作をこの QueueService に関連付けます。フィルター処理の操作には、ログ記録、自動再試行などが含まれます。フィルター操作は、シグネチャを持つメソッドを実装するオブジェクトです。

"function handle (requestOptions, next)".

要求オプションに対して前処理を行った後、メソッドは"next" を呼び出し、シグネチャを使用してコールバックを渡す必要があります。

"function (returnObject, finalCallback, next)"

このコールバックで、returnObject (サーバーへの要求からの応答) の処理の後に、コールバックは next を呼び出すか (他のフィルターの処理を続けるために next が存在する場合)、単に finalCallback を呼び出す必要があります (サービス呼び出しを終了する場合)。

function withFilter(newFilter: IFilter): QueueService

パラメーター

newFilter: azure-storage.export=.common.filters.IFilter

戻り値

azure-storage.export=.services.queue.QueueService

フィルターが適用された新しいサービスクライアント。

継承済みメソッドの詳細

addListener(string, Function)

function addListener(event: string, listener: Function): QueueService

パラメーター

event: string

listener: Function

戻り値

azure-storage.export=.services.queue.QueueService

StorageServiceClient.addListenerから継承

emit(string, any[])

function emit(event: string, args: any[]): boolean

パラメーター

event: string

args: any[]

戻り値

boolean

StorageServiceClient.emitから継承

listenerCount(EventEmitter, string)

static function listenerCount(emitter: EventEmitter, event: string): number

パラメーター

emitter: EventEmitter

event: string

戻り値

number

StorageServiceClient.listenerCountから継承

listeners(string)

function listeners(event: string): Function[]

パラメーター

event: string

戻り値

Function[]

StorageServiceClient.listenersから継承

on(string, Function)

function on(event: string, listener: Function): QueueService

パラメーター

event: string

listener: Function

戻り値

azure-storage.export=.services.queue.QueueService

StorageServiceClient.onから継承

once(string, Function)

function once(event: string, listener: Function): QueueService

パラメーター

event: string

listener: Function

戻り値

azure-storage.export=.services.queue.QueueService

StorageServiceClient.onceから継承

removeAllListeners(string)

function removeAllListeners(event?: string): QueueService

パラメーター

event: string

戻り値

azure-storage.export=.services.queue.QueueService

StorageServiceClient.removeAllListenersから継承

removeListener(string, Function)

function removeListener(event: string, listener: Function): QueueService

パラメーター

event: string

listener: Function

戻り値

azure-storage.export=.services.queue.QueueService

StorageServiceClient.removeListenerから継承

setMaxListeners(number)

function setMaxListeners(n: number)

パラメーター

n: number

StorageServiceClient.setMaxListenersから継承

setProxy(Proxy)

呼び出し元によって指定されたプロキシオブジェクトを設定します。

function setProxy(proxy: Proxy)

パラメーター

proxy: azure-storage.export=.common.services.storageserviceclient.Proxy

トンネリングに使用するプロキシ { host: hostname port: port number proxyAuth: 'user:password' for basic auth headers: {...} headers for proxy server key: key for proxy server ca: ca for proxy server cert: cert for proxy server } if null or undefined, clears proxy

StorageServiceClient.setProxyから継承

次の方法で共有

QueueService class

コンストラクター

プロパティ

継承されたプロパティ

メソッド

継承されたメソッド

コンストラクターの詳細

QueueService(string, string, string | StorageHost, string, string)

パラメーター

プロパティの詳細

messageEncoder

プロパティ値

継承されたプロパティの詳細

defaultClientRequestTimeoutInMs

プロパティ値

defaultLocationMode

プロパティ値

defaultMaximumExecutionTimeInMs

プロパティ値

defaultTimeoutIntervalInMs

プロパティ値

enableGlobalHttpAgent

プロパティ値

logger

プロパティ値

proxy

プロパティ値

useNagleAlgorithm

プロパティ値

メソッドの詳細

clearMessages(string, ErrorOrResponse)

パラメーター

clearMessages(string, RequestOptions, ErrorOrResponse)

パラメーター

createMessage(string, string | Buffer, CreateMessageRequestOptions, ErrorOrResult<QueueMessageResult>)

パラメーター

createMessage(string, string | Buffer, ErrorOrResult<QueueMessageResult>)

パラメーター

createQueue(string, CreateQueueRequestOptions, ErrorOrResult<QueueResult>)

パラメーター

createQueue(string, ErrorOrResult<QueueResult>)

パラメーター

createQueueIfNotExists(string, CreateQueueRequestOptions, ErrorOrResult<QueueResult>)

パラメーター

createQueueIfNotExists(string, ErrorOrResult<QueueResult>)

パラメーター

deleteMessage(string, string, string, ErrorOrResponse)

パラメーター

deleteMessage(string, string, string, RequestOptions, ErrorOrResponse)

パラメーター

deleteQueue(string, ErrorOrResponse)

パラメーター

deleteQueue(string, RequestOptions, ErrorOrResponse)

パラメーター

deleteQueueIfExists(string, ErrorOrResult<boolean>)

パラメーター

deleteQueueIfExists(string, RequestOptions, ErrorOrResult<boolean>)

パラメーター

doesQueueExist(string, ErrorOrResult<QueueResult>)

パラメーター

doesQueueExist(string, RequestOptions, ErrorOrResult<QueueResult>)

パラメーター

generateSharedAccessSignature(string, SharedAccessPolicy)

パラメーター

戻り値

generateSharedAccessSignatureWithVersion(string, SharedAccessPolicy, string)

パラメーター

戻り値

getMessage(string, ErrorOrResult<QueueMessageResult>)

パラメーター

getMessage(string, GetMessageRequestOptions, ErrorOrResult<QueueMessageResult>)

パラメーター

getMessages(string, ErrorOrResult<QueueMessageResult[]>)

パラメーター

getMessages(string, GetMessagesRequestOptions, ErrorOrResult<QueueMessageResult[]>)

パラメーター

getQueueAcl(string, ErrorOrResult<QueueResult>)

パラメーター

getQueueAcl(string, RequestOptions, ErrorOrResult<QueueResult>)