Sdílet prostřednictvím

QueueServiceClient class

Balíček:
@azure/storage-queue

QueueServiceClient představuje adresu URL služby Azure Storage Queue, která umožňuje manipulovat 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.

Podívejte se na https://learn.microsoft.com/rest/api/storageservices/create-queue4
deleteQueue(string, QueueDeleteOptions)

Odstraní zadanou frontu trvale.

Podívejte se na https://learn.microsoft.com/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 účtu na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.

Podívejte se na https://learn.microsoft.com/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

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

Podívejte se na https://learn.microsoft.com/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

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

Podívejte se na https://learn.microsoft.com/rest/api/storageservices/get-queue-service-properties
getQueueClient(string)

Vytvoří objekt QueueClient.
getStatistics(ServiceGetStatisticsOptions)

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

Podívejte se na https://learn.microsoft.com/rest/api/storageservices/get-queue-service-stats
listQueues(ServiceListQueuesOptions)

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

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

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

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

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

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

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}`);
  }
}
setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

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

Podívejte se na https://learn.microsoft.com/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 metody newPipeline() vytvořte výchozí kanál nebo zadejte přizpůsobený 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 balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. 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:

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

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

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

Podrobnosti zděděných vlastností

accountName 

accountName: string

Hodnota vlastnosti

string

zděděno ze StorageClient.accountName

url

Hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

zděděno ze StorageClient.url

Podrobnosti metody

createQueue(string, QueueCreateOptions)

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

Podívejte se na https://learn.microsoft.com/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)

Odstraní zadanou frontu trvale.

Podívejte se na https://learn.microsoft.com/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 lze použít pouze v NODE.JS modulu runtime. ] Příklad připojovacího řetězce účtu – Příklad připojovacího řetězce SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net – 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 účtu na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.

Podívejte se na https://learn.microsoft.com/rest/api/storageservices/create-account-sas

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

Parametry

expiresOn

Date

Optional. Čas, kdy se sdílený přístupový podpis stane neplatným. Výchozí hodnota je hodina později, pokud není zadána.

permissions
AccountSASPermissions

Určuje seznamoprávněních

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, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

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

Podívejte se na https://learn.microsoft.com/rest/api/storageservices/create-account-sas

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

Parametry

expiresOn

Date

Optional. Čas, kdy se sdílený přístupový podpis stane neplatným. Výchozí hodnota je hodina později, pokud není zadána.

permissions
AccountSASPermissions

Určuje seznamoprávněních

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, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

getProperties(ServiceGetPropertiesOptions)

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

Podívejte se na https://learn.microsoft.com/rest/api/storageservices/get-queue-service-properties

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

Parametry

options
ServiceGetPropertiesOptions

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

Návraty

Promise<ServiceGetPropertiesResponse>

Data odpovědí, 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í:

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

getStatistics(ServiceGetStatisticsOptions)

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

Podívejte se na https://learn.microsoft.com/rest/api/storageservices/get-queue-service-stats

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

Parametry

options
ServiceGetStatisticsOptions

Možnosti získání operace statistiky

Návraty

Promise<ServiceGetStatisticsResponse>

Data odpovědí pro získání statistiky operace

listQueues(ServiceListQueuesOptions)

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

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

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

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

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

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

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>

Parametry

options
ServiceListQueuesOptions

Možnosti zobrazení seznamu operací front

Návraty

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

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

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

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

Podívejte se na https://learn.microsoft.com/rest/api/storageservices/set-queue-service-properties

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

Parametry

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

Možnosti nastavení operace vlastností

Návraty

Promise<ServiceSetPropertiesResponse>

Data odpovědi pro operaci Nastavit vlastnosti.