QueueServiceClient class

  • Referenz
Paket:
@azure/storage-queue

Ein QueueServiceClient stellt eine URL zum Azure Storage-Warteschlangendienst dar, mit der Sie Warteschlangen bearbeiten können.

Extends

StorageClient

Konstruktoren

QueueServiceClient(string, Pipeline)

Erstellt eine Instanz von QueueServiceClient.
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Erstellt eine Instanz von QueueServiceClient.

Geerbte Eigenschaften

accountName
url

URL-Zeichenfolgenwert.

Methoden

createQueue(string, QueueCreateOptions)

Erstellt eine neue Warteschlange unter dem angegebenen Konto.

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

Löscht die angegebene Warteschlange dauerhaft.

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

Erstellt eine Instanz von QueueServiceClient.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Nur für QueueServiceClient verfügbar, der mit Anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurde.

Generiert einen SAS-URI (Shared Access Signature) des Kontos basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.

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

Ruft die Eigenschaften des Warteschlangendiensts eines Speicherkontos ab, einschließlich Eigenschaften für Storage Analytics- und CORS-Regeln (Cross-Origin Resource Sharing).

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

Erstellt ein QueueClient-Objekt .
getStatistics(ServiceGetStatisticsOptions)

Ruft Statistiken zur Replikation für den Warteschlangendienst ab. Er ist nur über den sekundären Standortendpunkt verfügbar, wenn die georedundante Replikation mit Lesezugriff für das Speicherkonto aktiviert ist.

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

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Warteschlangen unter dem angegebenen Konto aufzulisten.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Warteschlangen auf Seiten aufzulisten.

Beispiel für die Verwendung von for await Syntax:

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

Beispiel für die Verwendung von 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();
}

Beispiel für die Verwendung von 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++;
    }
  }
}

Beispiel für die Verwendung von Paging mit einem Marker:

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)

Legt Eigenschaften für den Warteschlangendienstendpunkt eines Speicherkontos fest, einschließlich Eigenschaften für Storage Analytics, CORS-Regeln (Cross-Origin Resource Sharing) und Vorläufiges Löschen.

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

Details zum Konstruktor

QueueServiceClient(string, Pipeline)

Erstellt eine Instanz von QueueServiceClient.

new QueueServiceClient(url: string, pipeline: Pipeline)

Parameter

url

string

Eine URL-Zeichenfolge, die auf den Azure Storage-Warteschlangendienst verweist, z. B. "https://myaccount.queue.core.windows.net"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.queue.core.windows.net?sasString"".

pipeline
Pipeline

Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen oder eine angepasste Pipeline bereitzustellen.

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

Erstellt eine Instanz von QueueServiceClient.

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

Parameter

url

string

Eine URL-Zeichenfolge, die auf den Azure Storage-Warteschlangendienst verweist, z. B. "https://myaccount.queue.core.windows.net"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.queue.core.windows.net?sasString"".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

z. B. AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Falls nicht angegeben, wird AnonymousCredential verwendet.

options
StoragePipelineOptions

Optionen zum Konfigurieren der HTTP-Pipeline.

Beispiel für die Verwendung von DefaultAzureCredential von @azure/identity:

const account = "<account>";

const credential = new DefaultAzureCredential();

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

Beispiel für die Verwendung eines Kontonamens/-schlüssels:

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

Geerbte Eigenschaftsdetails

accountName 

accountName: string

Eigenschaftswert

string

Geerbt von StorageClient.accountName

url

URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Geerbt von StorageClient.url

Details zur Methode

createQueue(string, QueueCreateOptions)

Erstellt eine neue Warteschlange unter dem angegebenen Konto.

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

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

Parameter

queueName

string

Name der zu erstellenden Warteschlange

options
QueueCreateOptions

Optionen zum Warteschlangenerstellungsvorgang.

Gibt zurück

Promise<QueueCreateResponse>

Antwortdaten für den Vorgang "Warteschlangenerstellung".

deleteQueue(string, QueueDeleteOptions)

Löscht die angegebene Warteschlange dauerhaft.

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

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

Parameter

queueName

string

Name der zu löschenden Warteschlange.

options
QueueDeleteOptions

Optionen zum Warteschlangenlöschvorgang.

Gibt zurück

Promise<QueueDeleteResponse>

Antwortdaten für den Warteschlangenlöschvorgang.

fromConnectionString(string, StoragePipelineOptions)

Erstellt eine Instanz von QueueServiceClient.

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

Parameter

connectionString

string

Kontoverbindungszeichenfolge oder SAS-Verbindungszeichenfolge eines Azure-Speicherkontos. [ Hinweis: Die Kontoverbindungszeichenfolge kann nur in NODE.JS Runtime verwendet werden. ] Beispiel für die Kontoverbindungszeichenfolge :DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-Verbindungszeichenfolgenbeispiel: 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

Optionen zum Konfigurieren der HTTP-Pipeline.

Gibt zurück

QueueServiceClient

Ein neues QueueServiceClient-Objekt aus der angegebenen Verbindungszeichenfolge.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Nur für QueueServiceClient verfügbar, der mit Anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurde.

Generiert einen SAS-URI (Shared Access Signature) des Kontos basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.

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

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

Parameter

expiresOn

Date

Optional. Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird. Wenn nicht angegeben, wird standardmäßig eine Stunde später festgelegt.

permissions
AccountSASPermissions

Gibt die Liste der Berechtigungen an, die der SAS zugeordnet werden sollen.

resourceTypes

string

Gibt die Ressourcentypen an, die der Freigegebenen Zugriffssignatur zugeordnet sind.

options
ServiceGenerateAccountSasUrlOptions

Optionale Parameter.

Gibt zurück

string

Ein KONTO-SAS-URI, der aus dem URI für die von diesem Client dargestellte Ressource besteht, gefolgt von dem generierten SAS-Token.

getProperties(ServiceGetPropertiesOptions)

Ruft die Eigenschaften des Warteschlangendiensts eines Speicherkontos ab, einschließlich Eigenschaften für Storage Analytics- und CORS-Regeln (Cross-Origin Resource Sharing).

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

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

Parameter

options
ServiceGetPropertiesOptions

Optionen zum Abrufen des Eigenschaftenvorgangs.

Gibt zurück

Promise<ServiceGetPropertiesResponse>

Antwortdaten, einschließlich der Warteschlangendiensteigenschaften.

getQueueClient(string)

Erstellt ein QueueClient-Objekt .

function getQueueClient(queueName: string): QueueClient

Parameter

queueName

string

Gibt zurück

QueueClient

einen neuen QueueClient

Beispielverwendung:

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

getStatistics(ServiceGetStatisticsOptions)

Ruft Statistiken zur Replikation für den Warteschlangendienst ab. Er ist nur über den sekundären Standortendpunkt verfügbar, wenn die georedundante Replikation mit Lesezugriff für das Speicherkonto aktiviert ist.

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

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

Parameter

options
ServiceGetStatisticsOptions

Optionen zum Abrufen des Statistikvorgangs.

Gibt zurück

Promise<ServiceGetStatisticsResponse>

Antwortdaten zum Abrufen von Statistiken für den Vorgang.

listQueues(ServiceListQueuesOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Warteschlangen unter dem angegebenen Konto aufzulisten.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Warteschlangen auf Seiten aufzulisten.

Beispiel für die Verwendung von for await Syntax:

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

Beispiel für die Verwendung von 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();
}

Beispiel für die Verwendung von 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++;
    }
  }
}

Beispiel für die Verwendung von Paging mit einem Marker:

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>

Parameter

options
ServiceListQueuesOptions

Optionen zum Auflisten von Warteschlangenvorgängen.

Gibt zurück

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

Ein asyncIterableIterator, der Paging unterstützt.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Legt Eigenschaften für den Warteschlangendienstendpunkt eines Speicherkontos fest, einschließlich Eigenschaften für Storage Analytics, CORS-Regeln (Cross-Origin Resource Sharing) und Vorläufiges Löschen.

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

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

Parameter

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

Optionen zum Festlegen des Eigenschaftenvorgangs.

Gibt zurück

Promise<ServiceSetPropertiesResponse>

Antwortdaten für den Vorgang Eigenschaften festlegen.