QueueServiceClient class

  • 참조
패키지:
@azure/storage-queue

QueueServiceClient는 큐를 조작할 수 있는 Azure Storage 큐 서비스에 대한 URL을 나타냅니다.

Extends

StorageClient

생성자

QueueServiceClient(string, Pipeline)

QueueServiceClient의 인스턴스를 만듭니다.
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

상속된 속성

accountName
url

URL 문자열 값입니다.

메서드

createQueue(string, QueueCreateOptions)

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

https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4를 참조하세요.
deleteQueue(string, QueueDeleteOptions)

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

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3를 참조하세요.
fromConnectionString(string, StoragePipelineOptions)

QueueServiceClient의 인스턴스를 만듭니다.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

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

https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas를 참조하세요.
getProperties(ServiceGetPropertiesOptions)

스토리지 분석 및 CORS(원본 간 리소스 공유) 규칙에 대한 속성을 포함하여 스토리지 계정의 큐 서비스의 속성을 가져옵니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties를 참조하세요.
getQueueClient(string)

QueueClient 개체를 만듭니다.
getStatistics(ServiceGetStatisticsOptions)

큐 서비스에 대한 복제와 관련된 통계를 검색합니다. 이 작업은 저장소 계정에 대해 읽기 액세스 지리적 중복 복제가 설정되어 있는 경우 보조 위치 엔드포인트에서만 사용할 수 있습니다.

https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats를 참조하세요.
listQueues(ServiceListQueuesOptions)

지정된 계정 아래의 모든 큐를 나열하는 비동기 반복기를 반환합니다.

.byPage()는 비동기 반복 반복기를 반환하여 페이지에 큐를 나열합니다.

구문을 사용하는 for await 예제:

let i = 1;
for await (const item of queueServiceClient.listQueues()) {
  console.log(`Queue${i}: ${item.name}`);
  i++;
}

iter.next()을(를) 사용하는 예제:

let i = 1;
let iterator = queueServiceClient.listQueues();
let item = await iterator.next();
while (!item.done) {
  console.log(`Queue${i}: ${iterator.value.name}`);
  i++;
  item = await iterator.next();
}

byPage()을(를) 사용하는 예제:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const item2 of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
  if (item2.queueItems) {
    for (const queueItem of item2.queueItems) {
      console.log(`Queue${i}: ${queueItem.name}`);
      i++;
    }
  }
}

표식과 함께 페이징을 사용하는 예제:

let i = 1;
let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
let item = (await iterator.next()).value;

// Prints 2 queue names
if (item.queueItems) {
  for (const queueItem of item.queueItems) {
    console.log(`Queue${i}: ${queueItem.name}`);
    i++;
  }
}
// Gets next marker
let marker = item.continuationToken;

// Passing next marker as continuationToken
iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
item = (await iterator.next()).value;

// Prints 10 queue names
if (item.queueItems) {
  for (const queueItem of item.queueItems) {
    console.log(`Queue${i}: ${queueItem.name}`);
    i++;
  }
}
setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

스토리지 분석, CORS(원본 간 리소스 공유) 규칙 및 일시 삭제 설정에 대한 속성을 포함하여 스토리지 계정의 큐 서비스 엔드포인트에 대한 속성을 설정합니다.

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

생성자 세부 정보

QueueServiceClient(string, Pipeline)

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

new QueueServiceClient(url: string, pipeline: Pipeline)

매개 변수

url

string

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

pipeline
Pipeline

newPipeline()을 호출하여 기본 파이프라인을 만들거나 사용자 지정된 파이프라인을 제공합니다.

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

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

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

매개 변수

url

string

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

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

AnonymousCredential, StorageSharedKeyCredential 또는 패키지의 @azure/identity 자격 증명과 같이 서비스에 대한 요청을 인증합니다. TokenCredential 인터페이스를 구현하는 개체를 제공할 수도 있습니다. 지정하지 않으면 AnonymousCredential이 사용됩니다.

options
StoragePipelineOptions

HTTP 파이프라인을 구성하는 옵션입니다.

에서 @azure/identityDefaultAzureCredential을 사용하는 예제입니다.

const account = "<account>";

const credential = new DefaultAzureCredential();

const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  credential
}

계정 이름/키를 사용하는 예제:

const account = "<account>";

const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");

const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  sharedKeyCredential,
  {
    retryOptions: { maxTries: 4 }, // Retry options
    telemetry: { value: "BasicSample/V11.0.0" } // Customized telemetry string
  }
);

상속된 속성 세부 정보

accountName 

accountName: string

속성 값

string

상속된 위치에서 StorageClient.accountName

url

URL 문자열 값입니다.

url: string

속성 값

string

상속된 위치에서 StorageClient.url

메서드 세부 정보

createQueue(string, QueueCreateOptions)

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

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

function createQueue(queueName: string, options?: QueueCreateOptions): Promise<QueueCreateResponse>

매개 변수

queueName

string

만들 큐의 이름

options
QueueCreateOptions

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

반환

Promise<QueueCreateResponse>

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

deleteQueue(string, QueueDeleteOptions)

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

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

function deleteQueue(queueName: string, options?: QueueDeleteOptions): Promise<QueueDeleteResponse>

매개 변수

queueName

string

삭제할 큐의 이름입니다.

options
QueueDeleteOptions

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

반환

Promise<QueueDeleteResponse>

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

fromConnectionString(string, StoragePipelineOptions)

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

static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): QueueServiceClient

매개 변수

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

options
StoragePipelineOptions

HTTP 파이프라인을 구성하는 옵션입니다.

반환

QueueServiceClient

지정된 연결 문자열의 새 QueueServiceClient 개체입니다.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

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

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

function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

매개 변수

expiresOn

Date

(선택 사항) 공유 액세스 서명이 유효하지 않은 시간입니다. 지정하지 않으면 기본값은 1시간 후입니다.

permissions
AccountSASPermissions

SAS와 연결할 사용 권한 목록을 지정합니다.

resourceTypes

string

공유 액세스 서명과 연결된 리소스 유형을 지정합니다.

options
ServiceGenerateAccountSasUrlOptions

선택적 매개 변수입니다.

반환

string

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

getProperties(ServiceGetPropertiesOptions)

스토리지 분석 및 CORS(원본 간 리소스 공유) 규칙에 대한 속성을 포함하여 스토리지 계정의 큐 서비스의 속성을 가져옵니다.

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

function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

매개 변수

options
ServiceGetPropertiesOptions

속성 작업을 가져오는 옵션입니다.

반환

Promise<ServiceGetPropertiesResponse>

큐 서비스 속성을 포함한 응답 데이터입니다.

getQueueClient(string)

QueueClient 개체를 만듭니다.

function getQueueClient(queueName: string): QueueClient

매개 변수

queueName

string

반환

QueueClient

새 QueueClient

예제 사용법:

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

getStatistics(ServiceGetStatisticsOptions)

큐 서비스에 대한 복제와 관련된 통계를 검색합니다. 이 작업은 저장소 계정에 대해 읽기 액세스 지리적 중복 복제가 설정되어 있는 경우 보조 위치 엔드포인트에서만 사용할 수 있습니다.

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

function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>

매개 변수

options
ServiceGetStatisticsOptions

통계 작업을 가져오는 옵션입니다.

반환

Promise<ServiceGetStatisticsResponse>

작업 통계 가져오기에 대한 응답 데이터입니다.

listQueues(ServiceListQueuesOptions)

지정된 계정 아래의 모든 큐를 나열하는 비동기 반복기를 반환합니다.

.byPage()는 비동기 반복 반복기를 반환하여 페이지에 큐를 나열합니다.

구문을 사용하는 for await 예제:

let i = 1;
for await (const item of queueServiceClient.listQueues()) {
  console.log(`Queue${i}: ${item.name}`);
  i++;
}

iter.next()을(를) 사용하는 예제:

let i = 1;
let iterator = queueServiceClient.listQueues();
let item = await iterator.next();
while (!item.done) {
  console.log(`Queue${i}: ${iterator.value.name}`);
  i++;
  item = await iterator.next();
}

byPage()을(를) 사용하는 예제:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const item2 of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
  if (item2.queueItems) {
    for (const queueItem of item2.queueItems) {
      console.log(`Queue${i}: ${queueItem.name}`);
      i++;
    }
  }
}

표식과 함께 페이징을 사용하는 예제:

let i = 1;
let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
let item = (await iterator.next()).value;

// Prints 2 queue names
if (item.queueItems) {
  for (const queueItem of item.queueItems) {
    console.log(`Queue${i}: ${queueItem.name}`);
    i++;
  }
}
// Gets next marker
let marker = item.continuationToken;

// Passing next marker as continuationToken
iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
item = (await iterator.next()).value;

// Prints 10 queue names
if (item.queueItems) {
  for (const queueItem of item.queueItems) {
    console.log(`Queue${i}: ${queueItem.name}`);
    i++;
  }
}

function listQueues(options?: ServiceListQueuesOptions): PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

매개 변수

options
ServiceListQueuesOptions

큐 작업을 나열하는 옵션입니다.

반환

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

페이징을 지원하는 asyncIterableIterator입니다.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

스토리지 분석, CORS(원본 간 리소스 공유) 규칙 및 일시 삭제 설정에 대한 속성을 포함하여 스토리지 계정의 큐 서비스 엔드포인트에 대한 속성을 설정합니다.

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

function setProperties(properties: QueueServiceProperties, options?: ServiceGetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

매개 변수

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

속성 작업을 설정하는 옵션입니다.

반환

Promise<ServiceSetPropertiesResponse>

속성 설정 작업에 대한 응답 데이터입니다.