WebPubSubServiceClient.CloseAllConnections 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 Azure.Response CloseAllConnections (System.Collections.Generic.IEnumerable<string> excluded = default, string reason = default, Azure.RequestContext context = default);

abstract member CloseAllConnections : seq<string> * string * Azure.RequestContext -> Azure.Response
override this.CloseAllConnections : seq<string> * string * Azure.RequestContext -> Azure.Response

Public Overridable Function CloseAllConnections (Optional excluded As IEnumerable(Of String) = Nothing, Optional reason As String = Nothing, Optional context As RequestContext = Nothing) As 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

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 CloseAllConnections.

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

Response response = client.CloseAllConnections();
Console.WriteLine(response.Status);

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

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

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