Listar grupos de consumidores

Artigo
07/19/2023

Recupera todos os grupos de consumidores associados ao Hub de Eventos especificado. Confira Propriedades de ConsumerGroupDescription.

Solicitação

Método	URI da solicitação
GET	`https://{servicebusNamespace}.servicebus.windows.net/{eventHubPath}/consumergroups`

Cabeçalhos de solicitação

Consulte Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros que são usados por todas as solicitações relacionadas aos Hubs de Eventos.

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Nome do elemento	Obrigatório	Tipo	Versão	Descrição
`CreatedAt`	Sim, somente leitura	string	2014-01	A hora exata em que o grupo de consumidores foi criado.
`UpdatedAt`	Sim, somente leitura	string	2014-01	A hora exata em que o grupo de consumidores foi atualizado.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá a descrição de todos os grupos de consumidores no Hub de Eventos especificado. Se a solicitação não for bem-sucedida, o corpo conterá um código de erro e uma mensagem de erro

Código	Descrição
200	Êxito.
401	Falha de autorização.
500	Erro interno.

Exemplos

Solicitação

Observação

Você também pode usar um token do Azure Active Directory para o cabeçalho De autorização , conforme observado nos parâmetros e cabeçalhos Comuns. Por exemplo: 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

Resposta

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>

Compartilhar via