SubscriptionClient Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique.
public abstract class SubscriptionClient : Microsoft.ServiceBus.Messaging.MessagingEntityClienttype SubscriptionClient = class
inherit MessagingEntityClientPublic MustInherit Class SubscriptionClient
Inherits MessagingEntityClient- Héritage
Exemples
// Create subscription client
SubscriptionClient mySubscriptionClient =
factory.CreateSubscriptionClient(mySubscription);
// Receive messages
for (int count = 0; count < MsgCount; count++)
{
var message = mySubscriptionClient.Receive();
message.Complete();
}
Propriétés
| IsClosed |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| MessagingFactory |
Obtient la fabrique de messagerie utilisée pour créer ce client d’abonnement. |
| Mode |
Obtient le mode de réception du message lors du traitement du message reçu. |
| Name |
Obtient le nom de l'abonnement. |
| Path |
Obtient le chemin d’accès de la file d’attente, de la rubrique ou de l’abonnement par rapport à l’adresse MessagingFactory de base. (Hérité de MessagingEntityClient) |
| PrefetchCount |
Obtient ou définit le nombre de messages que le destinataire des messages peut demander simultanément. |
| RetryPolicy |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| ThisLock |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| TopicPath |
Obtient le chemin d’accès complet de la rubrique. |
Méthodes
| Abandon(Guid) |
Ignore le message et abandonne la propriété du verrou de message. |
| Abandon(Guid, IDictionary<String,Object>) |
Ignore le message et abandonne la propriété du verrou de message. |
| AbandonAsync(Guid) |
Ignore de manière asynchrone le message et abandonne la propriété du verrou de message. |
| AbandonAsync(Guid, IDictionary<String,Object>) |
Ignore de manière asynchrone le message et abandonne la propriété du verrou de message. |
| Abort() |
Effectue la fonctionnalité d’abandon sur l’entité de messagerie. (Hérité de ClientEntity) |
| AcceptMessageSession() |
Accepte une session de messages qui autorise le regroupement des messages associés pour le traitement dans une seule transaction. |
| AcceptMessageSession(Boolean) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| AcceptMessageSession(Boolean, TimeSpan) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| AcceptMessageSession(String) |
Accepte une session de messages qui autorise le regroupement de messages associés pour le traitement dans une transaction unique à l’aide de l’identificateur de session donné. |
| AcceptMessageSession(String, Boolean) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| AcceptMessageSession(String, Boolean, TimeSpan) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| AcceptMessageSession(String, Guid) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| AcceptMessageSession(String, Guid, TimeSpan) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| AcceptMessageSession(String, TimeSpan) |
Accepte une session de message qui permet le regroupement de messages associés pour le traitement dans une transaction unique à l’aide de l’identificateur de session et du temps d’attente donnés. |
| AcceptMessageSession(TimeSpan) |
Accepte une session de messages qui autorise le regroupement des messages associés pour le traitement dans une transaction unique à l’aide du temps d’attente du serveur spécifié. |
| AcceptMessageSessionAsync() |
Accepte de manière asynchrone une session de messages qui permet de regrouper les messages associés pour le traitement dans une transaction unique à l’aide du temps d’attente du serveur spécifié. |
| AcceptMessageSessionAsync(Boolean) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| AcceptMessageSessionAsync(Boolean, TimeSpan) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| AcceptMessageSessionAsync(String) |
Accepte de manière asynchrone une session de messages qui permet de regrouper les messages associés pour le traitement dans une transaction unique à l’aide du temps d’attente du serveur spécifié. |
| AcceptMessageSessionAsync(String, Boolean) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| AcceptMessageSessionAsync(String, Boolean, TimeSpan) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| AcceptMessageSessionAsync(String, Guid) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| AcceptMessageSessionAsync(String, Guid, TimeSpan) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| AcceptMessageSessionAsync(String, TimeSpan) |
Accepte de manière asynchrone une session de messages qui permet de regrouper les messages associés pour le traitement dans une transaction unique à l’aide du temps d’attente du serveur spécifié. |
| AcceptMessageSessionAsync(TimeSpan) |
Accepte de manière asynchrone une session de messages qui permet de regrouper les messages associés pour le traitement dans une transaction unique à l’aide du temps d’attente du serveur spécifié. |
| AddRule(RuleDescription) |
Ajoute une nouvelle règle au à l’aide de SubscriptionDescription la description de la règle spécifiée. |
| AddRule(String, Filter) |
Ajoute une règle à l’abonnement actuel avec le nom et l’expression de filtre spécifiés. |
| AddRuleAsync(RuleDescription) |
Ajoute de manière asynchrone une nouvelle règle au à l’aide de SubscriptionDescription la description de la règle spécifiée. |
| AddRuleAsync(String, Filter) |
Ajoute de manière asynchrone une règle à l’abonnement actuel avec le nom et l’expression de filtre spécifiés. |
| Close() |
Envoie un message de nettoyage à Service Bus pour signaler la fin de l’utilisation d’une entité. (Hérité de ClientEntity) |
| CloseAsync() |
Envoie un message de nettoyage de manière asynchrone à Service Bus pour signaler la fin de l’utilisation d’une entité. (Hérité de ClientEntity) |
| Complete(Guid) |
Termine le traitement d’un message. |
| CompleteAsync(Guid) |
Termine de manière asynchrone le traitement d’un message. |
| CompleteBatch(IEnumerable<Guid>) |
Termine le traitement d’un lot. |
| CompleteBatchAsync(IEnumerable<Guid>) |
Termine de manière asynchrone le traitement d’un lot. |
| Create(String, String) |
Crée une copie de avec le nom et le chemin de SubscriptionClient la rubrique spécifiés. |
| Create(String, String, ReceiveMode) |
Crée une copie de avec le SubscriptionClient nom, le chemin d’accès de la rubrique et le mode spécifiés. |
| CreateFromConnectionString(String, String, String) |
Crée une copie de à partir d’une chaîne de SubscriptionClient connexion avec le chemin et le nom de la rubrique spécifiés. |
| CreateFromConnectionString(String, String, String, ReceiveMode) |
Crée une copie de à partir d’une chaîne de SubscriptionClient connexion avec le chemin, le nom et le mode de rubrique spécifiés. |
| CreateWithAzureActiveDirectory(Uri, String, String, AzureActiveDirectoryTokenProvider+AuthenticationCallback, String, ReceiveMode, Nullable<TimeSpan>, TransportType) |
Crée un instance du à l’aide du SubscriptionClient rappel d’authentification . |
| CreateWithManagedIdentity(Uri, String, String, ReceiveMode, Nullable<TimeSpan>, TransportType) |
Crée un instance de à l’aide de l’authentification SubscriptionClient Azure Managed Identity. |
| DeadLetter(Guid) |
Déplace le message non remis vers la file d’attente de lettres mortes. |
| DeadLetter(Guid, IDictionary<String,Object>) |
Déplace le message non remis vers la file d’attente de lettres mortes. |
| DeadLetter(Guid, String, String) |
Déplace le message non remis vers la file d’attente de lettres mortes. |
| DeadLetterAsync(Guid) |
Déplace de manière asynchrone le message non remis vers la file d’attente de lettres mortes. |
| DeadLetterAsync(Guid, IDictionary<String,Object>) |
Déplace de manière asynchrone le message non remis vers la file d’attente de lettres mortes. |
| DeadLetterAsync(Guid, String, String) |
Déplace de manière asynchrone le message non remis vers la file d’attente de lettres mortes. |
| Defer(Guid) |
Suspend le traitement d’un message. |
| Defer(Guid, IDictionary<String,Object>) |
Suspend le traitement d’un message. |
| DeferAsync(Guid) |
Interrompt de façon asynchrone le traitement d’un message. |
| DeferAsync(Guid, IDictionary<String,Object>) |
Interrompt de façon asynchrone le traitement d’un message. |
| Fault() |
À usage interne uniquement. N’héritez pas de cette classe. (Hérité de ClientEntity) |
| FormatDeadLetterPath(String, String) |
Génère un chemin d’accès mort de nom de format à l’aide du chemin d’accès à la rubrique et du nom d’abonnement spécifiés. |
| FormatSubscriptionPath(String, String) |
Génère un chemin d’abonnement de nom de format à l’aide du chemin d’accès à la rubrique et du nom d’abonnement spécifiés. |
| GetMessageSessions() |
Obtient une session de messages qui autorise le regroupement des messages associés pour le traitement dans une seule transaction. |
| GetMessageSessions(DateTime) |
Récupère toutes les sessions de message dont l’état de session a été mis à jour depuis |
| GetMessageSessionsAsync() |
Obtient de manière asynchrone une session de message qui permet de regrouper les messages associés pour le traitement en une seule transaction. |
| GetMessageSessionsAsync(DateTime) |
Obtient de manière asynchrone une session de message qui permet de regrouper les messages associés pour le traitement en une seule transaction. |
| OnAbort() |
Exécute l’action d’abandon. |
| OnBeginAcceptMessageSession(String, ReceiveMode, Boolean, Nullable<Guid>, TimeSpan, TimeSpan, AsyncCallback, Object) |
S’exécute lors de l’appel de l’opération BeginAcceptMessageSession. |
| OnBeginAddRule(RuleDescription, TimeSpan, AsyncCallback, Object) |
S’exécute lors de l’appel de l’opération BeginAddRule. |
| OnBeginClose(TimeSpan, AsyncCallback, Object) |
Exécute l’action de début de fermeture. |
| OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object) |
Exécute l’action commencer à créer un récepteur. |
| OnBeginCreateReceiver(String, String, ReceiveMode, TimeSpan, AsyncCallback, Object) |
Exécute l’action commencer à créer un récepteur. |
| OnBeginGetMessageSessions(DateTime, AsyncCallback, Object) |
S’exécute lors de l’appel de l’opération BeginGetMessageSessions. |
| OnBeginGetRules(Int32, Int32, TimeSpan, AsyncCallback, Object) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| OnBeginOpen(TimeSpan, AsyncCallback, Object) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object) |
Commence la suppression d’un RuleDescription d’un SubscriptionDescription via le protocole client d’exécution. |
| OnBeginRemoveRulesByTag(String, TimeSpan, AsyncCallback, Object) |
Commence la suppression d’un RuleDescription d’un SubscriptionDescription via le protocole client d’exécution à l’aide d’une balise. |
| OnClose(TimeSpan) |
Exécute l’action de fermeture. |
| OnClosed() |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| OnEndAcceptMessageSession(IAsyncResult) |
S’exécute lors de l’appel de l’opération EndAcceptMessageSession. |
| OnEndAddRule(IAsyncResult) |
Termine l’appel asynchrone à OnBeginAddRule(RuleDescription, TimeSpan, AsyncCallback, Object). |
| OnEndClose(IAsyncResult) |
Exécute l’action de fermeture de fin. |
| OnEndCreateReceiver(IAsyncResult) |
Exécute l’action de fin de créer un récepteur. |
| OnEndGetMessageSessions(IAsyncResult) |
Exécute l’action de fin d’obtention du message. |
| OnEndGetRules(IAsyncResult) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| OnEndOpen(IAsyncResult) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| OnEndRemoveRule(IAsyncResult) |
Termine l’appel asynchrone à OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object). |
| OnEndRemoveRules(IAsyncResult) |
Termine l’appel asynchrone à OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object). |
| OnFaulted() |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| OnMessage(Action<BrokeredMessage>) |
Traite un message dans une pompe de messages pilotée par les événements. |
| OnMessage(Action<BrokeredMessage>, OnMessageOptions) |
Traite un message dans une pompe de messages pilotée par les événements, avec l’ensemble d’options OnMessageOptions donné. |
| OnMessageAsync(Func<BrokeredMessage,Task>) |
Traite de manière asynchrone un message. |
| OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions) |
Traite de manière asynchrone un message. |
| OnOpen(TimeSpan) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| OnOpened() |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| Peek() |
Retourne sans supprimer le premier message de la file d’attente. |
| Peek(Int64) |
Retourne sans supprimer le premier message de la file d’attente. |
| PeekAsync() |
Retourne de manière asynchrone sans supprimer le premier message de la file d’attente. |
| PeekAsync(Int64) |
Retourne de manière asynchrone sans supprimer le premier message de la file d’attente. |
| PeekBatch(Int32) |
Retourne sans supprimer les premiers messages d’un lot. |
| PeekBatch(Int64, Int32) |
Retourne sans supprimer les premiers messages d’un lot. |
| PeekBatchAsync(Int32) |
Retourne de manière asynchrone sans supprimer les premiers messages d’un lot. |
| PeekBatchAsync(Int64, Int32) |
Retourne de manière asynchrone sans supprimer les premiers messages d’un lot. |
| Receive() |
Reçoit un message à l’aide de Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver. |
| Receive(Int64) |
Reçoit un message différé à l’aide de Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver. Cette méthode fonctionne uniquement pour les messages différés, et non pour les messages normaux. |
| Receive(TimeSpan) |
Reçoit un message à l’aide de Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver. |
| ReceiveAsync() |
Reçoit de manière asynchrone un message à l’aide de Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver. |
| ReceiveAsync(Int64) |
Reçoit de manière asynchrone un message à l’aide de Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver. Cette méthode fonctionne uniquement pour les messages différés, et non pour les messages normaux. |
| ReceiveAsync(TimeSpan) |
Reçoit de manière asynchrone un message à l’aide de Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver. |
| ReceiveBatch(IEnumerable<Int64>) |
Reçoit un lot après l’opération asynchrone. |
| ReceiveBatch(Int32) |
Reçoit un lot après l’opération asynchrone. |
| ReceiveBatch(Int32, TimeSpan) |
Reçoit un lot après l’opération asynchrone. |
| ReceiveBatchAsync(IEnumerable<Int64>) |
Reçoit de manière asynchrone un ensemble de messages (pour le traitement par lots). |
| ReceiveBatchAsync(Int32) |
Reçoit de manière asynchrone un ensemble de messages (pour le traitement par lots). |
| ReceiveBatchAsync(Int32, TimeSpan) |
Reçoit de manière asynchrone un ensemble de messages (pour le traitement par lots). |
| RegisterSessionHandler(Type) |
Inscrit le gestionnaire pour la session cliente. |
| RegisterSessionHandler(Type, SessionHandlerOptions) |
Inscrit le gestionnaire pour la session cliente. |
| RegisterSessionHandlerAsync(Type) |
Inscrit de manière asynchrone le gestionnaire pour la session cliente. |
| RegisterSessionHandlerAsync(Type, SessionHandlerOptions) |
Inscrit de manière asynchrone le gestionnaire pour la session cliente. |
| RegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions) |
Inscrit la fabrique de gestionnaires pour la session cliente. |
| RegisterSessionHandlerFactory(IMessageSessionHandlerFactory, SessionHandlerOptions) |
Inscrit la fabrique de gestionnaires pour la session cliente. |
| RegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions) |
Inscrit de manière asynchrone la fabrique de gestionnaires pour la session cliente. |
| RegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory, SessionHandlerOptions) |
Inscrit de manière asynchrone la fabrique de gestionnaires pour la session cliente. |
| RemoveRule(String) |
Supprime la règle décrite par |
| RemoveRuleAsync(String) |
Supprime de manière asynchrone la règle décrite par |
| RenewMessageLock(Guid) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| RenewMessageLockAsync(Guid) |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. |
| ThrowIfClosed() |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| ThrowIfDisposed() |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| ThrowIfDisposedOrImmutable() |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| ThrowIfDisposedOrNotOpen() |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
| ThrowIfFaulted() |
Représente la classe d’ancre utilisée dans les opérations d’exécution liées à un abonnement à une rubrique. (Hérité de ClientEntity) |
S’applique à
Azure SDK for .NET