WebPubSubServiceClient.CloseUserConnections 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 Verbindungen für den bestimmten Benutzer.

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

Parameter

userId: String

Die Benutzer-ID.

excluded: IEnumerable<String>

Schließen Sie beim Schließen der Verbindungen für den Benutzer diese connectionIds aus.

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

ArgumentNullException

userId ist NULL.

ArgumentException

userId 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 CloseUserConnections mit den erforderlichen Parametern aufgerufen werden.

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

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

In diesem Beispiel wird gezeigt, wie Sie CloseUserConnections mit allen Parametern aufrufen.

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

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