Iot Hub Resource - Create Event Hub Consumer Group

Service:: IoT Hub

Version d’API:: 2026-11-01

Ajoutez un groupe de consommateurs à un point de terminaison compatible Event Hub dans un hub IoT.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
eventHubEndpointName	path	True	string	Le nom de l’EventHubEndpoint
name	path	True	string	Nom du groupe de consommateurs à récupérer.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom n’est pas sensible à la casse.
resourceName	path	True	string	Nom du hub IoT.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
properties	True	EventHubConsumerGroupName	Nom du groupe de consommateurs EventHub.

Réponses

Nom	Type	Description
200 OK	EventHubConsumerGroupInfo	Opération de mise à jour de la ressource 'EventHubConsumerGroupInfo' réussie
Other Status Codes	ErrorDetails	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 d’Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Usurper l’identité de votre compte utilisateur

Exemples

IotHubResource_CreateEventHubConsumerGroup

Exemple de requête

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"
  }
}

Exemple de réponse

Code d’état:: 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"
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorDetails	Détails de l’erreur.
EventHubConsumerGroupBodyDescription	Le groupe de consommateurs EventHub.
EventHubConsumerGroupInfo	Propriétés de l’objet EventHubConsumerGroupInfo.
EventHubConsumerGroupName	Nom du groupe de consommateurs EventHub.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorDetails

Objet

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
details	string	Détails de l’erreur.
httpStatusCode	string	Code d’état HTTP.
message	string	Message d’erreur.

EventHubConsumerGroupBodyDescription

Objet

Le groupe de consommateurs EventHub.

Nom	Type	Description
properties	EventHubConsumerGroupName	Nom du groupe de consommateurs EventHub.

EventHubConsumerGroupInfo

Objet

Propriétés de l’objet EventHubConsumerGroupInfo.

Nom	Type	Description
etag	string	L’etag.
id	string (arm-id)	Identifiant de ressource entièrement qualifié pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	nom de la ressource.
properties		Balises.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

EventHubConsumerGroupName

Objet

Nom du groupe de consommateurs EventHub.

Nom	Type	Description
name	string	Nom du groupe de consommateurs EventHub

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.