QueueServiceClient class

Erstellt eine Instanz von QueueServiceClient.

new QueueServiceClient(url: string, pipeline: Pipeline)

Parameter

Erstellt eine Instanz von QueueServiceClient.

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

Parameter

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: string

Eigenschaftswert

Geerbt von StorageClient.accountName

URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

Geerbt von StorageClient.url

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

Gibt zurück

Antwortdaten für den Vorgang "Warteschlangenerstellung".

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

Gibt zurück

Antwortdaten für den Warteschlangenlöschvorgang.

Erstellt eine Instanz von QueueServiceClient.

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

Parameter

Gibt zurück

Ein neues QueueServiceClient-Objekt aus der angegebenen Verbindungszeichenfolge.

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

Gibt zurück

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

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

Gibt zurück

Antwortdaten, einschließlich der Warteschlangendiensteigenschaften.

Erstellt ein QueueClient-Objekt .

function getQueueClient(queueName: string): QueueClient

Parameter

Gibt zurück

einen neuen QueueClient

Beispielverwendung:

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

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

Gibt zurück

Antwortdaten zum Abrufen von Statistiken für den Vorgang.

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}: ${item.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

Gibt zurück

Ein asyncIterableIterator, der Paging unterstützt.

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

Gibt zurück

Antwortdaten für den Vorgang Eigenschaften festlegen.