共用方式為

QueueServiceClient class

  • 參考
套件:
@azure/storage-queue

QueueServiceClient 代表 Azure 記憶體佇列服務的 URL，可讓您操作佇列。

Extends

StorageClient

建構函式

QueueServiceClient(string, Pipeline)

建立 QueueServiceClient 的實例。
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

建立 QueueServiceClient 的實例。

繼承的屬性

accountName
url

URL 字串值。

方法

createQueue(string, QueueCreateOptions)

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

請參閱 https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4
deleteQueue(string, QueueDeleteOptions)

永久刪除指定的佇列。

請參閱 https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3
fromConnectionString(string, StoragePipelineOptions)

建立 QueueServiceClient 的實例。
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

僅適用於使用共用密鑰認證建構的 QueueServiceClient。

根據傳入的用戶端屬性和參數，產生帳戶共用存取簽章 （SAS） URI。 SAS 是由客戶端的共用金鑰認證所簽署。

請參閱 https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

僅適用於使用共用密鑰認證建構的 QueueServiceClient。

根據傳入的用戶端屬性和參數，產生要簽署帳戶共用存取簽章 （SAS） URI 的字串。 SAS 是由客戶端的共用金鑰認證所簽署。

請參閱 https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

取得記憶體帳戶佇列服務的屬性，包括記憶體分析和 CORS（跨原始來源資源分享）規則的屬性。

請參閱 https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties
getQueueClient(string)

建立 QueueClient 物件。
getStatistics(ServiceGetStatisticsOptions)

擷取佇列服務複寫的相關統計數據。 只有在記憶體帳戶啟用讀取許可權異地備援複寫時，才能在次要位置端點上使用。

請參閱 https://learn.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}: ${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++;
  }
}
setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

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

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

建構函式詳細資料

QueueServiceClient(string, Pipeline)

建立 QueueServiceClient 的實例。

new QueueServiceClient(url: string, pipeline: Pipeline)

參數

url

string

指向 Azure 記憶體佇列服務的 URL 字串，例如 「https://myaccount.queue.core.windows.net"。 如果使用 AnonymousCredential，則可以附加 SAS，例如 “https://myaccount.queue.core.windows.net?sasString"。

pipeline
Pipeline

呼叫 newPipeline（） 以建立預設管線，或提供自定義管線。

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

建立 QueueServiceClient 的實例。

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

參數

url

string

指向 Azure 記憶體佇列服務的 URL 字串，例如 「https://myaccount.queue.core.windows.net"。 如果使用 AnonymousCredential，則可以附加 SAS，例如 “https://myaccount.queue.core.windows.net?sasString"。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

例如 AnonymousCredential、StorageSharedKeyCredential 或任何來自 @azure/identity 套件的認證，以驗證對服務的要求。 您也可以提供實作 TokenCredential 介面的物件。 如果未指定，則會使用 AnonymousCredential。

options
StoragePipelineOptions

設定 HTTP 管線的選項。

從 @azure/identity使用 DefaultAzureCredential 的範例：

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://learn.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://learn.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 記憶體帳戶的 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://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

參數

expiresOn

Date

自選。 共用存取簽章失效的時間。 如果未指定，則預設為一小時后。

permissions
AccountSASPermissions

指定要與 SAS 相關聯的許可權清單。

resourceTypes

string

指定與共用存取簽章相關聯的資源類型。

options
ServiceGenerateAccountSasUrlOptions

選擇性參數。

傳回

string

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

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

僅適用於使用共用密鑰認證建構的 QueueServiceClient。

根據傳入的用戶端屬性和參數，產生要簽署帳戶共用存取簽章 （SAS） URI 的字串。 SAS 是由客戶端的共用金鑰認證所簽署。

請參閱 https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

參數

expiresOn

Date

自選。 共用存取簽章失效的時間。 如果未指定，則預設為一小時后。

permissions
AccountSASPermissions

指定要與 SAS 相關聯的許可權清單。

resourceTypes

string

指定與共用存取簽章相關聯的資源類型。

options
ServiceGenerateAccountSasUrlOptions

選擇性參數。

傳回

string

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

getProperties(ServiceGetPropertiesOptions)

取得記憶體帳戶佇列服務的屬性，包括記憶體分析和 CORS（跨原始來源資源分享）規則的屬性。

請參閱 https://learn.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://learn.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}: ${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>

參數

options
ServiceListQueuesOptions

列出佇列作業的選項。

傳回

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

支援分頁的 asyncIterableIterator。

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

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

請參閱 https://learn.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>

設定屬性作業的響應數據。