QueueClient class

リファレンス

パッケージ:: @azure/storage-queue

QueueClient は、Azure Storage キューのメッセージへの URL を表し、メッセージを操作できます。

Extends: StorageClient

コンストラクター

QueueClient(string, Pipeline)	QueueClient のインスタンスを作成します。
QueueClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	QueueClient のインスタンスを作成します。
QueueClient(string, string, StoragePipelineOptions)	QueueClient のインスタンスを作成します。

プロパティ

name

キューの名前。

継承されたプロパティ

accountName
url	URL 文字列値。

メソッド

clearMessages(QueueClearMessagesOptions)	[クリア] を選択すると、キューからすべてのメッセージが削除されます。「https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages」を参照してください。
create(QueueCreateOptions)	指定したアカウントの下に新しいキューを作成します。「https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4」を参照してください。
createIfNotExists(QueueCreateOptions)	指定したアカウントの下に新しいキューがまだ存在しない場合は作成します。キューが既に存在する場合、変更されません。「https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4」を参照してください。
delete(QueueDeleteOptions)	指定したキューを完全に削除します。「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3」を参照してください。
deleteIfExists(QueueDeleteOptions)	指定したキューが存在する場合は完全に削除します。「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3」を参照してください。
deleteMessage(string, string, QueueDeleteMessageOptions)	deleteMessage は、指定されたメッセージをキューから完全に削除します。「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2」を参照してください。
exists(QueueExistsOptions)	指定したキューが存在する場合は true を返します。それ以外の場合は false。注: 既存のキューは他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。その逆も、この関数が完了した後に、他のクライアントまたはアプリケーションによって新しいキューが追加される場合があります。
generateSasUrl(QueueGenerateSasUrlOptions)	共有キー資格情報を使用して構築された QueueClient でのみ使用できます。渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。「https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas」を参照してください。
getAccessPolicy(QueueGetAccessPolicyOptions)	Shared Access Signature で使用できるキューで指定された格納されているアクセスポリシーの詳細を取得します。警告: JavaScript 日付は、開始文字列と有効期限文字列を解析するときに精度が失われる可能性があります。たとえば、新しい Date("2018-12-31T03:44:23.8827891Z").toISOString() は "2018-12-31T03:44:23.882Z" を取得します。「https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl」を参照してください。
getProperties(QueueGetPropertiesOptions)	指定したキューのすべてのユーザー定義メタデータとシステムプロパティを取得します。メタデータは、名前と値のペアとしてキューに関連付けられています。「https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata」を参照してください。警告: 応答で返されるオブジェクトのキーは `metadata` 、最初に大文字が含まれていた場合でも小文字になります。これは、オプションを使用`includeMetadata`して QueueServiceClient メソッドによって`listQueues`返されるメタデータキーとは異なり、元の大文字と小文字が保持されます。
peekMessages(QueuePeekMessagesOptions)	peekMessages はキューの先頭から 1 つ以上のメッセージを取得しますが、メッセージの可視性は変更しません。「https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages」を参照してください。
receiveMessages(QueueReceiveMessageOptions)	receiveMessages は、キューの先頭から 1 つ以上のメッセージを取得します。「https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages」を参照してください。
sendMessage(string, QueueSendMessageOptions)	sendMessage は、キューの背面に新しいメッセージを追加します。表示タイムアウトは、メッセージが Dequeue 操作と Peek 操作に対して非表示にする必要がある期間を指定します。メッセージの内容のサイズは最大 64 KB で、UTF-8 エンコードの XML 要求に含めることができる形式である必要があります。メッセージにマークアップを含めるには、メッセージのコンテンツが XML エスケープされているか、Base64 エンコードである必要があります。「https://docs.microsoft.com/en-us/rest/api/storageservices/put-message」を参照してください。
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)	共有アクセス署名で使用できるキューの保存されているアクセスポリシーを設定します。「https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl」を参照してください。
setMetadata(Metadata, QueueSetMetadataOptions)	指定したキューに対して 1 つ以上のユーザー定義の名前と値のペアを設定します。オプションが指定されていない場合、またはオプションパラメーターにメタデータが定義されていない場合は、キューメタデータが削除されます。「https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata」を参照してください。
updateMessage(string, string, string, number, QueueUpdateMessageOptions)	更新により、メッセージの可視性のタイムアウトと内容が変更されます。メッセージの内容のサイズは最大 64 KB で、UTF-8 エンコードの XML 要求に含めることができる形式である必要があります。メッセージにマークアップを含めるには、メッセージのコンテンツが XML エスケープされているか、Base64 エンコードである必要があります。「https://docs.microsoft.com/en-us/rest/api/storageservices/update-message」を参照してください。

コンストラクターの詳細

QueueClient(string, Pipeline)

QueueClient のインスタンスを作成します。

new QueueClient(url: string, pipeline: Pipeline)

パラメーター

url: string

"https://myaccount.queue.core.windows.net/myqueue" など、Azure Storage キューを指す URL 文字列。 AnonymousCredential を使用している場合は、SAS を追加できます (例: "https://myaccount.queue.core.windows.net/myqueue?sasString")。

pipeline: Pipeline

newPipeline() を呼び出して既定のパイプラインを作成するか、カスタマイズされたパイプラインを提供します。

QueueClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

QueueClient のインスタンスを作成します。

new QueueClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

パラメーター

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

AnonymousCredential、StorageSharedKeyCredential、またはサービスへの要求を @azure/identity 認証するためのパッケージからの資格情報など。 TokenCredential インターフェイスを実装するオブジェクトを指定することもできます。指定しない場合は、AnonymousCredential が使用されます。

options: StoragePipelineOptions

HTTP パイプラインを構成するためのオプション。

QueueClient(string, string, StoragePipelineOptions)

QueueClient のインスタンスを作成します。

new QueueClient(connectionString: string, queueName: string, options?: StoragePipelineOptions)

パラメーター

connectionString: string

Azure ストレージアカウントのアカウント接続文字列または SAS 接続文字列。 [ 注 - アカウント接続文字列は、NODE.JSランタイムでのみ使用できます。 ] アカウント接続文字列の例 -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS 接続文字列の例 - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

queueName: string

キュー名。

options: StoragePipelineOptions

HTTP パイプラインを構成するためのオプション。

プロパティの詳細

name

キューの名前。

string name

プロパティ値

string

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

accountName

accountName: string

プロパティ値

string

継承元 StorageClient.accountName

url

URL 文字列値。

url: string

プロパティ値

string

継承元 StorageClient.url

メソッドの詳細

clearMessages(QueueClearMessagesOptions)

[クリア] を選択すると、キューからすべてのメッセージが削除されます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages」を参照してください。

function clearMessages(options?: QueueClearMessagesOptions): Promise<MessagesClearResponse>

パラメーター

options: QueueClearMessagesOptions

メッセージ操作をクリアするオプション。

戻り値

Promise<MessagesClearResponse>

メッセージクリア操作の応答データ。

create(QueueCreateOptions)

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

「https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4」を参照してください。

function create(options?: QueueCreateOptions): Promise<QueueCreateResponse>

パラメーター

options: QueueCreateOptions

キュー作成操作のオプション。

戻り値

Promise<QueueCreateResponse>

キュー作成操作の応答データ。

使用例:

const queueClient = queueServiceClient.getQueueClient("<new queue name>");
const createQueueResponse = await queueClient.create();

createIfNotExists(QueueCreateOptions)

指定したアカウントの下に新しいキューがまだ存在しない場合は作成します。キューが既に存在する場合、変更されません。

「https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4」を参照してください。

function createIfNotExists(options?: QueueCreateOptions): Promise<QueueCreateIfNotExistsResponse>

パラメーター

options: QueueCreateOptions

戻り値

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

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

「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3」を参照してください。

function delete(options?: QueueDeleteOptions): Promise<QueueDeleteResponse>

パラメーター

options: QueueDeleteOptions

キュー削除操作のオプション。

戻り値

Promise<QueueDeleteResponse>

キュー削除操作の応答データ。

使用例:

const deleteQueueResponse = await queueClient.delete();
console.log(
  "Delete queue successfully, service assigned request Id:", deleteQueueResponse.requestId
);

deleteIfExists(QueueDeleteOptions)

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

「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3」を参照してください。

function deleteIfExists(options?: QueueDeleteOptions): Promise<QueueDeleteIfExistsResponse>

パラメーター

options: QueueDeleteOptions

戻り値

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage は、指定されたメッセージをキューから完全に削除します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2」を参照してください。

function deleteMessage(messageId: string, popReceipt: string, options?: QueueDeleteMessageOptions): Promise<MessageIdDeleteResponse>

パラメーター

messageId: string

メッセージの ID。

popReceipt: string

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

options: QueueDeleteMessageOptions

メッセージ操作を削除するオプション。

戻り値

Promise<MessageIdDeleteResponse>

メッセージ削除操作の応答データ。

exists(QueueExistsOptions)

指定したキューが存在する場合は true を返します。それ以外の場合は false。

注: 既存のキューは他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。その逆も、この関数が完了した後に、他のクライアントまたはアプリケーションによって新しいキューが追加される場合があります。

function exists(options?: QueueExistsOptions): Promise<boolean>

パラメーター

options: QueueExistsOptions

オプションを [Exists operation]\(存在する操作\) に設定します。

戻り値

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

共有キー資格情報を使用して構築された QueueClient でのみ使用できます。

渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas」を参照してください。

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

パラメーター

options: QueueGenerateSasUrlOptions

省略可能なパラメーター。

戻り値

string

このクライアントによって表されるリソースへの URI と、生成された SAS トークンで構成される SAS URI。

getAccessPolicy(QueueGetAccessPolicyOptions)

Shared Access Signature で使用できるキューで指定された格納されているアクセスポリシーの詳細を取得します。

警告: JavaScript 日付は、開始文字列と有効期限文字列を解析するときに精度が失われる可能性があります。たとえば、新しい Date("2018-12-31T03:44:23.8827891Z").toISOString() は "2018-12-31T03:44:23.882Z" を取得します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl」を参照してください。

function getAccessPolicy(options?: QueueGetAccessPolicyOptions): Promise<QueueGetAccessPolicyResponse>

パラメーター

options: QueueGetAccessPolicyOptions

アクセスポリシーの操作をキューに登録するオプション。

戻り値

Promise<QueueGetAccessPolicyResponse>

キュー取得アクセスポリシー操作の応答データ。

getProperties(QueueGetPropertiesOptions)

指定したキューのすべてのユーザー定義メタデータとシステムプロパティを取得します。メタデータは、名前と値のペアとしてキューに関連付けられています。

「https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata」を参照してください。

警告: 応答で返されるオブジェクトのキーは metadata 、最初に大文字が含まれていた場合でも小文字になります。これは、オプションを使用includeMetadataして QueueServiceClient メソッドによってlistQueues返されるメタデータキーとは異なり、元の大文字と小文字が保持されます。

function getProperties(options?: QueueGetPropertiesOptions): Promise<QueueGetPropertiesResponse>

パラメーター

options: QueueGetPropertiesOptions

Queue get プロパティ操作のオプション。

戻り値

Promise<QueueGetPropertiesResponse>

Queue get properties 操作の応答データ。

peekMessages(QueuePeekMessagesOptions)

peekMessages はキューの先頭から 1 つ以上のメッセージを取得しますが、メッセージの可視性は変更しません。

「https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages」を参照してください。

function peekMessages(options?: QueuePeekMessagesOptions): Promise<QueuePeekMessagesResponse>

パラメーター

options: QueuePeekMessagesOptions

メッセージ操作をピークするオプション。

戻り値

Promise<QueuePeekMessagesResponse>

ピークメッセージ操作の応答データ。

使用例:

const peekMessagesResponse = await queueClient.peekMessages();
console.log("The peeked message is:", peekMessagesResponse.peekedMessageItems[0].messageText);

receiveMessages(QueueReceiveMessageOptions)

receiveMessages は、キューの先頭から 1 つ以上のメッセージを取得します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages」を参照してください。

function receiveMessages(options?: QueueReceiveMessageOptions): Promise<QueueReceiveMessageResponse>

パラメーター

options: QueueReceiveMessageOptions

メッセージを受信する操作のオプション。

戻り値

Promise<QueueReceiveMessageResponse>

メッセージ受信操作の応答データ。

使用例:

const response = await queueClient.receiveMessages();
if (response.receivedMessageItems.length == 1) {
  const receivedMessageItem = response.receivedMessageItems[0];
  console.log("Processing & deleting message with content:", receivedMessageItem.messageText);
  const deleteMessageResponse = await queueClient.deleteMessage(
    receivedMessageItem.messageId,
    receivedMessageItem.popReceipt
  );
  console.log(
    "Delete message successfully, service assigned request Id:",
    deleteMessageResponse.requestId
  );
}

sendMessage(string, QueueSendMessageOptions)

sendMessage は、キューの背面に新しいメッセージを追加します。表示タイムアウトは、メッセージが Dequeue 操作と Peek 操作に対して非表示にする必要がある期間を指定します。メッセージの内容のサイズは最大 64 KB で、UTF-8 エンコードの XML 要求に含めることができる形式である必要があります。メッセージにマークアップを含めるには、メッセージのコンテンツが XML エスケープされているか、Base64 エンコードである必要があります。

「https://docs.microsoft.com/en-us/rest/api/storageservices/put-message」を参照してください。

function sendMessage(messageText: string, options?: QueueSendMessageOptions): Promise<QueueSendMessageResponse>

パラメーター

messageText: string

送信するメッセージのテキスト

options: QueueSendMessageOptions

メッセージの送信操作のオプション。

戻り値

Promise<QueueSendMessageResponse>

メッセージ送信操作の応答データ。

使用例:

const sendMessageResponse = await queueClient.sendMessage("Hello World!");
console.log(
  "Sent message successfully, service assigned message Id:", sendMessageResponse.messageId,
  "service assigned request Id:", sendMessageResponse.requestId
);

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

共有アクセス署名で使用できるキューの保存されているアクセスポリシーを設定します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl」を参照してください。

function setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions): Promise<QueueSetAccessPolicyResponse>

パラメーター

queueAcl: SignedIdentifier[]

options: QueueSetAccessPolicyOptions

[Queue set access policy operation]\(キューに設定されたアクセスポリシー操作\) のオプション。

戻り値

Promise<QueueSetAccessPolicyResponse>

キューセットアクセスポリシー操作の応答データ。

setMetadata(Metadata, QueueSetMetadataOptions)

指定したキューに対して 1 つ以上のユーザー定義の名前と値のペアを設定します。

オプションが指定されていない場合、またはオプションパラメーターにメタデータが定義されていない場合は、キューメタデータが削除されます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata」を参照してください。

function setMetadata(metadata?: Metadata, options?: QueueSetMetadataOptions): Promise<QueueSetMetadataResponse>

パラメーター

metadata: Metadata

メタデータが指定されていない場合は、既存のすべてのメタデータが削除されます。

options: QueueSetMetadataOptions

[Queue set metadata operation]\(キューセットメタデータ操作\) のオプション。

戻り値

Promise<QueueSetMetadataResponse>

Queue set メタデータ操作の応答データ。

updateMessage(string, string, string, number, QueueUpdateMessageOptions)

更新により、メッセージの可視性のタイムアウトと内容が変更されます。メッセージの内容のサイズは最大 64 KB で、UTF-8 エンコードの XML 要求に含めることができる形式である必要があります。メッセージにマークアップを含めるには、メッセージのコンテンツが XML エスケープされているか、Base64 エンコードである必要があります。

「https://docs.microsoft.com/en-us/rest/api/storageservices/update-message」を参照してください。

function updateMessage(messageId: string, popReceipt: string, message?: string, visibilityTimeout?: number, options?: QueueUpdateMessageOptions): Promise<MessageIdUpdateResponse>

パラメーター

messageId: string

メッセージの ID

popReceipt: string

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

message: string

更新するメッセージ。このパラメーターが未定義の場合、メッセージの内容は更新されません。

visibilityTimeout: number

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

options: QueueUpdateMessageOptions

メッセージ操作を更新するためのオプション。

戻り値

Promise<MessageIdUpdateResponse>

更新メッセージ操作の応答データ。

QueueClient class

コンストラクター

プロパティ

継承されたプロパティ

メソッド

コンストラクターの詳細

QueueClient(string, Pipeline)

パラメーター

QueueClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

パラメーター

QueueClient(string, string, StoragePipelineOptions)

パラメーター

プロパティの詳細

name

プロパティ値

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

accountName

プロパティ値

url

プロパティ値

メソッドの詳細

clearMessages(QueueClearMessagesOptions)

パラメーター

戻り値

create(QueueCreateOptions)

パラメーター

戻り値

createIfNotExists(QueueCreateOptions)

パラメーター

戻り値

delete(QueueDeleteOptions)

パラメーター

戻り値

deleteIfExists(QueueDeleteOptions)

パラメーター

戻り値

deleteMessage(string, string, QueueDeleteMessageOptions)

パラメーター

戻り値

exists(QueueExistsOptions)

パラメーター

戻り値

generateSasUrl(QueueGenerateSasUrlOptions)

パラメーター

戻り値

getAccessPolicy(QueueGetAccessPolicyOptions)

パラメーター

戻り値

getProperties(QueueGetPropertiesOptions)

パラメーター

戻り値

peekMessages(QueuePeekMessagesOptions)

パラメーター

戻り値

receiveMessages(QueueReceiveMessageOptions)

パラメーター

戻り値

sendMessage(string, QueueSendMessageOptions)

パラメーター

戻り値

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

パラメーター

戻り値

setMetadata(Metadata, QueueSetMetadataOptions)

パラメーター

戻り値

updateMessage(string, string, string, number, QueueUpdateMessageOptions)

パラメーター

戻り値

その他のリソース