IUserOperations.DeleteWithHttpMessagesAsync(String, String, String, String, Nullable<Boolean>, Nullable<Boolean>, String, Dictionary<String,List<String>>, CancellationToken) Method

Definition

Deletes specific user.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> DeleteWithHttpMessagesAsync (string resourceGroupName, string serviceName, string userId, string ifMatch, bool? deleteSubscriptions = default, bool? notify = default, string appType = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteWithHttpMessagesAsync : string * string * string * string * Nullable<bool> * Nullable<bool> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
Public Function DeleteWithHttpMessagesAsync (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 customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName
System.String

The name of the resource group.

serviceName
System.String

The name of the API Management service.

userId
System.String

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

ifMatch
System.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
System.Nullable<System.Boolean>

Whether to delete user's subscription or not.

notify
System.Nullable<System.Boolean>

Send an Account Closed Email notification to the User.

appType
System.String

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

customHeaders
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>

The headers that will be added to request.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<AzureOperationResponse>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to