Iot Hub Resource - Delete Event Hub Consumer Group

  • Reference
Service:
IoT Hub
API Version:
2018-04-01

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

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}?api-version=2018-04-01

URI Parameters

Name In Required Type Description
eventHubEndpointName
 path True

string

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

string

The name of the consumer group to delete.
resourceGroupName
 path True

string

The name of the resource group that contains the IoT hub.
resourceName
 path True

string

The name of the IoT hub.
subscriptionId
 path True

string

The subscription identifier.
api-version
 query True

string

The version of the API.

Responses

Name Type Description
200 OK

This is a synchronous operation.
Other Status Codes

ErrorDetails

DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

IotHubResource_DeleteEventHubConsumerGroup

Sample Request

DELETE https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/eventHubEndpoints/events/ConsumerGroups/test?api-version=2018-04-01

Sample Response

Status code:
200

Definitions

ErrorDetails

Error details.

Name Type Description
code

string

The error code.
details

string

The error details.
httpStatusCode

string

The HTTP status code.
message

string

The error message.