WebPubSubServiceClient.CloseUserConnections Méthode

Référence

Définition

Espace de noms:: Azure.Messaging.WebPubSub

Assembly:: Azure.Messaging.WebPubSub.dll

Paquet:: Azure.Messaging.WebPubSub v1.3.0

Source:: WebPubSubServiceClient.cs

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.

Fermez les connexions pour l’utilisateur spécifique.

public virtual Azure.Response CloseUserConnections (string userId, System.Collections.Generic.IEnumerable<string> excluded = default, string reason = default, Azure.RequestContext context = default);

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

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

Paramètres

userId: String

ID utilisateur.

excluded: IEnumerable<String>

Excluez ces connectionIds lors de la fermeture des connexions de l’utilisateur.

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

ArgumentNullException

userId a la valeur null.

ArgumentException

userId est une chaîne vide et devait être non vide.

RequestFailedException

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

Exemples

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

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

Response response = client.CloseUserConnections("<userId>");
Console.WriteLine(response.Status);

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

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

Response response = client.CloseUserConnections("<userId>", 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
              }
            }

S’applique à

Partager via