Condividi tramite

QueueServiceClient class

  • Riferimento
Pacchetto:
@azure/storage-queue

QueueServiceClient rappresenta un URL del servizio di accodamento di Archiviazione di Azure che consente di modificare le code.

Extends

StorageClient

Costruttori

QueueServiceClient(string, Pipeline)

Crea un'istanza di QueueServiceClient.
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un'istanza di QueueServiceClient.

Proprietà ereditate

accountName
url

Valore stringa URL.

Metodi

createQueue(string, QueueCreateOptions)

Crea una nuova coda nell'account specificato.

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

Elimina definitivamente la coda specificata.

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

Crea un'istanza di QueueServiceClient.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponibile solo per QueueServiceClient costruito con credenziali con chiave condivisa.

Genera un URI di firma di accesso condiviso (SAS) dell'account in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

Fare riferimento a https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponibile solo per QueueServiceClient costruito con credenziali con chiave condivisa.

Genera una stringa per firmare un URI di firma di accesso condiviso (SAS) dell'account in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

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

Ottiene le proprietà del servizio di accodamento di un account di archiviazione, incluse le proprietà per le regole di Analisi archiviazione e CORS (condivisione di risorse tra le origini).

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

Crea un oggetto QueueClient.
getStatistics(ServiceGetStatisticsOptions)

Recupera le statistiche correlate alla replica per il servizio di accodamento. È disponibile solo nell'endpoint della posizione secondaria quando la replica con ridondanza geografica dell'accesso in lettura è abilitata per l'account di archiviazione.

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

Restituisce un iteratore iteratore asincrono per elencare tutte le code nell'account specificato.

.byPage() restituisce un iteratore iteratore asincrono per elencare le code nelle pagine.

Esempio di utilizzo della sintassi for await:

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

Esempio di utilizzo di 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();
}

Esempio di utilizzo di 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++;
    }
  }
}

Esempio di utilizzo del paging con un marcatore:

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)

Imposta le proprietà per l'endpoint del servizio di accodamento di un account di archiviazione, incluse le proprietà per Analisi archiviazione, le regole CORS (Condivisione risorse tra le origini) e le impostazioni di eliminazione temporanea.

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

Dettagli costruttore

QueueServiceClient(string, Pipeline)

Crea un'istanza di QueueServiceClient.

new QueueServiceClient(url: string, pipeline: Pipeline)

Parametri

url

string

Stringa URL che punta al servizio di accodamento di Archiviazione di Azure, ad esempio "https://myaccount.queue.core.windows.net". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.queue.core.windows.net?sasString".

pipeline
Pipeline

Chiamare newPipeline() per creare una pipeline predefinita o fornire una pipeline personalizzata.

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

Crea un'istanza di QueueServiceClient.

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

Parametri

url

string

Stringa URL che punta al servizio di accodamento di Archiviazione di Azure, ad esempio "https://myaccount.queue.core.windows.net". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.queue.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del pacchetto @azure/identity per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene utilizzato AnonymousCredential.

options
StoragePipelineOptions

Opzioni per configurare la pipeline HTTP.

Esempio di uso di DefaultAzureCredential da @azure/identity:

const account = "<account>";

const credential = new DefaultAzureCredential();

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

Esempio che usa un nome/chiave dell'account:

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

Dettagli proprietà ereditate

accountName 

accountName: string

Valore della proprietà

string

Ereditato da StorageClient.accountName

url

Valore stringa URL.

url: string

Valore della proprietà

string

Ereditato da StorageClient.url

Dettagli metodo

createQueue(string, QueueCreateOptions)

Crea una nuova coda nell'account specificato.

Fare riferimento a https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4

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

Parametri

queueName

string

nome della coda da creare

options
QueueCreateOptions

Opzioni per accodare l'operazione di creazione.

Restituisce

Promise<QueueCreateResponse>

Dati di risposta per l'operazione di creazione coda.

deleteQueue(string, QueueDeleteOptions)

Elimina definitivamente la coda specificata.

Fare riferimento a https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3

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

Parametri

queueName

string

nome della coda da eliminare.

options
QueueDeleteOptions

Opzioni per l'operazione di eliminazione coda.

Restituisce

Promise<QueueDeleteResponse>

Dati di risposta per l'operazione di eliminazione coda.

fromConnectionString(string, StoragePipelineOptions)

Crea un'istanza di QueueServiceClient.

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

Parametri

connectionString

string

Stringa di connessione dell'account o stringa di connessione sas di un account di archiviazione di Azure. [ Nota: la stringa di connessione dell'account può essere usata solo in NODE.JS runtime. ] Esempio di stringa di connessione dell'account - Esempio di stringa di connessione sas 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

Opzioni per configurare la pipeline HTTP.

Restituisce

QueueServiceClient

Nuovo oggetto QueueServiceClient dalla stringa di connessione specificata.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponibile solo per QueueServiceClient costruito con credenziali con chiave condivisa.

Genera un URI di firma di accesso condiviso (SAS) dell'account in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

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

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

Parametri

expiresOn

Date

Opzionale. Ora in cui la firma di accesso condiviso non è valida. Il valore predefinito è un'ora successiva, se non specificato.

permissions
AccountSASPermissions

Specifica l'elenco di autorizzazioni da associare alla firma di accesso condiviso.

resourceTypes

string

Specifica i tipi di risorsa associati alla firma di accesso condiviso.

options
ServiceGenerateAccountSasUrlOptions

Parametri facoltativi.

Restituisce

string

URI di firma di accesso condiviso dell'account costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponibile solo per QueueServiceClient costruito con credenziali con chiave condivisa.

Genera una stringa per firmare un URI di firma di accesso condiviso (SAS) dell'account in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

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

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

Parametri

expiresOn

Date

Opzionale. Ora in cui la firma di accesso condiviso non è valida. Il valore predefinito è un'ora successiva, se non specificato.

permissions
AccountSASPermissions

Specifica l'elenco di autorizzazioni da associare alla firma di accesso condiviso.

resourceTypes

string

Specifica i tipi di risorsa associati alla firma di accesso condiviso.

options
ServiceGenerateAccountSasUrlOptions

Parametri facoltativi.

Restituisce

string

URI di firma di accesso condiviso dell'account costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

getProperties(ServiceGetPropertiesOptions)

Ottiene le proprietà del servizio di accodamento di un account di archiviazione, incluse le proprietà per le regole di Analisi archiviazione e CORS (condivisione di risorse tra le origini).

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

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

Parametri

options
ServiceGetPropertiesOptions

Opzioni per ottenere l'operazione delle proprietà.

Restituisce

Promise<ServiceGetPropertiesResponse>

Dati di risposta che includono le proprietà del servizio di accodamento.

getQueueClient(string)

Crea un oggetto QueueClient.

function getQueueClient(queueName: string): QueueClient

Parametri

queueName

string

Restituisce

QueueClient

un nuovo QueueClient

Esempio di utilizzo:

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

getStatistics(ServiceGetStatisticsOptions)

Recupera le statistiche correlate alla replica per il servizio di accodamento. È disponibile solo nell'endpoint della posizione secondaria quando la replica con ridondanza geografica dell'accesso in lettura è abilitata per l'account di archiviazione.

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

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

Parametri

options
ServiceGetStatisticsOptions

Opzioni per ottenere l'operazione sulle statistiche.

Restituisce

Promise<ServiceGetStatisticsResponse>

Dati di risposta per ottenere statistiche sull'operazione.

listQueues(ServiceListQueuesOptions)

Restituisce un iteratore iteratore asincrono per elencare tutte le code nell'account specificato.

.byPage() restituisce un iteratore iteratore asincrono per elencare le code nelle pagine.

Esempio di utilizzo della sintassi for await:

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

Esempio di utilizzo di 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();
}

Esempio di utilizzo di 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++;
    }
  }
}

Esempio di utilizzo del paging con un marcatore:

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>

Parametri

options
ServiceListQueuesOptions

Opzioni per elencare le operazioni di accodamento.

Restituisce

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

AsyncIterableIterator che supporta il paging.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Imposta le proprietà per l'endpoint del servizio di accodamento di un account di archiviazione, incluse le proprietà per Analisi archiviazione, le regole CORS (Condivisione risorse tra le origini) e le impostazioni di eliminazione temporanea.

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

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

Parametri

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

Opzioni per impostare l'operazione delle proprietà.

Restituisce

Promise<ServiceSetPropertiesResponse>

Dati di risposta per l'operazione Imposta proprietà.