Partager via

Iot Hub Resource - Create Event Hub Consumer Group

Service:
IoT Hub
Version d'API:
2023-06-30

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=2023-06-30

Paramètres URI

Nom Dans Obligatoire Type Description
eventHubEndpointName
 path True

string

Nom du point de terminaison compatible Event Hub dans le hub IoT.
name
 path True

string

Nom du groupe de consommateurs à ajouter.
resourceGroupName
 path True

string

Nom du groupe de ressources qui contient le hub IoT.
resourceName
 path True

string

Nom du hub IoT.
subscriptionId
 path True

string

Identificateur d’abonnement.
api-version
 query True

string

Version de l’API.

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

Il s’agit d’une opération synchrone.
Other Status Codes

ErrorDetails

DefaultErrorResponse

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

IotHubResource_CreateEventHubConsumerGroup

Exemple de requête

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

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

Exemple de réponse

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

Définitions

Nom Description
ErrorDetails

Détails de l’erreur.
EventHubConsumerGroupBodyDescription

Groupe de consommateurs EventHub.
EventHubConsumerGroupInfo

Propriétés de l’objet EventHubConsumerGroupInfo.
EventHubConsumerGroupName

Nom du groupe de consommateurs EventHub.

ErrorDetails

Object

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

Object

Groupe de consommateurs EventHub.

Nom Type Description
properties

EventHubConsumerGroupName

Nom du groupe de consommateurs EventHub.

EventHubConsumerGroupInfo

Object

Propriétés de l’objet EventHubConsumerGroupInfo.

Nom Type Description
etag

string

L’etag.
id

string

Identificateur du groupe de consommateurs compatible Event Hub.
name

string

Nom du groupe de consommateurs compatible Event Hub.
properties

Balises.
type

string

type de ressource.

EventHubConsumerGroupName

Object

Nom du groupe de consommateurs EventHub.

Nom Type Description
name

string

Nom du groupe de consommateurs EventHub