WebPubSubServiceClient.CloseGroupConnectionsAsync Méthode

Définition

Espace de noms:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Paquet:

Azure.Messaging.WebPubSub v1.3.0

Source:

WebPubSubServiceClient.cs

Fermez les connexions dans le groupe spécifique.

public virtual System.Threading.Tasks.Task<Azure.Response> CloseGroupConnectionsAsync (string group, System.Collections.Generic.IEnumerable<string> excluded = default, string reason = default, Azure.RequestContext context = default);

abstract member CloseGroupConnectionsAsync : string * seq<string> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CloseGroupConnectionsAsync : string * seq<string> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CloseGroupConnectionsAsync (group As String, Optional excluded As IEnumerable(Of String) = Nothing, Optional reason As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Paramètres

group

String

Nom du groupe cible, dont la longueur doit être supérieure à 0 et inférieure à 1 025.

excluded

IEnumerable<String>

Excluez ces id de connexion lors de la fermeture des connexions dans le groupe.

reason

String

Raison de la fermeture de la connexion cliente.

context

RequestContext

Contexte de requête, qui peut remplacer les comportements par défaut du pipeline client par appel.

Retours

Task<Response>

Réponse retournée par le service.

Exceptions

ArgumentNullException

group a la valeur null.

ArgumentException

group est une chaîne vide, et on s’attendait à ce qu’elle ne soit pas vide.

RequestFailedException

Le service a retourné un code de status non réussi.

Exemples

Cet exemple montre comment appeler CloseGroupConnectionsAsync avec les paramètres requis.

var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");

Response response = await client.CloseGroupConnectionsAsync("<group>");
Console.WriteLine(response.Status);

Cet exemple montre comment appeler CloseGroupConnectionsAsync avec tous les paramètres.

var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");

Response response = await client.CloseGroupConnectionsAsync("<group>", new String[]{"<excluded>"}, "<reason>");
Console.WriteLine(response.Status);

Remarques

Schéma pour Response Error:

{
              code: string,
              message: string,
              target: string,
              details: [ErrorDetail],
              inner: {
                code: string,
                inner: InnerError
              }
            }