Créer un groupe de consommateurs

Article
02/03/2024

Crée un groupe de consommateurs. Lors de la création d’un groupe de consommateurs, vous pouvez spécifier les propriétés suivantes dans ConsumerGroupDescription. Si aucune propriété n’est spécifiée, Event Hubs utilise la valeur par défaut pour cette propriété. Consultez Propriétés ConsumerGroupDescription.

Valeur par défaut des propriétés ConsumerGroupDescription :

Nom de la propriété	Default
`UserMetadata`	(empty)

Requête

Méthode	URI de requête
PUT	`https://{servicebusNamespace}.servicebus.windows.net/{eventHubPath}/consumergroups/{consumergroupName}`

En-têtes de requête

Consultez Paramètres et en-têtes courants pour les en-têtes et les paramètres utilisés par toutes les requêtes liées à Event Hubs.

response

La réponse inclut un code d'état HTTP, un ensemble d'en-têtes de réponse et un corps de réponse.

Nom de l'élément	Obligatoire	Type	Version	Description
`CreatedAt`	Oui, en lecture seule	string	2014-01	Heure exacte à laquelle le groupe de consommateurs a été créé.
`UpdatedAt`	Oui, en lecture seule	string	2014-01	Heure exacte à laquelle le groupe de consommateurs a été mis à jour.

Codes de réponse

Code	Description
201	Créé.
400	Demande incorrecte.
401	Échec de l'autorisation.
403	Quota dépassé ; groupe de consommateurs non créé.
409	Le groupe de consommateurs spécifié existe déjà (ou le chemin d’accès spécifié est déjà occupé).
500	Erreur interne.

Corps de la réponse

Si la demande réussit, le corps de la réponse contient la description du groupe de consommateurs spécifié. Si la demande échoue, le corps contient un code d’erreur et un message d’erreur.

Exemples

Requête

Notes

Vous pouvez également utiliser un jeton Azure Active Directory pour l’en-tête d’autorisation , comme indiqué dans les en-têtes et paramètres communs. Par exemple : Authorization: Bearer <Azure AD token>.

PUT https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/testCG?timeout=60&api-version=2014-01 HTTP/1.1  
Authorization: SharedAccessSignature sr=https%3A%2F%2Fyour-namespace.servicebus.windows.net%2F&sig=your-sas-key&se=1455847106&skn=RootManageSharedAccessKey  
Content-Type: application/atom+xml;type=entry;charset=utf-8  
Host: your-namespace.servicebus.windows.net  
  
<entry xmlns="http://www.w3.org/2005/Atom">  
   <content type="application/xml">  
      <ConsumerGroupDescription xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">  
      </ConsumerGroupDescription>  
   </content>  
</entry>

Réponse

HTTP/1.1 201 Created  
Content-Type: application/atom+xml;type=entry;charset=utf-8  
Server: Microsoft-HTTPAPI/2.0  
Date: Fri, 19 Feb 2016 01:52:50 GMT  
Content-Length: 776  
  
<?xml version="1.0" encoding="UTF-8"?>  
<entry xmlns="http://www.w3.org/2005/Atom">  
   <id>https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/testCG?timeout=60&api-version=2014-01</id>  
   <title type="text">testCG</title>  
   <published>2016-02-19T01:52:50Z</published>  
   <updated>2016-02-19T01:52:50Z</updated>  
   <link rel="self" href="https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/testCG?timeout=60&api-version=2014-01" />  
   <content type="application/xml">  
      <ConsumerGroupDescription xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">  
         <CreatedAt>2016-02-19T01:52:50.570652Z</CreatedAt>  
         <UpdatedAt>2016-02-19T01:52:50.570652Z</UpdatedAt>  
      </ConsumerGroupDescription>  
   </content>  
</entry>

Partager via