WebPubSubServiceClient.CloseConnectionAsync 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 la connexion cliente.

public virtual System.Threading.Tasks.Task<Azure.Response> CloseConnectionAsync (string connectionId, string reason = default, Azure.RequestContext context = default);

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

Public Overridable Function CloseConnectionAsync (connectionId As String, Optional reason As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Paramètres

connectionId

String

ID de connexion cible.

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

ArgumentNullException

connectionId a la valeur null.

ArgumentException

connectionId 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 CloseConnectionAsync avec les paramètres requis.

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

Response response = await client.CloseConnectionAsync("<connectionId>");
Console.WriteLine(response.Status);

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

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

Response response = await client.CloseConnectionAsync("<connectionId>", "<reason>");
Console.WriteLine(response.Status);

Remarques

Schéma pour Response Error:

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