QueueServiceClient class

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

new QueueServiceClient(url: string, pipeline: Pipeline)

매개 변수

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

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

매개 변수

import { DefaultAzureCredential } from "@azure/identity";
import { QueueServiceClient } from "@azure/storage-queue";

const account = "<account>";
const credential = new DefaultAzureCredential();

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

import { StorageSharedKeyCredential, QueueServiceClient } from "@azure/storage-queue";

// Enter your storage account name and shared key
const account = "<account>";
const accountKey = "<accountkey>";

// Use StorageSharedKeyCredential with storage account and account key
// StorageSharedKeyCredential is only available in Node.js runtime, not in browsers
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);

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

accountName: string

속성 값

StorageClient.accountName에서 상속된

URL 문자열 값입니다.

url: string

속성 값

StorageClient.url에서 상속된

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

https://learn.microsoft.com/rest/api/storageservices/create-queue4 참조

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

매개 변수

반환

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

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

https://learn.microsoft.com/rest/api/storageservices/delete-queue3 참조

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

매개 변수

반환

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

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

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

매개 변수

반환

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

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

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

https://learn.microsoft.com/rest/api/storageservices/create-account-sas 참조

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

매개 변수

반환

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

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

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

https://learn.microsoft.com/rest/api/storageservices/create-account-sas 참조

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

매개 변수

반환

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

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

https://learn.microsoft.com/rest/api/storageservices/get-queue-service-properties 참조

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

매개 변수

반환

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

QueueClient 개체를 만듭니다.

function getQueueClient(queueName: string): QueueClient

매개 변수

반환

새 QueueClient

사용 예:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const createQueueResponse = await queueClient.create();
console.log(
  `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
);

큐 서비스에 대한 복제와 관련된 통계를 검색합니다. 스토리지 계정에 대해 읽기 액세스 지역 중복 복제를 사용하도록 설정한 경우에만 보조 위치 엔드포인트에서 사용할 수 있습니다.

https://learn.microsoft.com/rest/api/storageservices/get-queue-service-stats 참조

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

매개 변수

반환

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

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

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

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

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

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

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

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

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

byPage()사용하는 예제:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
for await (const page of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
  for (const item of page.queueItems || []) {
    console.log(`Queue${i++}: ${item.name}`);
  }
}

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

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 queues
if (response.queueItems) {
  for (const item of response.queueItems) {
    console.log(`Queue${i++}: ${item.name}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 queues
if (response.queueItems) {
  for (const item of response.queueItems) {
    console.log(`Queue${i++}: ${item.name}`);
  }
}

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

매개 변수

반환

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

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

https://learn.microsoft.com/rest/api/storageservices/set-queue-service-properties 참조

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

매개 변수

반환

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