Répertorier les groupes de consommateurs

Article
07/19/2023

Récupère tous les groupes de consommateurs associés au hub d’événements spécifié. Consultez Propriétés ConsumerGroupDescription.

Requête

Méthode	URI de demande
GET	`https://{servicebusNamespace}.servicebus.windows.net/{eventHubPath}/consumergroups`

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.

Corps de la réponse

Si la demande réussit, le corps de la réponse contient la description de tous les groupes de consommateurs au sein du hub d’événements spécifié. Si la demande échoue, le corps contient un code d’erreur et un message d’erreur

Code	Description
200	Réussite.
401	Échec de l'autorisation.
500	Erreur interne.

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>.

GET https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups?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

Réponse

HTTP/1.1 200 OK  
Content-Type: application/atom+xml;type=feed;charset=utf-8  
Server: Microsoft-HTTPAPI/2.0  
Date: Fri, 19 Feb 2016 01:40:40 GMT  
Content-Length: 1179  
  
<?xml version="1.0" encoding="UTF-8"?>  
<feed xmlns="http://www.w3.org/2005/Atom">  
   <title type="text">ConsumerGroups</title>  
   <id>https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups?timeout=60&api-version=2014-01</id>  
   <updated>2016-02-19T01:40:41Z</updated>  
   <link rel="self" href="https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups?timeout=60&api-version=2014-01" />  
   <entry xml:base="https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups?timeout=60&api-version=2014-01">  
      <id>https://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/$Default?api-version=2014-01</id>  
      <title type="text">$Default</title>  
      <published>2015-09-09T20:31:00Z</published>  
      <updated>2015-09-09T20:31:00Z</updated>  
      <link rel="self" href="consumergroups/$Default?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>2015-09-09T20:31:00.4479782</CreatedAt>  
            <UpdatedAt>2015-09-09T20:31:00.4479782</UpdatedAt>  
         </ConsumerGroupDescription>  
      </content>  
   </entry>  
</feed>

Partager via