IIotHubResourceOperations.DeleteEventHubConsumerGroupWithHttpMessagesAsync Method

Definition

Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> DeleteEventHubConsumerGroupWithHttpMessagesAsync (string resourceGroupName, string resourceName, string eventHubEndpointName, string name, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteEventHubConsumerGroupWithHttpMessagesAsync : string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
Public Function DeleteEventHubConsumerGroupWithHttpMessagesAsync (resourceGroupName As String, resourceName As String, eventHubEndpointName As String, name As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName
String

The name of the resource group that contains the IoT hub.

resourceName
String

The name of the IoT hub.

eventHubEndpointName
String

The name of the Event Hub-compatible endpoint in the IoT hub.

name
String

The name of the consumer group to delete.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Remarks

Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.

Applies to