Udostępnij za pośrednictwem

QueueServiceClient class

  • Odwołanie
Pakiet:
@azure/storage-queue

Obiekt QueueServiceClient reprezentuje adres URL usługi Azure Storage Queue, umożliwiając manipulowanie kolejkami.

Rozszerzenie

StorageClient

Konstruktory

QueueServiceClient(string, Pipeline)

Tworzy wystąpienie klasy QueueServiceClient.
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Tworzy wystąpienie klasy QueueServiceClient.

Właściwości dziedziczone

accountName
url

Wartość ciągu adresu URL.

Metody

createQueue(string, QueueCreateOptions)

Tworzy nową kolejkę w ramach określonego konta.

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

Usuwa określoną kolejkę trwale.

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

Tworzy wystąpienie klasy QueueServiceClient.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Dostępny tylko dla elementu QueueServiceClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

Generuje identyfikator URI sygnatury dostępu współdzielonego konta na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przy użyciu poświadczeń klucza współużytkowanego klienta.

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

Pobiera właściwości usługi kolejkowania konta magazynu, w tym właściwości reguł analityka magazynu i CORS (współużytkowanie zasobów między źródłami).

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

Tworzy obiekt QueueClient .
getStatistics(ServiceGetStatisticsOptions)

Pobiera statystyki związane z replikacją dla usługi Kolejki. Jest ona dostępna tylko w punkcie końcowym lokalizacji pomocniczej, gdy dla konta magazynu jest włączona replikacja geograficznie nadmiarowa z dostępem do odczytu.

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

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich kolejek w ramach określonego konta.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę kolejek na stronach.

Przykład użycia for await składni:

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

Przykład użycia polecenia 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();
}

Przykład użycia polecenia 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++;
    }
  }
}

Przykład użycia stronicowania ze znacznikiem:

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)

Ustawia właściwości punktu końcowego usługi kolejki konta magazynu, w tym właściwości dla analityka magazynu, reguł CORS (współużytkowania zasobów między źródłami) i ustawień usuwania nietrwałego.

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

Szczegóły konstruktora

QueueServiceClient(string, Pipeline)

Tworzy wystąpienie klasy QueueServiceClient.

new QueueServiceClient(url: string, pipeline: Pipeline)

Parametry

url

string

Ciąg adresu URL wskazujący usługę kolejki usługi Azure Storage, taką jak "https://myaccount.queue.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz elementu AnonymousCredential, takiego jak "https://myaccount.queue.core.windows.net?sasString".

pipeline
Pipeline

Wywołaj metodę newPipeline(), aby utworzyć domyślny potok, lub podaj dostosowany potok.

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

Tworzy wystąpienie klasy QueueServiceClient.

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

Parametry

url

string

Ciąg adresu URL wskazujący usługę kolejki usługi Azure Storage, taką jak "https://myaccount.queue.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz elementu AnonymousCredential, takiego jak "https://myaccount.queue.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu w @azure/identity celu uwierzytelnienia żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

options
StoragePipelineOptions

Opcje konfigurowania potoku HTTP.

Przykład użycia elementu DefaultAzureCredential z elementu @azure/identity:

const account = "<account>";

const credential = new DefaultAzureCredential();

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

Przykład użycia nazwy/klucza konta:

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

Szczegóły właściwości dziedziczonej

accountName 

accountName: string

Wartość właściwości

string

Dziedziczone z StorageClient.accountName

url

Wartość ciągu adresu URL.

url: string

Wartość właściwości

string

Dziedziczone z StorageClient.url

Szczegóły metody

createQueue(string, QueueCreateOptions)

Tworzy nową kolejkę w ramach określonego konta.

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

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

Parametry

queueName

string

nazwa kolejki do utworzenia

options
QueueCreateOptions

Opcje tworzenia kolejki.

Zwraca

Promise<QueueCreateResponse>

Dane odpowiedzi dla operacji tworzenia kolejki.

deleteQueue(string, QueueDeleteOptions)

Usuwa określoną kolejkę trwale.

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

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

Parametry

queueName

string

nazwa kolejki do usunięcia.

options
QueueDeleteOptions

Opcje operacji usuwania kolejki.

Zwraca

Promise<QueueDeleteResponse>

Dane odpowiedzi dla operacji usuwania kolejki.

fromConnectionString(string, StoragePipelineOptions)

Tworzy wystąpienie klasy QueueServiceClient.

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

Parametry

connectionString

string

Parametry połączenia konta lub parametry połączenia sygnatury dostępu współdzielonego konta usługi Azure Storage. [ Uwaga — parametry połączenia konta mogą być używane tylko w środowisku uruchomieniowym NODE.JS. ] Przykład parametrów połączenia konta —DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Przykład parametrów połączenia sygnatury dostępu współdzielonego — 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

Opcje konfigurowania potoku HTTP.

Zwraca

QueueServiceClient

Nowy obiekt QueueServiceClient z podanych parametrów połączenia.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Dostępny tylko dla elementu QueueServiceClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

Generuje identyfikator URI sygnatury dostępu współdzielonego konta na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przy użyciu poświadczeń klucza współużytkowanego klienta.

Zobacz 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

Opcjonalny. Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wartość domyślna to godzina później, jeśli nie zostanie określona.

permissions
AccountSASPermissions

Określa listę uprawnień do skojarzenia z sygnaturą dostępu współdzielonego.

resourceTypes

string

Określa typy zasobów skojarzone z sygnaturą dostępu współdzielonego.

options
ServiceGenerateAccountSasUrlOptions

Parametry opcjonalne.

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego konta składający się z identyfikatora URI zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SYGNATURy dostępu współdzielonego.

getProperties(ServiceGetPropertiesOptions)

Pobiera właściwości usługi kolejkowania konta magazynu, w tym właściwości reguł analityka magazynu i CORS (współużytkowanie zasobów między źródłami).

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

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

Parametry

options
ServiceGetPropertiesOptions

Opcje pobierania operacji właściwości.

Zwraca

Promise<ServiceGetPropertiesResponse>

Dane odpowiedzi, w tym właściwości usługi kolejki.

getQueueClient(string)

Tworzy obiekt QueueClient .

function getQueueClient(queueName: string): QueueClient

Parametry

queueName

string

Zwraca

QueueClient

nowy element QueueClient

Przykład użycia: 

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

getStatistics(ServiceGetStatisticsOptions)

Pobiera statystyki związane z replikacją dla usługi Kolejki. Jest ona dostępna tylko w punkcie końcowym lokalizacji pomocniczej, gdy dla konta magazynu jest włączona replikacja geograficznie nadmiarowa z dostępem do odczytu.

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

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

Parametry

options
ServiceGetStatisticsOptions

Opcje pobierania operacji statystyk.

Zwraca

Promise<ServiceGetStatisticsResponse>

Dane odpowiedzi dotyczące pobierania statystyk operacji.

listQueues(ServiceListQueuesOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich kolejek w ramach określonego konta.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę kolejek na stronach.

Przykład użycia for await składni:

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

Przykład użycia polecenia 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();
}

Przykład użycia polecenia 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++;
    }
  }
}

Przykład użycia stronicowania ze znacznikiem:

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

Opcje wyświetlania listy operacji kolejek.

Zwraca

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

AsyncIterableIterator, który obsługuje stronicowanie.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Ustawia właściwości punktu końcowego usługi kolejki konta magazynu, w tym właściwości dla analityka magazynu, reguł CORS (współużytkowania zasobów między źródłami) i ustawień usuwania nietrwałego.

Zobacz 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

Opcje ustawiania operacji właściwości.

Zwraca

Promise<ServiceSetPropertiesResponse>

Dane odpowiedzi dla operacji Ustaw właściwości.