Iot Hub Resource - Create Event Hub Consumer Group

Tjänst:: IoT Hub

API-version:: 2026-11-01

Lägg till en konsumentgrupp i en Event Hub-kompatibel slutpunkt i en IoT-hubb.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
eventHubEndpointName	path	True	string	Namnet på EventHubEndpoint
name	path	True	string	Namnet på den konsumentgrupp som ska hämtas.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
resourceName	path	True	string	Namnet på IoT-hubben.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
properties	True	EventHubConsumerGroupName	EventHub-konsumentgruppens namn.

Svar

Name	Typ	Description
200 OK	EventHubConsumerGroupInfo	Resursens uppdateringsoperation 'EventHubConsumerGroupInfo' lyckades
Other Status Codes	ErrorDetails	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

IotHubResource_CreateEventHubConsumerGroup

Exempelbegäran

HTTP

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

{
  "properties": {
    "name": "test"
  }
}

Exempelsvar

Statuskod:: 200

{
  "name": "test",
  "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups",
  "etag": "AAAAAAFD6M4=",
  "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default",
  "properties": {
    "created": "Thu, 15 Jun 2017 19:20:58 GMT"
  }
}

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
ErrorDetails	Felinformation.
EventHubConsumerGroupBodyDescription	EventHub-konsumentgruppen.
EventHubConsumerGroupInfo	Egenskaperna för objektet EventHubConsumerGroupInfo.
EventHubConsumerGroupName	EventHub-konsumentgruppens namn.
systemData	Metadata som rör skapande och senaste ändring av resursen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorDetails

Objekt

Felinformation.

Name	Typ	Description
code	string	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.

EventHubConsumerGroupBodyDescription

Objekt

EventHub-konsumentgruppen.

Name	Typ	Description
properties	EventHubConsumerGroupName	EventHub-konsumentgruppens namn.

EventHubConsumerGroupInfo

Objekt

Egenskaperna för objektet EventHubConsumerGroupInfo.

Name	Typ	Description
etag	string	Etag.
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties		Taggarna.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

EventHubConsumerGroupName

Objekt

EventHub-konsumentgruppens namn.

Name	Typ	Description
name	string	Namn på EventHub-konsumentgrupp

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.