QueueServiceClient class

  • Referentie
Pakket:
@azure/storage-queue

Een QueueServiceClient vertegenwoordigt een URL naar de Azure Storage Queue-service waarmee u wachtrijen kunt bewerken.

Extends

StorageClient

Constructors

QueueServiceClient(string, Pipeline)

Hiermee maakt u een exemplaar van QueueServiceClient.
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een exemplaar van QueueServiceClient.

Overgenomen eigenschappen

accountName
url

URL-tekenreekswaarde.

Methoden

createQueue(string, QueueCreateOptions)

Hiermee maakt u een nieuwe wachtrij onder het opgegeven account.

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

Hiermee verwijdert u de opgegeven wachtrij definitief.

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

Hiermee maakt u een exemplaar van QueueServiceClient.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Alleen beschikbaar voor QueueServiceClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee wordt een SAS-URI (Shared Access Signature) gegenereerd op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

Hiermee haalt u de eigenschappen op van de Queue-service van een opslagaccount, inclusief eigenschappen voor Opslaganalyse- en CORS-regels (Cross-Origin Resource Sharing).

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

Hiermee maakt u een QueueClient-object .
getStatistics(ServiceGetStatisticsOptions)

Hiermee worden statistieken opgehaald met betrekking tot replicatie voor de Queue-service. Deze is alleen beschikbaar op het eindpunt van de secundaire locatie wanneer geografisch redundante replicatie met leestoegang is ingeschakeld voor het opslagaccount.

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

Retourneert een asynchrone iterator om alle wachtrijen onder het opgegeven account weer te geven.

.byPage() retourneert een asynchrone iterator om de wachtrijen op pagina's weer te geven.

Voorbeeld met syntaxis for await :

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

Voorbeeld met 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();
}

Voorbeeld met 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++;
    }
  }
}

Voorbeeld van paging met een markering:

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)

Hiermee stelt u eigenschappen in voor het queue-service-eindpunt van een opslagaccount, waaronder eigenschappen voor Opslaganalyse, CORS-regels (Cross-Origin Resource Sharing) en instellingen voor voorlopig verwijderen.

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

Constructordetails

QueueServiceClient(string, Pipeline)

Hiermee maakt u een exemplaar van QueueServiceClient.

new QueueServiceClient(url: string, pipeline: Pipeline)

Parameters

url

string

Een URL-tekenreeks die verwijst naar de Azure Storage-wachtrijservice, zoals 'https://myaccount.queue.core.windows.net". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.queue.core.windows.net?sasString".

pipeline
Pipeline

Roep newPipeline() aan om een standaardpijplijn te maken of een aangepaste pijplijn op te geven.

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

Hiermee maakt u een exemplaar van QueueServiceClient.

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

Parameters

url

string

Een URL-tekenreeks die verwijst naar de Azure Storage-wachtrijservice, zoals 'https://myaccount.queue.core.windows.net". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.queue.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de interface TokenCredential wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

options
StoragePipelineOptions

Opties voor het configureren van de HTTP-pijplijn.

Voorbeeld met DefaultAzureCredential van @azure/identity:

const account = "<account>";

const credential = new DefaultAzureCredential();

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

Voorbeeld van een accountnaam/sleutel:

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

Details van overgenomen eigenschap

accountName 

accountName: string

Waarde van eigenschap

string

Overgenomen van StorageClient.accountName

url

URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

Overgenomen van StorageClient.url

Methodedetails

createQueue(string, QueueCreateOptions)

Hiermee maakt u een nieuwe wachtrij onder het opgegeven account.

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

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

Parameters

queueName

string

naam van de wachtrij die moet worden gemaakt

options
QueueCreateOptions

Opties voor het maken van de wachtrij.

Retouren

Promise<QueueCreateResponse>

Antwoordgegevens voor de bewerking Wachtrij maken.

deleteQueue(string, QueueDeleteOptions)

Hiermee verwijdert u de opgegeven wachtrij definitief.

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

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

Parameters

queueName

string

naam van de wachtrij die moet worden verwijderd.

options
QueueDeleteOptions

Opties voor het verwijderen van de wachtrij.

Retouren

Promise<QueueDeleteResponse>

Antwoordgegevens voor de bewerking Wachtrij verwijderen.

fromConnectionString(string, StoragePipelineOptions)

Hiermee maakt u een exemplaar van QueueServiceClient.

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

Parameters

connectionString

string

Account connection string of een SAS-connection string van een Azure-opslagaccount. [ Opmerking: account connection string kunnen alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van account connection string -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.netVoorbeeld van SAS-connection string -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

Opties voor het configureren van de HTTP-pijplijn.

Retouren

QueueServiceClient

Een nieuw QueueServiceClient-object van de opgegeven connection string.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Alleen beschikbaar voor QueueServiceClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee wordt een SAS-URI (Shared Access Signature) gegenereerd op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

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

Parameters

expiresOn

Date

Optioneel. Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt. Standaard ingesteld op een uur later als dit niet is opgegeven.

permissions
AccountSASPermissions

Hiermee geeft u de lijst met machtigingen die moeten worden gekoppeld aan de SAS.

resourceTypes

string

Hiermee geeft u de resourcetypen op die zijn gekoppeld aan de handtekening voor gedeelde toegang.

options
ServiceGenerateAccountSasUrlOptions

Optionele parameters.

Retouren

string

Een SAS-URI van het account die bestaat uit de URI voor de resource die door deze client wordt vertegenwoordigd, gevolgd door het gegenereerde SAS-token.

getProperties(ServiceGetPropertiesOptions)

Hiermee haalt u de eigenschappen op van de Queue-service van een opslagaccount, inclusief eigenschappen voor Opslaganalyse- en CORS-regels (Cross-Origin Resource Sharing).

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

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

Parameters

options
ServiceGetPropertiesOptions

Opties om de bewerking eigenschappen op te halen.

Retouren

Promise<ServiceGetPropertiesResponse>

Antwoordgegevens, inclusief de eigenschappen van de wachtrijservice.

getQueueClient(string)

Hiermee maakt u een QueueClient-object .

function getQueueClient(queueName: string): QueueClient

Parameters

queueName

string

Retouren

QueueClient

een nieuwe QueueClient

Gebruiksvoorbeeld:

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

getStatistics(ServiceGetStatisticsOptions)

Hiermee worden statistieken opgehaald met betrekking tot replicatie voor de Queue-service. Deze is alleen beschikbaar op het eindpunt van de secundaire locatie wanneer geografisch redundante replicatie met leestoegang is ingeschakeld voor het opslagaccount.

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

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

Parameters

options
ServiceGetStatisticsOptions

Opties voor het ophalen van een statistische bewerking.

Retouren

Promise<ServiceGetStatisticsResponse>

Antwoordgegevens voor het ophalen van statistieken voor de bewerking.

listQueues(ServiceListQueuesOptions)

Retourneert een asynchrone iterator om alle wachtrijen onder het opgegeven account weer te geven.

.byPage() retourneert een asynchrone iterator om de wachtrijen op pagina's weer te geven.

Voorbeeld met syntaxis for await :

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

Voorbeeld met 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();
}

Voorbeeld met 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++;
    }
  }
}

Voorbeeld van paging met een markering:

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>

Parameters

options
ServiceListQueuesOptions

Opties voor het weergeven van wachtrijen.

Retouren

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

Een asynchroneIterableIterator die paging ondersteunt.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Hiermee stelt u eigenschappen in voor het queue-service-eindpunt van een opslagaccount, waaronder eigenschappen voor Opslaganalyse, CORS-regels (Cross-Origin Resource Sharing) en instellingen voor voorlopig verwijderen.

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

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

Parameters

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

Opties voor het instellen van de bewerking van eigenschappen.

Retouren

Promise<ServiceSetPropertiesResponse>

Antwoordgegevens voor de bewerking Eigenschappen instellen.