WebPubSubServiceClient.CloseGroupConnectionsAsync Método

Definição

Namespace:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Pacote:

Azure.Messaging.WebPubSub v1.3.0

Origem:

WebPubSubServiceClient.cs

Feche as conexões no 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

Nome do grupo de destino, cujo comprimento deve ser maior que 0 e menor que 1025.

excluded

IEnumerable<String>

Exclua essas connectionIds ao fechar as conexões no grupo.

reason

String

O motivo para fechar a conexão do cliente.

context

RequestContext

O contexto de solicitação, que pode substituir os comportamentos padrão do pipeline do cliente por chamada.

Retornos

Task<Response>

A resposta retornada do serviço.

Exceções

ArgumentNullException

group é nulo.

ArgumentException

group é uma cadeia de caracteres vazia e era esperado que não estivesse vazio.

RequestFailedException

O serviço retornou um código de status sem êxito.

Exemplos

Este exemplo mostra como chamar CloseGroupConnectionsAsync com os parâmetros necessários.

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

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

Este exemplo mostra como chamar CloseGroupConnectionsAsync com todos os 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);

Comentários

Esquema para Response Error:

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