Share via


ApiManagementGroupResource.DeleteGroupUserAsync Method

Definition

Remove existing user from existing group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}
  • Operation Id: GroupUser_Delete
  • Default Api Version: 2023-03-01-preview
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteGroupUserAsync (string userId, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteGroupUserAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteGroupUserAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function DeleteGroupUserAsync (userId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

userId
String

User identifier. Must be unique in the current API Management service instance.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

userId is an empty string, and was expected to be non-empty.

userId is null.

Applies to