WebPubSubServiceClient.AddConnectionToGroupAsync Method

Definition

Namespace:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Package:

Azure.Messaging.WebPubSub v1.3.0

Source:

WebPubSubServiceClient.cs

Add a connection to the target group.

public virtual System.Threading.Tasks.Task<Azure.Response> AddConnectionToGroupAsync (string group, string connectionId, Azure.RequestContext context = default);

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

Public Overridable Function AddConnectionToGroupAsync (group As String, connectionId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

group

String

Target group name, which length should be greater than 0 and less than 1025.

connectionId

String

Target connection Id.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

group or connectionId is null.

ArgumentException

group or connectionId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call AddConnectionToGroupAsync with required parameters.

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

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

Remarks

Schema for Response Error:

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