WebPubSubServiceClient.CloseAllConnectionsAsync 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 hub.

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

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

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

Paramètres

excluded

IEnumerable<String>

Excluez ces connectionIds lors de la fermeture des connexions dans le hub.

reason

String

Raison de la fermeture de la connexion cliente.

context

RequestContext

Contexte de la demande, qui peut remplacer les comportements par défaut du pipeline client par appel.

Retours

Task<Response>

Réponse retournée par le service.

Exceptions

RequestFailedException

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

Exemples

Cet exemple montre comment appeler CloseAllConnectionsAsync.

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

Response response = await client.CloseAllConnectionsAsync();
Console.WriteLine(response.Status);

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

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

Response response = await client.CloseAllConnectionsAsync(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
              }
            }