ApiManagementUserResource.Delete Method

Definition

Deletes specific user.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}
  • Operation Id: User_Delete
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementUserResource
public virtual Azure.ResourceManager.ArmOperation Delete (Azure.WaitUntil waitUntil, Azure.ETag ifMatch, bool? deleteSubscriptions = default, bool? notify = default, Azure.ResourceManager.ApiManagement.Models.AppType? appType = default, System.Threading.CancellationToken cancellationToken = default);
abstract member Delete : Azure.WaitUntil * Azure.ETag * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.ApiManagement.Models.AppType> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
override this.Delete : Azure.WaitUntil * Azure.ETag * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.ApiManagement.Models.AppType> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
Public Overridable Function Delete (waitUntil As WaitUntil, ifMatch As ETag, Optional deleteSubscriptions As Nullable(Of Boolean) = Nothing, Optional notify As Nullable(Of Boolean) = Nothing, Optional appType As Nullable(Of AppType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

ifMatch
ETag

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

deleteSubscriptions
Nullable<Boolean>

Whether to delete user's subscription or not.

notify
Nullable<Boolean>

Send an Account Closed Email notification to the User.

appType
Nullable<AppType>

Determines the type of application which send the create user request. Default is legacy publisher portal.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Applies to