WebPubSubServiceClient.CloseConnectionAsync Methode

Referenz

Definition

Namespace:: Azure.Messaging.WebPubSub

Assembly:: Azure.Messaging.WebPubSub.dll

Paket:: Azure.Messaging.WebPubSub v1.3.0

Source:: WebPubSubServiceClient.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Schließen Sie die Clientverbindung.

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)

Parameter

connectionId: String

Zielverbindungs-ID.

reason: String

Der Grund, warum die Clientverbindung geschlossen wird.

context: RequestContext

Der Anforderungskontext, der das Standardverhalten der Clientpipeline pro Aufruf außer Kraft setzen kann.

Gibt zurück

Task<Response>

Die vom Dienst zurückgegebene Antwort.

Ausnahmen

ArgumentNullException

connectionId ist NULL.

ArgumentException

connectionId ist eine leere Zeichenfolge und wurde erwartet, dass sie nicht leer ist.

RequestFailedException

Der Dienst hat einen nicht erfolgreichen status Code zurückgegeben.

Beispiele

In diesem Beispiel wird gezeigt, wie CloseConnectionAsync mit den erforderlichen Parametern aufgerufen wird.

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

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

In diesem Beispiel wird gezeigt, wie CloseConnectionAsync mit allen Parametern aufgerufen wird.

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

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

Hinweise

Schema für Response Error:

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

Gilt für:

Freigeben über