Partager via

QueueClient class

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

Un QueueClient représente une URL vers les messages d’une file d’attente de stockage Azure qui vous permet de manipuler ses messages.

Extends

StorageClient

Constructeurs

QueueClient(string, Pipeline)

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

Crée une instance de QueueClient.
QueueClient(string, string, StoragePipelineOptions)

Crée une instance de QueueClient.

Propriétés

name

Nom de la file d'attente.

Propriétés héritées

accountName
url

Valeur de chaîne d’URL.

Méthodes

clearMessages(QueueClearMessagesOptions)

Effacer supprime tous les messages d’une file d’attente.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages
create(QueueCreateOptions)

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

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

Crée une file d’attente sous le compte spécifié s’il n’existe pas déjà. Si la file d’attente existe déjà, elle n’est pas modifiée.

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

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

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

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

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

deleteMessage supprime définitivement le message spécifié de sa file d’attente.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2
exists(QueueExistsOptions)

Retourne true si la file d’attente spécifiée existe ; false dans le cas contraire.

REMARQUE : utilisez cette fonction avec soin, car une file d’attente existante peut être supprimée par d’autres clients ou applications. Inversement, de nouvelles files d’attente peuvent être ajoutées par d’autres clients ou applications une fois cette fonction terminée.
generateSasUrl(QueueGenerateSasUrlOptions)

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

Génère un URI de signature d’accès partagé (SAS) de service en fonction des propriétés et paramètres du client transmis. La signature SAS est signée par les informations d’identification de clé partagée du client.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(QueueGetAccessPolicyOptions)

Obtient des détails sur les stratégies d’accès stockées spécifiées dans la file d’attente qui peuvent être utilisées avec les signatures d’accès partagé.

AVERTISSEMENT : JavaScript Date risque de perdre la précision lors de l’analyse des chaînes de début et d’expiration. Par exemple, new Date(« 2018-12-31T03:44:23.8827891Z »). toISOString() obtient « 2018-12-31T03:44:23.882Z ».

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl
getProperties(QueueGetPropertiesOptions)

Obtient toutes les métadonnées et propriétés système définies par l’utilisateur pour la file d’attente spécifiée. Les métadonnées sont associées à la file d'attente en tant que paires nom-valeur.

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

AVERTISSEMENT : L’objet metadata retourné dans la réponse aura ses clés en minuscules, même si elles contenaient à l’origine des caractères majuscules. Cela diffère des clés de métadonnées retournées par la listQueues méthode de QueueServiceClient à l’aide de l’option includeMetadata , qui conserve leur casse d’origine.
peekMessages(QueuePeekMessagesOptions)

peekMessages récupère un ou plusieurs messages à l’avant de la file d’attente, mais ne modifie pas la visibilité du message.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages
receiveMessages(QueueReceiveMessageOptions)

receiveMessages récupère un ou plusieurs messages à l’avant de la file d’attente.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages
sendMessage(string, QueueSendMessageOptions)

sendMessage ajoute un nouveau message à l’arrière d’une file d’attente. Le délai d’expiration de visibilité spécifie la durée pendant laquelle le message doit être invisible pour les opérations Dequeue et Peek. Le contenu du message a une taille maximale de 64 Ko et doit être dans un format qui peut être inclus dans une requête XML avec encodage UTF-8. Pour inclure un balisage dans le message, le contenu du message doit être placé dans une séquence d'échappement XML ou encodé au format Base64.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/put-message
setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Définit les stratégies d'accès stockées pour la file qui peuvent être utilisées avec des signatures d'accès partagé.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
setMetadata(Metadata, QueueSetMetadataOptions)

Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour la file d’attente spécifiée.

Si aucune option n’est fournie ou si aucune métadonnées n’est définie dans le paramètre d’option, les métadonnées de file d’attente sont supprimées.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata
updateMessage(string, string, string, number, QueueUpdateMessageOptions)

La mise à jour modifie le délai d’expiration et le contenu de la visibilité d’un message. Le contenu du message est d’une taille maximale de 64 Ko et doit être dans un format qui peut être inclus dans une requête XML avec un encodage UTF-8. Pour inclure un balisage dans le message, le contenu du message doit être placé dans une séquence d'échappement XML ou encodé au format Base64.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/update-message

Détails du constructeur

QueueClient(string, Pipeline)

Crée une instance de QueueClient.

new QueueClient(url: string, pipeline: Pipeline)

Paramètres

url

string

Chaîne d’URL pointant vers la file d’attente stockage Azure, telle que «https://myaccount.queue.core.windows.net/myqueue" ; ». Vous pouvez ajouter une signature d’accès partagé si vous utilisez AnonymousCredential, par exemple «https://myaccount.queue.core.windows.net/myqueue?sasString" ; ».

pipeline
Pipeline

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

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

Crée une instance de QueueClient.

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

Paramètres

url

string

Chaîne d’URL pointant vers la file d’attente stockage Azure, telle que «https://myaccount.queue.core.windows.net/myqueue" ; ». Vous pouvez ajouter une signature d’accès partagé si vous utilisez AnonymousCredential, par exemple «https://myaccount.queue.core.windows.net/myqueue?sasString" ; ».

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Par exemple, AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du @azure/identity package pour authentifier les demandes adressées au service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. S’il n’est pas spécifié, AnonymousCredential est utilisé.

options
StoragePipelineOptions

Options pour configurer le pipeline HTTP.

QueueClient(string, string, StoragePipelineOptions)

Crée une instance de QueueClient.

new QueueClient(connectionString: string, queueName: string, options?: StoragePipelineOptions)

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 -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemple de chaîne de connexion SAS - 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

queueName

string

Nom de la file d’attente.

options
StoragePipelineOptions

Options pour configurer le pipeline HTTP.

Détails de la propriété

name

Nom de la file d'attente.

string name

Valeur de propriété

string

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

accountName 

accountName: string

Valeur de propriété

string

Hérité de StorageClient.accountName

url

Valeur de chaîne d’URL.

url: string

Valeur de propriété

string

Hérité de StorageClient.url

Détails de la méthode

clearMessages(QueueClearMessagesOptions)

Effacer supprime tous les messages d’une file d’attente.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages

function clearMessages(options?: QueueClearMessagesOptions): Promise<MessagesClearResponse>

Paramètres

options
QueueClearMessagesOptions

Options permettant d’effacer l’opération de messages.

Retours

Promise<MessagesClearResponse>

Données de réponse pour l’opération effacer les messages.

create(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 create(options?: QueueCreateOptions): Promise<QueueCreateResponse>

Paramètres

options
QueueCreateOptions

Options de l’opération 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.

Exemple d’utilisation :

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

createIfNotExists(QueueCreateOptions)

Crée une file d’attente sous le compte spécifié s’il n’existe pas déjà. Si la file d’attente existe déjà, elle n’est pas modifiée.

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

function createIfNotExists(options?: QueueCreateOptions): Promise<QueueCreateIfNotExistsResponse>

Paramètres

options
QueueCreateOptions

Retours

Promise<QueueCreateIfNotExistsResponse>

delete(QueueDeleteOptions)

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

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

function delete(options?: QueueDeleteOptions): Promise<QueueDeleteResponse>

Paramètres

options
QueueDeleteOptions

Options de l’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.

Exemple d’utilisation :

const deleteQueueResponse = await queueClient.delete();
console.log(
  "Delete queue successfully, service assigned request Id:", deleteQueueResponse.requestId
);

deleteIfExists(QueueDeleteOptions)

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

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

function deleteIfExists(options?: QueueDeleteOptions): Promise<QueueDeleteIfExistsResponse>

Paramètres

options
QueueDeleteOptions

Retours

Promise<QueueDeleteIfExistsResponse>

deleteMessage(string, string, QueueDeleteMessageOptions)

deleteMessage supprime définitivement le message spécifié de sa file d’attente.

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

function deleteMessage(messageId: string, popReceipt: string, options?: QueueDeleteMessageOptions): Promise<MessageIdDeleteResponse>

Paramètres

messageId

string

ID du message.

popReceipt

string

Valeur de réception contextuelle valide retournée par un appel antérieur à l’opération de réception ou de mise à jour du message.

options
QueueDeleteMessageOptions

Options pour supprimer l’opération de message.

Retours

Promise<MessageIdDeleteResponse>

Données de réponse pour l’opération de suppression de message.

exists(QueueExistsOptions)

Retourne true si la file d’attente spécifiée existe ; false dans le cas contraire.

REMARQUE : utilisez cette fonction avec soin, car une file d’attente existante peut être supprimée par d’autres clients ou applications. Inversement, de nouvelles files d’attente peuvent être ajoutées par d’autres clients ou applications une fois cette fonction terminée.

function exists(options?: QueueExistsOptions): Promise<boolean>

Paramètres

options
QueueExistsOptions

options de l’opération Exists.

Retours

Promise<boolean>

generateSasUrl(QueueGenerateSasUrlOptions)

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

Génère un URI de signature d’accès partagé (SAS) de service en fonction des propriétés et paramètres du client transmis. La signature SAS est signée par les informations d’identification de clé partagée du client.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: QueueGenerateSasUrlOptions): string

Paramètres

options
QueueGenerateSasUrlOptions

Paramètres facultatifs.

Retours

string

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

getAccessPolicy(QueueGetAccessPolicyOptions)

Obtient des détails sur les stratégies d’accès stockées spécifiées dans la file d’attente qui peuvent être utilisées avec les signatures d’accès partagé.

AVERTISSEMENT : JavaScript Date risque de perdre la précision lors de l’analyse des chaînes de début et d’expiration. Par exemple, new Date(« 2018-12-31T03:44:23.8827891Z »). toISOString() obtient « 2018-12-31T03:44:23.882Z ».

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

function getAccessPolicy(options?: QueueGetAccessPolicyOptions): Promise<QueueGetAccessPolicyResponse>

Paramètres

options
QueueGetAccessPolicyOptions

Options pour mettre en file d’attente l’opération de stratégie d’obtention d’accès.

Retours

Promise<QueueGetAccessPolicyResponse>

Données de réponse pour l’opération de stratégie d’obtention d’accès en file d’attente.

getProperties(QueueGetPropertiesOptions)

Obtient toutes les métadonnées et propriétés système définies par l’utilisateur pour la file d’attente spécifiée. Les métadonnées sont associées à la file d'attente en tant que paires nom-valeur.

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

AVERTISSEMENT : L’objet metadata retourné dans la réponse aura ses clés en minuscules, même si elles contenaient à l’origine des caractères majuscules. Cela diffère des clés de métadonnées retournées par la listQueues méthode de QueueServiceClient à l’aide de l’option includeMetadata , qui conserve leur casse d’origine.

function getProperties(options?: QueueGetPropertiesOptions): Promise<QueueGetPropertiesResponse>

Paramètres

options
QueueGetPropertiesOptions

Options pour mettre en file d’attente l’opération d’obtention des propriétés.

Retours

Promise<QueueGetPropertiesResponse>

Données de réponse pour l’opération d’obtention des propriétés de la file d’attente.

peekMessages(QueuePeekMessagesOptions)

peekMessages récupère un ou plusieurs messages à l’avant de la file d’attente, mais ne modifie pas la visibilité du message.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages

function peekMessages(options?: QueuePeekMessagesOptions): Promise<QueuePeekMessagesResponse>

Paramètres

options
QueuePeekMessagesOptions

Options permettant de jeter un coup d’œil à l’opération de messages.

Retours

Promise<QueuePeekMessagesResponse>

Données de réponse pour l’opération de aperçu des messages.

Exemple d’utilisation :

const peekMessagesResponse = await queueClient.peekMessages();
console.log("The peeked message is:", peekMessagesResponse.peekedMessageItems[0].messageText);

receiveMessages(QueueReceiveMessageOptions)

receiveMessages récupère un ou plusieurs messages à l’avant de la file d’attente.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages

function receiveMessages(options?: QueueReceiveMessageOptions): Promise<QueueReceiveMessageResponse>

Paramètres

options
QueueReceiveMessageOptions

Options d’opération de réception des messages.

Retours

Promise<QueueReceiveMessageResponse>

Données de réponse pour l’opération de réception des messages.

Exemple d’utilisation :

const response = await queueClient.receiveMessages();
if (response.receivedMessageItems.length == 1) {
  const receivedMessageItem = response.receivedMessageItems[0];
  console.log("Processing & deleting message with content:", receivedMessageItem.messageText);
  const deleteMessageResponse = await queueClient.deleteMessage(
    receivedMessageItem.messageId,
    receivedMessageItem.popReceipt
  );
  console.log(
    "Delete message successfully, service assigned request Id:",
    deleteMessageResponse.requestId
  );
}

sendMessage(string, QueueSendMessageOptions)

sendMessage ajoute un nouveau message à l’arrière d’une file d’attente. Le délai d’expiration de visibilité spécifie la durée pendant laquelle le message doit être invisible pour les opérations Dequeue et Peek. Le contenu du message a une taille maximale de 64 Ko et doit être dans un format qui peut être inclus dans une requête XML avec encodage UTF-8. Pour inclure un balisage dans le message, le contenu du message doit être placé dans une séquence d'échappement XML ou encodé au format Base64.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/put-message

function sendMessage(messageText: string, options?: QueueSendMessageOptions): Promise<QueueSendMessageResponse>

Paramètres

messageText

string

Texte du message à envoyer

options
QueueSendMessageOptions

Options pour l’opération d’envoi de messages.

Retours

Promise<QueueSendMessageResponse>

Données de réponse pour l’opération d’envoi de messages.

Exemple d’utilisation :

const sendMessageResponse = await queueClient.sendMessage("Hello World!");
console.log(
  "Sent message successfully, service assigned message Id:", sendMessageResponse.messageId,
  "service assigned request Id:", sendMessageResponse.requestId
);

setAccessPolicy(SignedIdentifier[], QueueSetAccessPolicyOptions)

Définit les stratégies d'accès stockées pour la file qui peuvent être utilisées avec des signatures d'accès partagé.

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

function setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions): Promise<QueueSetAccessPolicyResponse>

Paramètres

queueAcl

SignedIdentifier[]

options
QueueSetAccessPolicyOptions

Options de l’opération de stratégie d’accès de jeu de files d’attente.

Retours

Promise<QueueSetAccessPolicyResponse>

Données de réponse pour l’opération de stratégie d’accès au jeu de files d’attente.

setMetadata(Metadata, QueueSetMetadataOptions)

Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour la file d’attente spécifiée.

Si aucune option n’est fournie ou si aucune métadonnées n’est définie dans le paramètre d’option, les métadonnées de file d’attente sont supprimées.

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

function setMetadata(metadata?: Metadata, options?: QueueSetMetadataOptions): Promise<QueueSetMetadataResponse>

Paramètres

metadata
Metadata

Si aucune métadonnées n’est fournie, toutes les métadonnées existantes sont supprimées.

options
QueueSetMetadataOptions

Options de l’opération de métadonnées de jeu de files d’attente.

Retours

Promise<QueueSetMetadataResponse>

Données de réponse pour l’opération de métadonnées du jeu de files d’attente.

updateMessage(string, string, string, number, QueueUpdateMessageOptions)

La mise à jour modifie le délai d’expiration et le contenu de la visibilité d’un message. Le contenu du message est d’une taille maximale de 64 Ko et doit être dans un format qui peut être inclus dans une requête XML avec un encodage UTF-8. Pour inclure un balisage dans le message, le contenu du message doit être placé dans une séquence d'échappement XML ou encodé au format Base64.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/update-message

function updateMessage(messageId: string, popReceipt: string, message?: string, visibilityTimeout?: number, options?: QueueUpdateMessageOptions): Promise<MessageIdUpdateResponse>

Paramètres

messageId

string

Identifiant du message

popReceipt

string

Valeur de réception contextuelle valide retournée à partir d’un appel antérieur à l’opération de réception de messages ou de mise à jour du message.

message

string

Message à mettre à jour. Si ce paramètre n’est pas défini, le contenu du message n’est pas mis à jour.

visibilityTimeout

number

Spécifie la nouvelle valeur du délai de visibilité, en secondes, par rapport au temps serveur. La nouvelle valeur doit être supérieure ou égale à 0 et ne peut pas être supérieure à 7 jours. Le délai d'expiration de la visibilité d'un message ne peut pas être défini à une valeur ultérieure au délai d'expiration. Un message peut être mis à jour tant qu'il n'a pas été supprimé ou qu'il n'a pas expiré.

options
QueueUpdateMessageOptions

Options permettant de mettre à jour l’opération de message.

Retours

Promise<MessageIdUpdateResponse>

Données de réponse pour l’opération de mise à jour du message.