QueueClient class

QueueClient의 인스턴스를 만듭니다.

new QueueClient(url: string, pipeline: Pipeline)

매개 변수

QueueClient의 인스턴스를 만듭니다.

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

매개 변수

QueueClient의 인스턴스를 만듭니다.

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

매개 변수

큐의 이름입니다.

string name

속성 값

accountName: string

속성 값

상속된 위치에서 StorageClient.accountName

URL 문자열 값입니다.

url: string

속성 값

상속된 위치에서 StorageClient.url

지우기 큐에서 모든 메시지를 삭제합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages를 참조하세요.

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

매개 변수

반환

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

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

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

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

매개 변수

반환

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

사용 예제:

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

지정된 계정 아래에 새 큐가 없는 경우 새로 만듭니다. 큐가 이미 있는 경우 변경되지 않습니다.

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

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

매개 변수

반환

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

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

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

매개 변수

반환

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

예제 사용법:

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

지정된 큐가 있는 경우 영구적으로 삭제합니다.

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

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

매개 변수

반환

deleteMessage는 지정된 메시지를 큐에서 영구적으로 제거합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2를 참조하세요.

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

매개 변수

반환

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

지정된 큐가 있으면 true를 반환합니다. false이면 이고, 그렇지 않으면 입니다.

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

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

매개 변수

반환

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

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

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

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

매개 변수

반환

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

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

경고: 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>

매개 변수

반환

큐 가져오기 액세스 정책 작업에 대한 응답 데이터입니다.

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

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

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

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

매개 변수

반환

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

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

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

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

매개 변수

반환

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

예제 사용법:

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

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

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

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

매개 변수

반환

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

사용 예제:

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

공유 액세스 서명에 사용할 수 있는 큐에 대한 저장된 액세스 정책을 설정합니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl를 참조하세요.

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

매개 변수

반환

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

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

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

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

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

매개 변수

반환

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

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

매개 변수

반환

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