UserOperationsExtensions.DeleteAsync Method

Definition

Namespace:

Microsoft.Azure.Management.ApiManagement

Assembly:

Microsoft.Azure.Management.ApiManagement.dll

Package:

Microsoft.Azure.Management.ApiManagement v8.0.0-preview

Deletes specific user.

public static System.Threading.Tasks.Task DeleteAsync (this Microsoft.Azure.Management.ApiManagement.IUserOperations operations, string resourceGroupName, string serviceName, string userId, string ifMatch, bool? deleteSubscriptions = default, bool? notify = default, string appType = default, System.Threading.CancellationToken cancellationToken = default);

static member DeleteAsync : Microsoft.Azure.Management.ApiManagement.IUserOperations * string * string * string * string * Nullable<bool> * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function DeleteAsync (operations As IUserOperations, resourceGroupName As String, serviceName As String, userId As String, ifMatch As String, Optional deleteSubscriptions As Nullable(Of Boolean) = Nothing, Optional notify As Nullable(Of Boolean) = Nothing, Optional appType As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations

IUserOperations

The operations group for this extension method.

resourceGroupName

String

The name of the resource group.

serviceName

String

The name of the API Management service.

userId

String

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

ifMatch

String

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

String

Determines the type of application which send the create user request. Default is legacy publisher portal. Possible values include: 'portal', 'developerPortal'

cancellationToken

CancellationToken

The cancellation token.

Returns

Task