QueueServiceClient class

  • Reference
Balíček:
@azure/storage-queue

QueueServiceClient představuje adresu URL služby Fronta služby Azure Storage, která umožňuje manipulaci s frontami.

Extends

StorageClient

Konstruktory

QueueServiceClient(string, Pipeline)

Vytvoří instanci QueueServiceClient.
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Vytvoří instanci QueueServiceClient.

Zděděné vlastnosti

accountName
url

Hodnota řetězce adresy URL.

Metody

createQueue(string, QueueCreateOptions)

Vytvoří novou frontu pod zadaným účtem.

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

Trvale odstraní zadanou frontu.

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

Vytvoří instanci QueueServiceClient.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

K dispozici pouze pro QueueServiceClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) účtu na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.

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

Získá vlastnosti služby Queue účtu úložiště, včetně vlastností pro pravidla Analýza úložiště a CORS (Sdílení prostředků mezi zdroji).

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

Vytvoří objekt QueueClient .
getStatistics(ServiceGetStatisticsOptions)

Načte statistiky související s replikací služby Queue. Je k dispozici pouze v sekundárním koncovém bodu umístění, pokud je pro účet úložiště povolená geograficky redundantní replikace s přístupem pro čtení.

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

Vrátí asynchronní iterátor pro výpis všech front v zadaném účtu.

.byPage() vrátí asynchronní iterátor pro výpis front na stránkách.

Příklad použití for await syntaxe:

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

Příklad použití 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();
}

Příklad použití 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++;
    }
  }
}

Příklad použití stránkování se značkou:

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)

Nastaví vlastnosti pro koncový bod služby Queue účtu úložiště, včetně vlastností pro Analýza úložiště, pravidel CORS (Sdílení prostředků mezi zdroji) a nastavení obnovitelného odstranění.

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

Podrobnosti konstruktoru

QueueServiceClient(string, Pipeline)

Vytvoří instanci QueueServiceClient.

new QueueServiceClient(url: string, pipeline: Pipeline)

Parametry

url

string

Řetězec adresy URL odkazující na službu fronty služby Azure Storage, například "https://myaccount.queue.core.windows.net". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.queue.core.windows.net?sasString".

pipeline
Pipeline

Voláním příkazu newPipeline() vytvořte výchozí kanál nebo zadejte vlastní kanál.

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

Vytvoří instanci QueueServiceClient.

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

Parametry

url

string

Řetězec adresy URL odkazující na službu fronty služby Azure Storage, například "https://myaccount.queue.core.windows.net". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.queue.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.

options
StoragePipelineOptions

Možnosti konfigurace kanálu HTTP

Příklad použití DefaultAzureCredential z @azure/identity:

const account = "<account>";

const credential = new DefaultAzureCredential();

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

Příklad použití názvu nebo klíče účtu:

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

Podrobnosti zděděných vlastností

accountName 

accountName: string

Hodnota vlastnosti

string

Zděděno z StorageClient.accountName

url

Hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

Zděděno z StorageClient.url

Podrobnosti metody

createQueue(string, QueueCreateOptions)

Vytvoří novou frontu pod zadaným účtem.

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

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

Parametry

queueName

string

název fronty, která se má vytvořit

options
QueueCreateOptions

Možnosti operace vytvoření fronty

Návraty

Promise<QueueCreateResponse>

Data odpovědí pro operaci vytvoření fronty.

deleteQueue(string, QueueDeleteOptions)

Trvale odstraní zadanou frontu.

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

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

Parametry

queueName

string

název fronty, která se má odstranit.

options
QueueDeleteOptions

Možnosti operace odstranění fronty

Návraty

Promise<QueueDeleteResponse>

Data odpovědí pro operaci odstranění fronty.

fromConnectionString(string, StoragePipelineOptions)

Vytvoří instanci QueueServiceClient.

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

Parametry

connectionString

string

Připojovací řetězec účtu nebo připojovací řetězec SAS účtu úložiště Azure. [ Poznámka – Připojovací řetězec účtu se dá použít jenom v modulu runtime NODE.JS. ] Příklad připojovacího řetězce účtu –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Příklad připojovacího řetězce 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

Možnosti konfigurace kanálu HTTP

Návraty

QueueServiceClient

Nový objekt QueueServiceClient z daného připojovacího řetězce.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

K dispozici pouze pro QueueServiceClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) účtu na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.

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

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

Parametry

expiresOn

Date

Nepovinný parametr. Čas, kdy se sdílený přístupový podpis stane neplatným. Výchozí hodnota je o hodinu později, pokud není zadáno.

permissions
AccountSASPermissions

Určuje seznam oprávnění, která se mají přidružit k SAS.

resourceTypes

string

Určuje typy prostředků přidružené ke sdílenému přístupovém podpisu.

options
ServiceGenerateAccountSasUrlOptions

Volitelné parametry.

Návraty

string

Identifikátor URI SAS účtu sestávající z identifikátoru URI prostředku reprezentovaného tímto klientem a následně z vygenerovaného tokenu SAS.

getProperties(ServiceGetPropertiesOptions)

Získá vlastnosti služby Queue účtu úložiště, včetně vlastností pro pravidla Analýza úložiště a CORS (Sdílení prostředků mezi zdroji).

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

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

Parametry

options
ServiceGetPropertiesOptions

Možnosti operace získání vlastností

Návraty

Promise<ServiceGetPropertiesResponse>

Data odpovědi, včetně vlastností služby fronty.

getQueueClient(string)

Vytvoří objekt QueueClient .

function getQueueClient(queueName: string): QueueClient

Parametry

queueName

string

Návraty

QueueClient

nový QueueClient

Příklad použití:

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

getStatistics(ServiceGetStatisticsOptions)

Načte statistiky související s replikací služby Queue. Je k dispozici pouze v sekundárním koncovém bodu umístění, pokud je pro účet úložiště povolená geograficky redundantní replikace s přístupem pro čtení.

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

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

Parametry

options
ServiceGetStatisticsOptions

Možnosti pro získání operace statistiky

Návraty

Promise<ServiceGetStatisticsResponse>

Data odpovědi pro získání statistiky operace.

listQueues(ServiceListQueuesOptions)

Vrátí asynchronní iterátor pro výpis všech front v zadaném účtu.

.byPage() vrátí asynchronní iterátor pro výpis front na stránkách.

Příklad použití for await syntaxe:

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

Příklad použití 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();
}

Příklad použití 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++;
    }
  }
}

Příklad použití stránkování se značkou:

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>

Parametry

options
ServiceListQueuesOptions

Možnosti operace výpisu front.

Návraty

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

AsyncIterableIterator, který podporuje stránkování.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Nastaví vlastnosti pro koncový bod služby Queue účtu úložiště, včetně vlastností pro Analýza úložiště, pravidel CORS (Sdílení prostředků mezi zdroji) a nastavení obnovitelného odstranění.

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

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

Parametry

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

Možnosti pro operaci nastavení vlastností.

Návraty

Promise<ServiceSetPropertiesResponse>

Data odpovědi pro operaci Nastavit vlastnosti.