다음을 통해 공유


QueueClient class

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이면 false입니다.

참고: 다른 클라이언트 또는 애플리케이션에서 기존 큐를 삭제할 수 있기 때문에 이 함수를 주의해서 사용합니다. 그 반대로 이 함수가 완료된 후 다른 클라이언트 또는 애플리케이션에서 새 큐를 추가할 수 있습니다.

generateSasStringToSign(QueueGenerateSasUrlOptions)

공유 키 자격 증명을 사용하여 생성된 QueueClient에만 사용할 수 있습니다.

전달된 클라이언트 속성 및 매개 변수를 기반으로 SAS(서비스 공유 액세스 서명) URI에 서명하는 문자열을 생성합니다. SAS는 클라이언트의 공유 키 자격 증명으로 서명됩니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조

generateSasUrl(QueueGenerateSasUrlOptions)

공유 키 자격 증명을 사용하여 생성된 QueueClient에만 사용할 수 있습니다.

전달된 클라이언트 속성 및 매개 변수를 기반으로 SAS(서비스 공유 액세스 서명) URI를 생성합니다. SAS는 클라이언트의 공유 키 자격 증명으로 서명됩니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조

getAccessPolicy(QueueGetAccessPolicyOptions)

공유 액세스 서명과 함께 사용할 수 있는 큐에 지정된 저장된 액세스 정책에 대한 세부 정보를 가져옵니다.

경고: JavaScript 날짜는 시작 및 만료 문자열을 구문 분석할 때 전체 자릿수가 손실될 수 있습니다. 예를 들어 새 날짜("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 옵션을 사용하여 QueueServiceClientlistQueues 메서드에서 반환하는 메타데이터 키와 다릅니다.

peekMessages(QueuePeekMessagesOptions)

peekMessages는 큐 앞부분에서 하나 이상의 메시지를 검색하지만 메시지의 표시 유형을 변경하지는 않습니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages 참조

receiveMessages(QueueReceiveMessageOptions)

receiveMessages는 큐 앞에서 하나 이상의 메시지를 검색합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages 참조

sendMessage(string, QueueSendMessageOptions)

sendMessage는 큐의 뒷면에 새 메시지를 추가합니다. 표시 시간 제한은 큐에서 큐에 넣기 및 피킹(Peek) 작업에 메시지를 표시하지 않아야 하는 기간을 지정합니다. 메시지 콘텐츠의 크기는 최대 64KB이며 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)

지정된 큐에 대해 하나 이상의 사용자 정의 이름-값 쌍을 설정합니다.

옵션이 제공되지 않거나 옵션 매개 변수에 정의된 메타데이터가 없는 경우 큐 메타데이터가 제거됩니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata 참조

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

업데이트는 메시지의 표시 시간 제한 및 콘텐츠를 변경합니다. 메시지 콘텐츠의 크기는 최대 64KB이며 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

Azure Storage 큐를 가리키는 URL 문자열(예: "https://myaccount.queue.core.windows.net/myqueue") 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

Azure Storage 큐를 가리키는 URL 문자열(예: "https://myaccount.queue.core.windows.net/myqueue") AnonymousCredential을 사용하는 경우 SAS를 추가할 수 있습니다(예: "https://myaccount.queue.core.windows.net/myqueue?sasString").

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 Storage 계정의 계정 연결 문자열 또는 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

메시지 작업을 지우는 옵션입니다.

반환

메시지 지우기 작업에 대한 응답 데이터입니다.

create(QueueCreateOptions)

지정된 계정 아래에 새 큐를 만듭니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4 참조

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

매개 변수

options
QueueCreateOptions

큐 만들기 작업에 대한 옵션입니다.

반환

큐 만들기 작업에 대한 응답 데이터입니다.

사용 예:

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>

매개 변수

반환

delete(QueueDeleteOptions)

지정된 큐를 영구적으로 삭제합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3 참조

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

매개 변수

options
QueueDeleteOptions

큐 삭제 작업에 대한 옵션입니다.

반환

큐 삭제 작업에 대한 응답 데이터입니다.

사용 예:

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>

매개 변수

반환

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

메시지 작업을 삭제하는 옵션입니다.

반환

메시지 삭제 작업에 대한 응답 데이터입니다.

exists(QueueExistsOptions)

지정된 큐가 있으면 true를 반환합니다. false이면 false입니다.

참고: 다른 클라이언트 또는 애플리케이션에서 기존 큐를 삭제할 수 있기 때문에 이 함수를 주의해서 사용합니다. 그 반대로 이 함수가 완료된 후 다른 클라이언트 또는 애플리케이션에서 새 큐를 추가할 수 있습니다.

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

매개 변수

options
QueueExistsOptions

옵션에서 Exists 연산을 수행할 수 있습니다.

반환

Promise<boolean>

generateSasStringToSign(QueueGenerateSasUrlOptions)

공유 키 자격 증명을 사용하여 생성된 QueueClient에만 사용할 수 있습니다.

전달된 클라이언트 속성 및 매개 변수를 기반으로 SAS(서비스 공유 액세스 서명) URI에 서명하는 문자열을 생성합니다. SAS는 클라이언트의 공유 키 자격 증명으로 서명됩니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas 참조

function generateSasStringToSign(options: QueueGenerateSasUrlOptions): string

매개 변수

options
QueueGenerateSasUrlOptions

선택적 매개 변수입니다.

반환

string

이 클라이언트가 나타내는 리소스에 대한 URI로 구성된 SAS URI와 생성된 SAS 토큰이 뒤따릅니다.

generateSasUrl(QueueGenerateSasUrlOptions)

공유 키 자격 증명을 사용하여 생성된 QueueClient에만 사용할 수 있습니다.

전달된 클라이언트 속성 및 매개 변수를 기반으로 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 URI와 생성된 SAS 토큰이 뒤따릅니다.

getAccessPolicy(QueueGetAccessPolicyOptions)

공유 액세스 서명과 함께 사용할 수 있는 큐에 지정된 저장된 액세스 정책에 대한 세부 정보를 가져옵니다.

경고: JavaScript 날짜는 시작 및 만료 문자열을 구문 분석할 때 전체 자릿수가 손실될 수 있습니다. 예를 들어 새 날짜("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

큐에 대한 옵션 액세스 정책 가져오기 작업입니다.

반환

큐에 대한 응답 데이터는 액세스 정책 작업을 가져옵니다.

getProperties(QueueGetPropertiesOptions)

지정된 큐에 대한 모든 사용자 정의 메타데이터 및 시스템 속성을 가져옵니다. 메타데이터는 큐와 이름-값 쌍으로 연결됩니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata 참조

경고: 응답에서 반환된 metadata 개체에는 원래 대문자가 포함되어 있더라도 해당 키가 소문자로 표시됩니다. 이는 원래 대/소문자를 유지하는 includeMetadata 옵션을 사용하여 QueueServiceClientlistQueues 메서드에서 반환하는 메타데이터 키와 다릅니다.

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

매개 변수

options
QueueGetPropertiesOptions

큐에 대한 옵션은 속성 가져오기 작업입니다.

반환

큐 가져오기 속성 작업에 대한 응답 데이터입니다.

peekMessages(QueuePeekMessagesOptions)

peekMessages는 큐 앞부분에서 하나 이상의 메시지를 검색하지만 메시지의 표시 유형을 변경하지는 않습니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages 참조

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

매개 변수

options
QueuePeekMessagesOptions

메시지 피킹 작업을 위한 옵션입니다.

반환

메시지 피킹 작업에 대한 응답 데이터입니다.

사용 예:

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

receiveMessages(QueueReceiveMessageOptions)

receiveMessages는 큐 앞에서 하나 이상의 메시지를 검색합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages 참조

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

매개 변수

options
QueueReceiveMessageOptions

메시지 수신 작업 옵션입니다.

반환

메시지 수신 작업에 대한 응답 데이터입니다.

사용 예:

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는 큐의 뒷면에 새 메시지를 추가합니다. 표시 시간 제한은 큐에서 큐에 넣기 및 피킹(Peek) 작업에 메시지를 표시하지 않아야 하는 기간을 지정합니다. 메시지 콘텐츠의 크기는 최대 64KB이며 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

메시지 보내기 작업 옵션입니다.

반환

메시지 보내기 작업에 대한 응답 데이터입니다.

사용 예:

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

큐에 대한 옵션으로 액세스 정책 작업 설정

반환

큐 집합 액세스 정책 작업에 대한 응답 데이터입니다.

setMetadata(Metadata, QueueSetMetadataOptions)

지정된 큐에 대해 하나 이상의 사용자 정의 이름-값 쌍을 설정합니다.

옵션이 제공되지 않거나 옵션 매개 변수에 정의된 메타데이터가 없는 경우 큐 메타데이터가 제거됩니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata 참조

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

매개 변수

metadata
Metadata

메타데이터가 제공되지 않으면 기존 메타데이터가 모두 제거됩니다.

options
QueueSetMetadataOptions

큐에 대한 옵션은 메타데이터 설정 작업을 설정합니다.

반환

큐 집합 메타데이터 작업에 대한 응답 데이터입니다.

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

업데이트는 메시지의 표시 시간 제한 및 콘텐츠를 변경합니다. 메시지 콘텐츠의 크기는 최대 64KB이며 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

메시지 작업을 업데이트하는 옵션입니다.

반환

업데이트 메시지 작업에 대한 응답 데이터입니다.