QueueClient Classe

Définition

Espace de noms:

Azure.Storage.Queues

Assembly:

Azure.Storage.Queues.dll

Paquet:

Azure.Storage.Queues v12.17.1

Source:

QueueClient.cs

Un QueueClient représente un URI du service File d’attente de stockage Azure qui vous permet de manipuler une file d’attente.

public class QueueClient

type QueueClient = class

Public Class QueueClient

Héritage

Object

QueueClient

Constructeurs

QueueClient()	Initialise une nouvelle instance de la QueueClient classe pour les moqueries.
QueueClient(String, String)	Initialise une nouvelle instance de la classe QueueClient.
QueueClient(String, String, QueueClientOptions)	Initialise une nouvelle instance de la classe QueueClient.
QueueClient(Uri, AzureSasCredential, QueueClientOptions)	Initialise une nouvelle instance de la classe QueueClient.
QueueClient(Uri, QueueClientOptions)	Initialise une nouvelle instance de la classe QueueClient.
QueueClient(Uri, StorageSharedKeyCredential, QueueClientOptions)	Initialise une nouvelle instance de la classe QueueClient.
QueueClient(Uri, TokenCredential, QueueClientOptions)	Initialise une nouvelle instance de la classe QueueClient.

Propriétés

AccountName	Obtient le nom du compte de stockage correspondant au client de file d’attente.
CanGenerateSasUri	Détermine si le client est en mesure de générer une sap. Si le client est authentifié avec un StorageSharedKeyCredential.
MaxPeekableMessages	QueueMaxMessagesPeek indique le nombre maximal de messages que vous pouvez récupérer à chaque appel à Peek.
MessageMaxBytes	Obtient le nombre maximal d’octets autorisés pour le texte UTF-8 d’un message.
MessagesUri	Obtient le point de terminaison URI utilisé par les messages de l’objet.
Name	Obtient le nom de la file d'attente.
Uri	Obtient le point de terminaison URI utilisé par l’objet .

Méthodes

ClearMessages(CancellationToken)	Supprime tous les messages d’une file d’attente. Pour plus d'informations, consultez la rubrique Effacer les messages.
ClearMessagesAsync(CancellationToken)	Supprime tous les messages d’une file d’attente. Pour plus d'informations, consultez la rubrique Effacer les messages.
Create(IDictionary<String,String>, CancellationToken)	Crée une file d’attente. Pour plus d'informations, consultez la rubrique Créer une file d’attente.
CreateAsync(IDictionary<String,String>, CancellationToken)	Crée une file d’attente. Pour plus d'informations, consultez la rubrique Créer une file d’attente.
CreateIfNotExists(IDictionary<String,String>, CancellationToken)	L’opération CreateIfNotExists(IDictionary<String,String>, CancellationToken) crée une file d’attente sous le compte spécifié. Si la file d’attente existe déjà, elle n’est pas modifiée. Pour plus d'informations, consultez la rubrique Créer une file d’attente.
CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken)	L’opération CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken) crée une file d’attente sous le compte spécifié. Si la file d’attente existe déjà, elle n’est pas modifiée. Pour plus d'informations, consultez la rubrique Créer une file d’attente.
Delete(CancellationToken)	Supprime une file d'attente. Pour plus d'informations, consultez la rubrique Supprimer la file d’attente.
DeleteAsync(CancellationToken)	Supprime une file d'attente. Pour plus d'informations, consultez la rubrique Supprimer la file d’attente.
DeleteIfExists(CancellationToken)	L’opération DeleteIfExists(CancellationToken) supprime la file d’attente spécifiée si elle existe. Pour plus d'informations, consultez la rubrique Supprimer la file d’attente.
DeleteIfExistsAsync(CancellationToken)	L’opération DeleteIfExistsAsync(CancellationToken) supprime la file d’attente spécifiée si elle existe. Pour plus d'informations, consultez la rubrique Supprimer la file d’attente.
DeleteMessage(String, String, CancellationToken)	Supprime définitivement le message spécifié de sa file d’attente. Pour plus d'informations, consultez la rubrique Supprimer le message.
DeleteMessageAsync(String, String, CancellationToken)	Supprime définitivement le message spécifié de sa file d’attente. Pour plus d'informations, consultez la rubrique Supprimer le message.
Exists(CancellationToken)	L’opération Exists(CancellationToken) peut être appelée sur un QueueClient pour voir si la file d’attente associée existe sur le compte de stockage dans le service de stockage.
ExistsAsync(CancellationToken)	L’opération ExistsAsync(CancellationToken) peut être appelée sur un QueueClient pour voir si la file d’attente associée existe sur le compte de stockage dans le service de stockage.
GenerateSasUri(QueueSasBuilder)	GenerateSasUri(QueueSasBuilder) retourne un Uri qui génère un URI SAS du service de file d’attente en fonction des propriétés du client et du générateur transmis. Pour plus d'informations, consultez la rubrique Construction d’une sap de service
GenerateSasUri(QueueSasPermissions, DateTimeOffset)	Retourne GenerateSasUri(QueueSasPermissions, DateTimeOffset) un Uri qui génère un URI de signature d’accès partagé (SAS) du service de file d’attente en fonction des propriétés et paramètres du client passés. Pour plus d'informations, consultez la rubrique Construction d’une SAP de service.
GetAccessPolicy(CancellationToken)	Retourne 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é. Pour plus d'informations, consultez la rubrique Obtenir la liste de contrôle d’accès de file d’attente.
GetAccessPolicyAsync(CancellationToken)	Retourne 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é. Pour plus d'informations, consultez la rubrique Obtenir la liste de contrôle d’accès de file d’attente.
GetParentQueueServiceClientCore()	Créez un QueueServiceClient qui pointe vers ce QueueClientservice de file d’attente. Le nouveau QueueServiceClient utilise le même pipeline de stratégie de requête que le QueueClient.
GetProperties(CancellationToken)	Récupère les propriétés de file d’attente et les métadonnées et propriétés définies par l’utilisateur sur la file d’attente spécifiée. Les métadonnées sont associées à la file d'attente en tant que paires nom-valeur. Pour plus d'informations, consultez la rubrique Obtenir les métadonnées de file d’attente.
GetPropertiesAsync(CancellationToken)	Récupère les propriétés de file d’attente et les métadonnées et propriétés définies par l’utilisateur sur la file d’attente spécifiée. Les métadonnées sont associées à la file d'attente en tant que paires nom-valeur. Pour plus d'informations, consultez la rubrique Obtenir les métadonnées de file d’attente.
OnMessageDecodingFailedAsync(QueueMessage, PeekedMessage, Boolean, CancellationToken)	Déclenche un MessageDecodingFailed événement.
PeekMessage(CancellationToken)	Récupère un message à l’avant de la file d’attente, mais ne modifie pas la visibilité du message. Pour plus d'informations, consultez la rubrique Jeter un coup d’œil aux messages.
PeekMessageAsync(CancellationToken)	Récupère un message à l’avant de la file d’attente, mais ne modifie pas la visibilité du message. Pour plus d'informations, consultez la rubrique Jeter un coup d’œil aux messages.
PeekMessages(Nullable<Int32>, CancellationToken)	Récupère un ou plusieurs messages à l’avant de la file d’attente, mais ne modifie pas la visibilité du message. Pour plus d'informations, consultez la rubrique Jeter un coup d’œil aux messages.
PeekMessagesAsync(Nullable<Int32>, CancellationToken)	Récupère un ou plusieurs messages à l’avant de la file d’attente, mais ne modifie pas la visibilité du message. Pour plus d'informations, consultez la rubrique Jeter un coup d’œil aux messages.
ReceiveMessage(Nullable<TimeSpan>, CancellationToken)	Reçoit un message à l’avant de la file d’attente. Pour plus d'informations, consultez la rubrique Obtenir des messages.
ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)	Récupère un message à l’avant de la file d’attente. Pour plus d'informations, consultez la rubrique Obtenir des messages.
ReceiveMessages()	Reçoit un ou plusieurs messages à partir de l’avant de la file d’attente. Pour plus d'informations, consultez la rubrique Obtenir des messages.
ReceiveMessages(CancellationToken)	Reçoit un ou plusieurs messages à partir de l’avant de la file d’attente. Pour plus d'informations, consultez la rubrique Obtenir des messages.
ReceiveMessages(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Reçoit un ou plusieurs messages à partir de l’avant de la file d’attente. Pour plus d'informations, consultez la rubrique Obtenir des messages.
ReceiveMessagesAsync()	Récupère un ou plusieurs messages à l’avant de la file d’attente. Pour plus d'informations, consultez la rubrique Obtenir des messages.
ReceiveMessagesAsync(CancellationToken)	Récupère un ou plusieurs messages à l’avant de la file d’attente. Pour plus d'informations, consultez la rubrique Obtenir des messages.
ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Récupère un ou plusieurs messages à l’avant de la file d’attente. Pour plus d'informations, consultez la rubrique Obtenir des messages.
SendMessage(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	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. Un message doit être dans un format qui peut être inclus dans une demande XML en UTF-8. Sinon, MessageEncoding l’option peut être définie sur Base64 pour gérer les messages non conformes. Le message encodé peut atteindre 64 Kio pour les versions 2011-08-18 et ultérieures, ou 8 Kio pour les versions précédentes. Pour plus d'informations, consultez la rubrique Placez le message.
SendMessage(String)	Ajoute un nouveau message à l’arrière d’une file d’attente. Un message doit être dans un format qui peut être inclus dans une demande XML en UTF-8. Sinon, MessageEncoding l’option peut être définie sur Base64 pour gérer les messages non conformes. Le message encodé peut atteindre 64 Kio pour les versions 2011-08-18 et ultérieures, ou 8 Kio pour les versions précédentes. Pour plus d'informations, consultez la rubrique Placez le message.
SendMessage(String, CancellationToken)	Ajoute un nouveau message à l’arrière d’une file d’attente. Un message doit être dans un format qui peut être inclus dans une demande XML en UTF-8. Sinon, MessageEncoding l’option peut être définie sur Base64 pour gérer les messages non conformes. Le message encodé peut atteindre 64 Kio pour les versions 2011-08-18 et ultérieures, ou 8 Kio pour les versions précédentes. Pour plus d'informations, consultez la rubrique Placez le message.
SendMessage(String, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	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. Un message doit être dans un format qui peut être inclus dans une demande XML en UTF-8. Sinon, MessageEncoding l’option peut être définie sur Base64 pour gérer les messages non conformes. Le message encodé peut atteindre 64 Kio pour les versions 2011-08-18 et ultérieures, ou 8 Kio pour les versions précédentes. Pour plus d'informations, consultez la rubrique Placez le message.
SendMessageAsync(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	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. Un message doit être dans un format qui peut être inclus dans une demande XML en UTF-8. Sinon, MessageEncoding l’option peut être définie sur Base64 pour gérer les messages non conformes. Le message encodé peut atteindre 64 Kio pour les versions 2011-08-18 et ultérieures, ou 8 Kio pour les versions précédentes. Pour plus d'informations, consultez la rubrique Placez le message.
SendMessageAsync(String)	Ajoute un nouveau message à l’arrière d’une file d’attente. Un message doit être dans un format qui peut être inclus dans une demande XML en UTF-8. Sinon, MessageEncoding l’option peut être définie sur Base64 pour gérer les messages non conformes. Le message encodé peut atteindre 64 Kio pour les versions 2011-08-18 et ultérieures, ou 8 Kio pour les versions précédentes. Pour plus d'informations, consultez la rubrique Placez le message.
SendMessageAsync(String, CancellationToken)	Ajoute un nouveau message à l’arrière d’une file d’attente. Un message doit être dans un format qui peut être inclus dans une demande XML en UTF-8. Sinon, MessageEncoding l’option peut être définie sur Base64 pour gérer les messages non conformes. Le message encodé peut atteindre 64 Kio pour les versions 2011-08-18 et ultérieures, ou 8 Kio pour les versions précédentes. Pour plus d'informations, consultez la rubrique Placez le message.
SendMessageAsync(String, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	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. Un message doit être dans un format qui peut être inclus dans une demande XML en UTF-8. Sinon, MessageEncoding l’option peut être définie sur Base64 pour gérer les messages non conformes. Le message encodé peut atteindre 64 Kio pour les versions 2011-08-18 et ultérieures, ou 8 Kio pour les versions précédentes. Pour plus d'informations, consultez la rubrique Placez le message.
SetAccessPolicy(IEnumerable<QueueSignedIdentifier>, CancellationToken)	SetAccessPolicyAsync définit des stratégies d’accès stockées pour la file d’attente qui peuvent être utilisées avec les signatures d’accès partagé. Pour plus d'informations, consultez la rubrique Définissez la liste de contrôle d’accès de file d’attente.
SetAccessPolicyAsync(IEnumerable<QueueSignedIdentifier>, CancellationToken)	SetAccessPolicyAsync définit des stratégies d’accès stockées pour la file d’attente qui peuvent être utilisées avec les signatures d’accès partagé. Pour plus d'informations, consultez la rubrique Définissez la liste de contrôle d’accès de file d’attente.
SetMetadata(IDictionary<String,String>, CancellationToken)	Définit les métadonnées définies par l’utilisateur sur la file d’attente spécifiée. Les métadonnées sont associées à la file d'attente en tant que paires nom-valeur. Pour plus d'informations, consultez la rubrique Définissez les métadonnées de file d’attente.
SetMetadataAsync(IDictionary<String,String>, CancellationToken)	Définit les métadonnées définies par l’utilisateur sur la file d’attente spécifiée. Les métadonnées sont associées à la file d'attente en tant que paires nom-valeur. Pour plus d'informations, consultez la rubrique Définissez les métadonnées de file d’attente.
UpdateMessage(String, String, BinaryData, TimeSpan, CancellationToken)	Modifie le délai d’attente et le contenu d’un message. Un message doit être dans un format qui peut être inclus dans une demande XML en UTF-8. Sinon, MessageEncoding l’option peut être définie sur Base64 pour gérer les messages non conformes. Le message encodé peut atteindre 64 Kio pour les versions 2011-08-18 et ultérieures, ou 8 Kio pour les versions précédentes. Pour plus d'informations, consultez la rubrique Mettre à jour le message.
UpdateMessage(String, String, String, TimeSpan, CancellationToken)	Modifie le délai d’attente et le contenu d’un message. Un message doit être dans un format qui peut être inclus dans une demande XML en UTF-8. Sinon, MessageEncoding l’option peut être définie sur Base64 pour gérer les messages non conformes. Le message encodé peut atteindre 64 Kio pour les versions 2011-08-18 et ultérieures, ou 8 Kio pour les versions précédentes. Pour plus d'informations, consultez la rubrique Mettre à jour le message.
UpdateMessageAsync(String, String, BinaryData, TimeSpan, CancellationToken)	Modifie le délai d’attente et le contenu d’un message. Un message doit être dans un format qui peut être inclus dans une demande XML en UTF-8. Sinon, MessageEncoding l’option peut être définie sur Base64 pour gérer les messages non conformes. Le message encodé peut atteindre 64 Kio pour les versions 2011-08-18 et ultérieures, ou 8 Kio pour les versions précédentes. Pour plus d'informations, consultez la rubrique Mettre à jour le message.
UpdateMessageAsync(String, String, String, TimeSpan, CancellationToken)	Modifie le délai d’attente et le contenu d’un message. Un message doit être dans un format qui peut être inclus dans une demande XML en UTF-8. Sinon, MessageEncoding l’option peut être définie sur Base64 pour gérer les messages non conformes. Le message encodé peut atteindre 64 Kio pour les versions 2011-08-18 et ultérieures, ou 8 Kio pour les versions précédentes. Pour plus d'informations, consultez la rubrique Mettre à jour le message.
WithClientSideEncryptionOptionsCore(ClientSideEncryptionOptions)	Crée un instance de la QueueClient classe, en conservant tous les mêmes éléments internes, mais en spécifiant de nouveaux ClientSideEncryptionOptions.

Méthodes d’extension

GetParentQueueServiceClient(QueueClient)	Créez un QueueServiceClient qui pointe vers ce QueueClientservice de file d’attente. Le nouveau QueueServiceClient utilise le même pipeline de stratégie de requête que le QueueClient.
WithClientSideEncryptionOptions(QueueClient, ClientSideEncryptionOptions)	Crée un instance de la QueueClient classe, en conservant tous les mêmes éléments internes, mais en spécifiant de nouveaux ClientSideEncryptionOptions.