WebPubSubServiceClient.CloseAllConnections 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 Verbindungen im 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

Parameter

excluded: IEnumerable<String>

Schließen Sie diese connectionIds aus, wenn Sie die Verbindungen im Hub schließen.

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

Response

Die vom Dienst zurückgegebene Antwort.

Ausnahmen

RequestFailedException

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

Beispiele

In diesem Beispiel wird gezeigt, wie CloseAllConnections aufgerufen wird.

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

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

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

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

Response response = client.CloseAllConnections(new String[]{"<excluded>"}, "<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