Partager via

QueueServiceClient class

  • Référence
Paquet:
@azure/storage-queue

Un QueueServiceClient représente une URL vers le service File d’attente stockage Azure, ce qui vous permet de manipuler des files d’attente.

Extends

StorageClient

Constructeurs

QueueServiceClient(string, Pipeline)

Crée une instance de QueueServiceClient.
QueueServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crée une instance de QueueServiceClient.

Propriétés héritées

accountName
url

Valeur de chaîne d’URL.

Méthodes

createQueue(string, QueueCreateOptions)

Crée une file d’attente sous le compte spécifié.

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

Supprime définitivement la file d’attente spécifiée.

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

Crée une instance de QueueServiceClient.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponible uniquement pour QueueServiceClient construit avec des informations d’identification de clé partagée.

Génère un URI de signature d’accès partagé (SAP) de compte basé sur les propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

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

Disponible uniquement pour QueueServiceClient construit avec des informations d’identification de clé partagée.

Génère une chaîne pour signer un URI de signature d’accès partagé (SAP) de compte en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

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

Obtient les propriétés du service file d’attente d’un compte de stockage, y compris les propriétés des règles d’analyse de stockage et cors (partage de ressources cross-origin).

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

Crée un objet QueueClient.
getStatistics(ServiceGetStatisticsOptions)

Récupère les statistiques relatives à la réplication pour le service file d’attente. Il est disponible uniquement sur le point de terminaison d’emplacement secondaire lorsque la réplication géoredondante avec accès en lecture est activée pour le compte de stockage.

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

Retourne un itérateur itérable asynchrone pour répertorier toutes les files d’attente sous le compte spécifié.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les files d’attente dans les pages.

Exemple utilisant for await syntaxe :

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

Exemple utilisant 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();
}

Exemple utilisant 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++;
    }
  }
}

Exemple d’utilisation de la pagination avec un marqueur :

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)

Définit les propriétés du point de terminaison du service file d’attente d’un compte de stockage, y compris les propriétés des règles Storage Analytics, CORS (partage de ressources cross-origin) et les paramètres de suppression réversible.

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

Détails du constructeur

QueueServiceClient(string, Pipeline)

Crée une instance de QueueServiceClient.

new QueueServiceClient(url: string, pipeline: Pipeline)

Paramètres

url

string

Chaîne d’URL pointant vers le service de file d’attente stockage Azure, telle que «https://myaccount.queue.core.windows.net". Vous pouvez ajouter une SAP si vous utilisez AnonymousCredential, par exemple «https://myaccount.queue.core.windows.net?sasString".

pipeline
Pipeline

Appelez newPipeline() pour créer un pipeline par défaut ou fournissez un pipeline personnalisé.

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

Crée une instance de QueueServiceClient.

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

Paramètres

url

string

Chaîne d’URL pointant vers le service de file d’attente stockage Azure, telle que «https://myaccount.queue.core.windows.net". Vous pouvez ajouter une SAP si vous utilisez AnonymousCredential, par exemple «https://myaccount.queue.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package @azure/identity pour authentifier les demandes auprès du service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.

options
StoragePipelineOptions

Options de configuration du pipeline HTTP.

Exemple utilisant DefaultAzureCredential à partir de @azure/identity:

const account = "<account>";

const credential = new DefaultAzureCredential();

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

Exemple utilisant un nom/clé de compte :

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

Détails de la propriété héritée

accountName 

accountName: string

Valeur de propriété

string

héritée de StorageClient.accountName

url

Valeur de chaîne d’URL.

url: string

Valeur de propriété

string

héritée de StorageClient.url

Détails de la méthode

createQueue(string, QueueCreateOptions)

Crée une file d’attente sous le compte spécifié.

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

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

Paramètres

queueName

string

nom de la file d’attente à créer

options
QueueCreateOptions

Options de création de file d’attente.

Retours

Promise<QueueCreateResponse>

Données de réponse pour l’opération de création de file d’attente.

deleteQueue(string, QueueDeleteOptions)

Supprime définitivement la file d’attente spécifiée.

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

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

Paramètres

queueName

string

nom de la file d’attente à supprimer.

options
QueueDeleteOptions

Options d’opération de suppression de file d’attente.

Retours

Promise<QueueDeleteResponse>

Données de réponse pour l’opération de suppression de file d’attente.

fromConnectionString(string, StoragePipelineOptions)

Crée une instance de QueueServiceClient.

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

Paramètres

connectionString

string

Chaîne de connexion de compte ou chaîne de connexion SAP d’un compte de stockage Azure. [ Remarque : la chaîne de connexion de compte ne peut être utilisée que dans NODE.JS runtime. ] Exemple de chaîne de connexion de compte - exemple de chaîne de connexion 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

Options de configuration du pipeline HTTP.

Retours

QueueServiceClient

Nouvel objet QueueServiceClient à partir de la chaîne de connexion donnée.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponible uniquement pour QueueServiceClient construit avec des informations d’identification de clé partagée.

Génère un URI de signature d’accès partagé (SAP) de compte basé sur les propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

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

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

Paramètres

expiresOn

Date

Optionnel. Heure à laquelle la signature d’accès partagé devient non valide. La valeur par défaut est une heure plus tard si elle n’est pas spécifiée.

permissions
AccountSASPermissions

Spécifie la liste des autorisations à associer à la SAP.

resourceTypes

string

Spécifie les types de ressources associés à la signature d’accès partagé.

options
ServiceGenerateAccountSasUrlOptions

Paramètres facultatifs.

Retours

string

URI SAP de compte constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponible uniquement pour QueueServiceClient construit avec des informations d’identification de clé partagée.

Génère une chaîne pour signer un URI de signature d’accès partagé (SAP) de compte en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

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

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

Paramètres

expiresOn

Date

Optionnel. Heure à laquelle la signature d’accès partagé devient non valide. La valeur par défaut est une heure plus tard si elle n’est pas spécifiée.

permissions
AccountSASPermissions

Spécifie la liste des autorisations à associer à la SAP.

resourceTypes

string

Spécifie les types de ressources associés à la signature d’accès partagé.

options
ServiceGenerateAccountSasUrlOptions

Paramètres facultatifs.

Retours

string

URI SAP de compte constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

getProperties(ServiceGetPropertiesOptions)

Obtient les propriétés du service file d’attente d’un compte de stockage, y compris les propriétés des règles d’analyse de stockage et cors (partage de ressources cross-origin).

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

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

Paramètres

options
ServiceGetPropertiesOptions

Options permettant d’obtenir l’opération de propriétés.

Retours

Promise<ServiceGetPropertiesResponse>

Données de réponse, y compris les propriétés du service de file d’attente.

getQueueClient(string)

Crée un objet QueueClient.

function getQueueClient(queueName: string): QueueClient

Paramètres

queueName

string

Retours

QueueClient

un nouveau QueueClient

Exemple d’utilisation :

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

getStatistics(ServiceGetStatisticsOptions)

Récupère les statistiques relatives à la réplication pour le service file d’attente. Il est disponible uniquement sur le point de terminaison d’emplacement secondaire lorsque la réplication géoredondante avec accès en lecture est activée pour le compte de stockage.

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

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

Paramètres

options
ServiceGetStatisticsOptions

Options pour obtenir l’opération de statistiques.

Retours

Promise<ServiceGetStatisticsResponse>

Données de réponse pour obtenir des statistiques l’opération.

listQueues(ServiceListQueuesOptions)

Retourne un itérateur itérable asynchrone pour répertorier toutes les files d’attente sous le compte spécifié.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les files d’attente dans les pages.

Exemple utilisant for await syntaxe :

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

Exemple utilisant 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();
}

Exemple utilisant 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++;
    }
  }
}

Exemple d’utilisation de la pagination avec un marqueur :

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>

Paramètres

options
ServiceListQueuesOptions

Options permettant de répertorier les opérations de files d’attente.

Retours

PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse, PageSettings>

AsyncIterableIterator qui prend en charge la pagination.

setProperties(QueueServiceProperties, ServiceGetPropertiesOptions)

Définit les propriétés du point de terminaison du service file d’attente d’un compte de stockage, y compris les propriétés des règles Storage Analytics, CORS (partage de ressources cross-origin) et les paramètres de suppression réversible.

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

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

Paramètres

properties
QueueServiceProperties
options
ServiceGetPropertiesOptions

Options permettant de définir l’opération de propriétés.

Retours

Promise<ServiceSetPropertiesResponse>

Données de réponse pour l’opération Définir les propriétés.