WebPubSubServiceClient.CloseGroupConnectionsAsync Método

Definición

Espacio de nombres:

Azure.Messaging.WebPubSub

Ensamblado:

Azure.Messaging.WebPubSub.dll

Paquete:

Azure.Messaging.WebPubSub v1.3.0

Source:

WebPubSubServiceClient.cs

Cierre las conexiones del grupo específico.

public virtual System.Threading.Tasks.Task<Azure.Response> CloseGroupConnectionsAsync (string group, System.Collections.Generic.IEnumerable<string> excluded = default, string reason = default, Azure.RequestContext context = default);

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

Public Overridable Function CloseGroupConnectionsAsync (group As String, Optional excluded As IEnumerable(Of String) = Nothing, Optional reason As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parámetros

group

String

Nombre del grupo de destino, cuya longitud debe ser mayor que 0 y menor que 1025.

excluded

IEnumerable<String>

Excluya estos connectionIds al cerrar las conexiones del grupo.

reason

String

Motivo por el que se cierra la conexión de cliente.

context

RequestContext

Contexto de solicitud, que puede invalidar los comportamientos predeterminados de la canalización de cliente por llamada.

Devoluciones

Task<Response>

Respuesta devuelta desde el servicio.

Excepciones

ArgumentNullException

group es null.

ArgumentException

group es una cadena vacía y se espera que no esté vacía.

RequestFailedException

El servicio devolvió un código de estado no correcto.

Ejemplos

En este ejemplo se muestra cómo llamar a CloseGroupConnectionsAsync con los parámetros necesarios.

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

Response response = await client.CloseGroupConnectionsAsync("<group>");
Console.WriteLine(response.Status);

En este ejemplo se muestra cómo llamar a CloseGroupConnectionsAsync con todos los parámetros.

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

Response response = await client.CloseGroupConnectionsAsync("<group>", new String[]{"<excluded>"}, "<reason>");
Console.WriteLine(response.Status);

Comentarios

Esquema para Response Error:

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