QueueServiceClient class

  • Referens
Paket:
@azure/storage-queue

En QueueServiceClient representerar en URL till Azure Storage Queue-tjänsten så att du kan ändra köer.

Extends

StorageClient

Konstruktorer

QueueServiceClient(string, Pipeline)

Skapar en instans av QueueServiceClient.
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Skapar en instans av QueueServiceClient.

Ärvda egenskaper

accountName
url

URL-strängvärde.

Metoder

createQueue(string, QueueCreateOptions)

Skapar en ny kö under det angivna kontot.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
deleteQueue(string, QueueDeleteOptions)

Tar bort den angivna kön permanent.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
fromConnectionString(string, StoragePipelineOptions)

Skapar en instans av QueueServiceClient.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Endast tillgängligt för QueueServiceClient som skapats med en autentiseringsuppgift med delad nyckel.

Genererar en SAS-URI (Signatur för delad åtkomst) baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

Hämtar egenskaperna för ett lagringskontos kötjänst, inklusive egenskaper för Lagringsanalys- och CORS-regler (resursdelning mellan ursprung).

Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties
getQueueClient(string)

Skapar ett QueueClient-objekt .
getStatistics(ServiceGetStatisticsOptions)

Hämtar statistik relaterad till replikering för kötjänsten. Den är endast tillgänglig på den sekundära platsslutpunkten när geo-redundant replikering med läsbehörighet är aktiverad för lagringskontot.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats
listQueues(ServiceListQueuesOptions)

Returnerar en asynkron iterbar iterator för att visa en lista över alla köer under det angivna kontot.

.byPage() returnerar en asynkron itererbar iterator för att visa en lista över köerna på sidor.

Exempel med syntax for await :

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

Exempel med 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();
}

Exempel med 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++;
    }
  }
}

Exempel med sidindelning med en markör:

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)

Anger egenskaper för ett lagringskontos kötjänstslutpunkt, inklusive egenskaper för Lagringsanalys, CORS-regler (resursdelning för korsande ursprung) och inställningar för mjuk borttagning.

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

Konstruktorinformation

QueueServiceClient(string, Pipeline)

Skapar en instans av QueueServiceClient.

new QueueServiceClient(url: string, pipeline: Pipeline)

Parametrar

url

string

En URL-sträng som pekar på Azure Storage-kötjänsten, till exempel "https://myaccount.queue.core.windows.net". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.queue.core.windows.net?sasString".

pipeline
Pipeline

Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.

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

Skapar en instans av QueueServiceClient.

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

Parametrar

url

string

En URL-sträng som pekar på Azure Storage-kötjänsten, till exempel "https://myaccount.queue.core.windows.net". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.queue.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.

options
StoragePipelineOptions

Alternativ för att konfigurera HTTP-pipelinen.

Exempel med defaultAzureCredential från @azure/identity:

const account = "<account>";

const credential = new DefaultAzureCredential();

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

Exempel med ett kontonamn/nyckel:

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
  }
);

Information om ärvda egenskaper

accountName 

accountName: string

Egenskapsvärde

string

Ärvd från StorageClient.accountName

url

URL-strängvärde.

url: string

Egenskapsvärde

string

Ärvd från StorageClient.url

Metodinformation

createQueue(string, QueueCreateOptions)

Skapar en ny kö under det angivna kontot.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4

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

Parametrar

queueName

string

namnet på kön som ska skapas

options
QueueCreateOptions

Alternativ för att skapa köåtgärd.

Returer

Promise<QueueCreateResponse>

Svarsdata för åtgärden Köskapande.

deleteQueue(string, QueueDeleteOptions)

Tar bort den angivna kön permanent.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3

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

Parametrar

queueName

string

namnet på kön som ska tas bort.

options
QueueDeleteOptions

Alternativ för borttagning av kö.

Returer

Promise<QueueDeleteResponse>

Svarsdata för borttagningsåtgärden Kö.

fromConnectionString(string, StoragePipelineOptions)

Skapar en instans av QueueServiceClient.

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

Parametrar

connectionString

string

Kontoanslutningssträng eller en SAS-anslutningssträng för ett Azure Storage-konto. [ Obs! Kontoanslutningssträngen kan bara användas i NODE.JS körning. ] Exempel på kontoanslutningssträng –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net EXEMPEL på SAS-anslutningssträng – 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

Alternativ för att konfigurera HTTP-pipelinen.

Returer

QueueServiceClient

Ett nytt QueueServiceClient-objekt från den angivna anslutningssträngen.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Endast tillgängligt för QueueServiceClient som skapats med en autentiseringsuppgift med delad nyckel.

Genererar en SAS-URI (Signatur för delad åtkomst) baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

Parametrar

expiresOn

Date

Valfritt. Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Standardvärdet är en timme senare om det inte anges.

permissions
AccountSASPermissions

Anger listan över behörigheter som ska associeras med SAS.

resourceTypes

string

Anger de resurstyper som är associerade med signaturen för delad åtkomst.

options
ServiceGenerateAccountSasUrlOptions

Valfria parametrar.

Returer

string

En SAS-URI för kontot som består av URI:n för den resurs som representeras av den här klienten, följt av den genererade SAS-token.

getProperties(ServiceGetPropertiesOptions)

Hämtar egenskaperna för ett lagringskontos kötjänst, inklusive egenskaper för Lagringsanalys- och CORS-regler (resursdelning mellan ursprung).

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

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

Parametrar

options
ServiceGetPropertiesOptions

Alternativ för att hämta egenskaper.

Returer

Promise<ServiceGetPropertiesResponse>

Svarsdata inklusive kötjänstens egenskaper.

getQueueClient(string)

Skapar ett QueueClient-objekt .

function getQueueClient(queueName: string): QueueClient

Parametrar

queueName

string

Returer

QueueClient

en ny QueueClient

Exempel på användning:

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

getStatistics(ServiceGetStatisticsOptions)

Hämtar statistik relaterad till replikering för kötjänsten. Den är endast tillgänglig på den sekundära platsslutpunkten när geo-redundant replikering med läsbehörighet är aktiverad för lagringskontot.

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

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

Parametrar

options
ServiceGetStatisticsOptions

Alternativ för att hämta statistikåtgärd.

Returer

Promise<ServiceGetStatisticsResponse>

Svarsdata för att hämta statistik för åtgärden.

listQueues(ServiceListQueuesOptions)

Returnerar en asynkron iterbar iterator för att visa en lista över alla köer under det angivna kontot.

.byPage() returnerar en asynkron itererbar iterator för att visa en lista över köerna på sidor.

Exempel med syntax for await :

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

Exempel med 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();
}

Exempel med 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++;
    }
  }
}

Exempel med sidindelning med en markör:

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>

Parametrar

options
ServiceListQueuesOptions

Alternativ för att lista köåtgärder.

Returer

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

En asyncIterableIterator som stöder sidindelning.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Anger egenskaper för ett lagringskontos kötjänstslutpunkt, inklusive egenskaper för Lagringsanalys, CORS-regler (resursdelning för korsande ursprung) och inställningar för mjuk borttagning.

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

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

Parametrar

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

Alternativ för att ange egenskapsåtgärd.

Returer

Promise<ServiceSetPropertiesResponse>

Svarsdata för åtgärden Ange egenskaper.