WebPubSubServiceClient.RemoveUserFromGroup Method

Reference

Definition

Namespace:: Azure.Messaging.WebPubSub

Assembly:: Azure.Messaging.WebPubSub.dll

Package:: Azure.Messaging.WebPubSub v1.4.0

Source:: WebPubSubServiceClient_extensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Remove a user from the target group.

public virtual Azure.Response RemoveUserFromGroup (string group, string userId, Azure.RequestContext context = default);

abstract member RemoveUserFromGroup : string * string * Azure.RequestContext -> Azure.Response
override this.RemoveUserFromGroup : string * string * Azure.RequestContext -> Azure.Response

Public Overridable Function RemoveUserFromGroup (group As String, userId As String, Optional context As RequestContext = Nothing) As Response

Parameters

group: String

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

userId: String

Target user Id.

context: RequestContext

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

Returns

Response

Exceptions

ArgumentNullException

userId or group is null.

Remarks

Schema for Response Error:

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

Applies to

Share via