QueueServiceClient class

Pakiet:: @azure/storage-queue

Obiekt QueueServiceClient reprezentuje adres URL usługi Azure Storage Queue Service, co umożliwia 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

accountName
url	Wartość ciągu adresu URL.

Metody

createQueue(string, QueueCreateOptions)	Tworzy nową kolejkę w ramach określonego konta.
deleteQueue(string, QueueDeleteOptions)	Usuwa określoną kolejkę trwale.
fromConnectionString(string, StoragePipelineOptions)	Tworzy wystąpienie klasy QueueServiceClient.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)	Dostępny tylko dla elementu QueueServiceClient skonstruowany przy użyciu poświadczeń klucza współużytkowanego. Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) konta na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.
getProperties(ServiceGetPropertiesOptions)	Pobiera właściwości usługi kolejkowania konta magazynu, w tym właściwości reguł analizy magazynu i mechanizmu CORS (współużytkowanie zasobów między źródłami).
getQueueClient(string)	Tworzy obiekt <xref:QueueClient>.
getStatistics(ServiceGetStatisticsOptions)	Pobiera statystyki związane z replikacją dla usługi Kolejki. Jest on dostępny tylko w punkcie końcowym lokalizacji dodatkowej, gdy dla konta magazynu jest włączona replikacja geograficznie nadmiarowa dostępu do odczytu.
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 składni `for await`: let i = 1; for await (const item of queueServiceClient.listQueues()) { console.log(`Queue${i}: ${item.name}`); i++; } Przykład użycia `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(); } Przykład użycia `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 reguł analizy magazynu, mechanizmu CORS (współużytkowania zasobów między źródłami) i ustawień usuwania nietrwałego.

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 jest używana funkcja AnonymousCredential, na przykład "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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żą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 @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

accountName

accountName: string

Wartość właściwości

string

url

Wartość ciągu adresu URL.

url: string

Wartość właściwości

string

Szczegóły metody

createQueue(string, QueueCreateOptions)

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

function createQueue(queueName: string, options?: QueueCreateOptions)

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.

function deleteQueue(queueName: string, options?: QueueDeleteOptions)

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)

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 — przykład parametrów połączenia sygnatury dostępu współdzielonego 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

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 skonstruowany przy użyciu poświadczeń klucza współużytkowanego. Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) konta na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

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

Parametry

expiresOn: Date

Fakultatywny. Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wartość domyślna na godzinę 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 do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

getProperties(ServiceGetPropertiesOptions)

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

function getProperties(options?: ServiceGetPropertiesOptions)

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 <xref:QueueClient>.

function getQueueClient(queueName: string)

Parametry

queueName: string

Zwraca

QueueClient

nowy element QueueClient

Przykładowe użycie:

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 on dostępny tylko w punkcie końcowym lokalizacji dodatkowej, gdy dla konta magazynu jest włączona replikacja geograficznie nadmiarowa dostępu do odczytu.

function getStatistics(options?: ServiceGetStatisticsOptions)

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 składni for await:

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

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

Przykład użycia 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)

Parametry

options: ServiceListQueuesOptions

Opcje wyświetlania listy operacji kolejek.

Zwraca

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse>

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 reguł analizy magazynu, mechanizmu CORS (współużytkowania zasobów między źródłami) i ustawień usuwania nietrwałego.

function setProperties(properties: QueueServiceProperties, options?: ServiceGetPropertiesOptions)

Parametry

properties: QueueServiceProperties

options: ServiceGetPropertiesOptions

Opcje ustawiania operacji właściwości.

Zwraca

Promise<ServiceSetPropertiesResponse>

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

Opinia

Czy ta strona była pomocna?