Megosztás:

QueueServiceClient class

Csomag:
@azure/storage-queue

A QueueServiceClient az Azure Storage Queue szolgáltatás URL-címét jelöli, amely lehetővé teszi az üzenetsorok manipulálását.

Kiterjeszti

StorageClient

Konstruktorok

QueueServiceClient(string, Pipeline)

Létrehozza a QueueServiceClient egy példányát.
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Létrehozza a QueueServiceClient egy példányát.

Örökölt tulajdonságok

accountName
url

URL-sztring értéke.

Módszerek

createQueue(string, QueueCreateOptions)

Új üzenetsort hoz létre a megadott fiók alatt.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-queue4
deleteQueue(string, QueueDeleteOptions)

Véglegesen törli a megadott üzenetsort.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-queue3
fromConnectionString(string, StoragePipelineOptions)

Létrehozza a QueueServiceClient egy példányát.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott QueueServiceClient esetén érhető el.

Létrehoz egy fiók megosztott hozzáférésű jogosultságkódját (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott QueueServiceClient esetén érhető el.

Sztringet hoz létre a fiók közös hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

Lekéri egy tárfiók üzenetsor-szolgáltatásának tulajdonságait, beleértve a Storage Analytics és a CORS (több forrás közötti erőforrás-megosztás) szabályok tulajdonságait is.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-queue-service-properties
getQueueClient(string)

Létrehoz egy QueueClient objektumot.
getStatistics(ServiceGetStatisticsOptions)

Lekéri a queue szolgáltatás replikációval kapcsolatos statisztikáit. Csak akkor érhető el a másodlagos hely végpontján, ha az olvasási hozzáférésű georedundáns replikáció engedélyezve van a tárfiókhoz.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-queue-service-stats
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

CSAK AKKOR ÉRHETŐ EL, HA BEARER TOKEN AUTHENTICATION (TokenCredential) használatos.

Lekér egy felhasználói delegációs kulcsot a Queue szolgáltatáshoz. Ez csak akkor érvényes a bearer token hitelesítés esetén.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key
listQueues(ServiceListQueuesOptions)

Egy aszinkron iterátort ad vissza a megadott fiók összes üzenetsorának listázásához.

A .byPage() egy aszinkron iterátorral listázhatja a lapok üzenetsorait.

Példa for await szintaxis használatára:

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élda a 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élda a 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élda jelölővel ellátott lapozásra:

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)

Beállítja a tárfiók várólista-szolgáltatásvégpontjának tulajdonságait, beleértve a Storage Analytics tulajdonságait, a CORS (forrásközi erőforrás-megosztás) szabályokat és a helyreállítható törlési beállításokat.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-queue-service-properties

Építő részletek

QueueServiceClient(string, Pipeline)

Létrehozza a QueueServiceClient egy példányát.

new QueueServiceClient(url: string, pipeline: Pipeline)

Paraméterek

url

string

Az Azure Storage üzenetsor-szolgáltatására mutató URL-sztring, például "https://myaccount.queue.core.windows.net". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.queue.core.windows.net?sasString".

pipeline
Pipeline

A newPipeline() hívása egy alapértelmezett folyamat létrehozásához vagy egy testreszabott folyamat megadásához.

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

Létrehozza a QueueServiceClient egy példányát.

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

Paraméterek

url

string

Az Azure Storage üzenetsor-szolgáltatására mutató URL-sztring, például "https://myaccount.queue.core.windows.net". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.queue.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.

options
StoragePipelineOptions

A HTTP-folyamat konfigurálására vonatkozó beállítások.

Példa a DefaultAzureCredential @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élda fióknév/kulcs használatával:

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

Örökölt ingatlan részletei

accountName 

accountName: string

Ingatlanérték

string

örökölt StorageClient.accountName

url

URL-sztring értéke.

url: string

Ingatlanérték

string

örökölt StorageClient.url-címről

Módszer részletei

createQueue(string, QueueCreateOptions)

Új üzenetsort hoz létre a megadott fiók alatt.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-queue4

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

Paraméterek

queueName

string

a létrehozandó üzenetsor neve

options
QueueCreateOptions

Az üzenetsor-létrehozási művelet beállításai.

Visszatér

Promise<QueueCreateResponse>

Válaszadatok az üzenetsor-létrehozási művelethez.

deleteQueue(string, QueueDeleteOptions)

Véglegesen törli a megadott üzenetsort.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-queue3

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

Paraméterek

queueName

string

a törölni kívánt üzenetsor neve.

options
QueueDeleteOptions

Üzenetsor-törlési művelet beállításai.

Visszatér

Promise<QueueDeleteResponse>

Válaszadatok az Üzenetsor törlése művelethez.

fromConnectionString(string, StoragePipelineOptions)

Létrehozza a QueueServiceClient egy példányát.

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

Paraméterek

connectionString

string

Fiókkapcsolati sztring vagy egy Azure Storage-fiók SAS-kapcsolati sztringje. [ Megjegyzés – A fiókkapcsolati sztring csak NODE.JS futtatókörnyezetben használható. ] Példa fiókkapcsolati sztringre – DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS kapcsolati sztring példa – 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

A HTTP-folyamat konfigurálására vonatkozó beállítások.

Visszatér

QueueServiceClient

Egy új QueueServiceClient objektum a megadott kapcsolati sztringből.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott QueueServiceClient esetén érhető el.

Létrehoz egy fiók megosztott hozzáférésű jogosultságkódját (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-account-sas

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

Paraméterek

expiresOn

Date

Optional. A közös hozzáférésű jogosultságkód érvénytelenné válásának időpontja. Alapértelmezés szerint egy órával később, ha nincs megadva.

permissions
AccountSASPermissions

Megadja az SAS-hez társítandó engedélyek listáját.

resourceTypes

string

Megadja a közös hozzáférésű jogosultságkódhoz társított erőforrástípusokat.

options
ServiceGenerateAccountSasUrlOptions

Nem kötelező paraméterek.

Visszatér

string

Egy fiók SAS URI-ja, amely az ügyfél által képviselt erőforrás URI-ját tartalmazza, majd a létrehozott SAS-jogkivonatot.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott QueueServiceClient esetén érhető el.

Sztringet hoz létre a fiók közös hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-account-sas

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

Paraméterek

expiresOn

Date

Optional. A közös hozzáférésű jogosultságkód érvénytelenné válásának időpontja. Alapértelmezés szerint egy órával később, ha nincs megadva.

permissions
AccountSASPermissions

Megadja az SAS-hez társítandó engedélyek listáját.

resourceTypes

string

Megadja a közös hozzáférésű jogosultságkódhoz társított erőforrástípusokat.

options
ServiceGenerateAccountSasUrlOptions

Nem kötelező paraméterek.

Visszatér

string

Egy fiók SAS URI-ja, amely az ügyfél által képviselt erőforrás URI-ját tartalmazza, majd a létrehozott SAS-jogkivonatot.

getProperties(ServiceGetPropertiesOptions)

Lekéri egy tárfiók üzenetsor-szolgáltatásának tulajdonságait, beleértve a Storage Analytics és a CORS (több forrás közötti erőforrás-megosztás) szabályok tulajdonságait is.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-queue-service-properties

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

Paraméterek

options
ServiceGetPropertiesOptions

Tulajdonságok lekérésének beállításai.

Visszatér

Promise<ServiceGetPropertiesResponse>

Válaszadatok a várólista-szolgáltatás tulajdonságaival együtt.

getQueueClient(string)

Létrehoz egy QueueClient objektumot.

function getQueueClient(queueName: string): QueueClient

Paraméterek

queueName

string

Visszatér

QueueClient

új QueueClient

Példahasználat:

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)

Lekéri a queue szolgáltatás replikációval kapcsolatos statisztikáit. Csak akkor érhető el a másodlagos hely végpontján, ha az olvasási hozzáférésű georedundáns replikáció engedélyezve van a tárfiókhoz.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-queue-service-stats

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

Paraméterek

options
ServiceGetStatisticsOptions

A statisztikai művelet lekérésének lehetőségei.

Visszatér

Promise<ServiceGetStatisticsResponse>

Válaszadatok a művelet statisztikáinak lekéréséhez.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

CSAK AKKOR ÉRHETŐ EL, HA BEARER TOKEN AUTHENTICATION (TokenCredential) használatos.

Lekér egy felhasználói delegációs kulcsot a Queue szolgáltatáshoz. Ez csak akkor érvényes a bearer token hitelesítés esetén.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

Paraméterek

startsOn

Date

A SAS felhasználói delegáció kezdeti ideje. A jelenlegi időponttól 7 napon belül kell lennie

expiresOn

Date

A SAS felhasználói delegációjának végideje. A jelenlegi időponttól 7 napon belül kell lennie

options
ServiceGetUserDelegationKeyOptions

Visszatér

Promise<ServiceGetUserDelegationKeyResponse>

listQueues(ServiceListQueuesOptions)

Egy aszinkron iterátort ad vissza a megadott fiók összes üzenetsorának listázásához.

A .byPage() egy aszinkron iterátorral listázhatja a lapok üzenetsorait.

Példa for await szintaxis használatára:

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élda a 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élda a 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élda jelölővel ellátott lapozásra:

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>

Paraméterek

options
ServiceListQueuesOptions

Az üzenetsorok műveletet listázó lehetőségek.

Visszatér

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

Lapozást támogató asyncIterableIterator.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Beállítja a tárfiók várólista-szolgáltatásvégpontjának tulajdonságait, beleértve a Storage Analytics tulajdonságait, a CORS (forrásközi erőforrás-megosztás) szabályokat és a helyreállítható törlési beállításokat.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-queue-service-properties

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

Paraméterek

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

Tulajdonságok beállításának beállításai.

Visszatér

Promise<ServiceSetPropertiesResponse>

A Tulajdonságok beállítása művelet válaszadatai.