QueueServiceClient class

建立 QueueServiceClient 的實例。

new QueueServiceClient(url: string, pipeline: Pipeline)

參數

建立 QueueServiceClient 的實例。

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

參數

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: string

屬性值

繼承自 StorageClient.accountName

URL 字串值。

url: string

屬性值

繼承自 StorageClient.url

在指定的帳號下建立新的佇列。

請參閱https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4

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

參數

傳回

佇列建立作業的回應資料。

永久刪除指定的佇列。

請參閱https://docs.microsoft.com/en-us/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://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

參數

傳回

帳戶 SAS URI，其中包含此用戶端所代表資源的 URI，後面接著產生的 SAS 權杖。

取得儲存體帳戶佇列服務的屬性，包括儲存體分析和 CORS (跨原始來源資源分享) 規則的屬性。

請參閱https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties

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

參數

傳回

包含佇列服務屬性的回應資料。

建立 QueueClient 物件。

function getQueueClient(queueName: string): QueueClient

參數

傳回

新的 QueueClient

使用方式範例：

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

擷取與佇列服務的複寫相關的統計資料。 當儲存體帳戶啟用讀取權限的地理備援複寫時，它只能用於次要位置端點。

請參閱https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats

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

參數

傳回

取得作業統計資料的回應資料。

傳回非同步反覆運算器，以列出指定帳戶下的所有佇列。

.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}: ${item.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>

參數

傳回

支援分頁的 asyncIterableIterator。

設定儲存體帳戶佇列服務端點的屬性，包括儲存體分析的屬性、CORS (跨原始來源資源分享) 規則和虛刪除設定。

請參閱https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties

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

參數

傳回

設定屬性作業的回應資料。