Obter grupo de consumidores

Artigo
08/05/2023

Obtém todos os metadados associados ao grupo de consumidores especificado. Veja Propriedades do ConsumerGroupDescription.

Pedir

Método	URI do pedido
GET	`https://{servicebusNamespace}.servicebus.windows.net/{eventHubPath}/consumergroups/{consumergroupName}`

Cabeçalhos do Pedido

Veja Common parameters and headers for headers and parameters that are used by all requests related to Event Hubs ( Parâmetros comuns e cabeçalhos para cabeçalhos e parâmetros que são utilizados por todos os pedidos relacionados com os Hubs de Eventos).

Resposta

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

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

Códigos de Resposta

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

Corpo da Resposta

Se o pedido for bem-sucedido, o corpo da resposta contém a descrição do grupo de consumidores especificado. Se o pedido não for bem-sucedido, o corpo contém um código de erro e uma mensagem de erro.

Exemplos

Pedir

Nota

Também pode utilizar um token do Azure Active Directory para o cabeçalho Autorização , conforme indicado 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/$default?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

Response

HTTP/1.1 200 Created  
Transfer-Encoding: chunked  
Content-Type: application/atom+xml;type=entry;charset=utf-8  
Server: Microsoft-HTTPAPI/2.0  
Date: Wed, 25 Jun 2014 22:43:27 GMT  
  
HTTP/1.1 200 OK  
Content-Type: application/atom+xml;type=entry;charset=utf-8  
Server: Microsoft-HTTPAPI/2.0  
Date: Fri, 19 Feb 2016 01:40:20 GMT  
Content-Length: 776  
  
<?xml version="1.0" encoding="UTF-8"?>  
<entry xmlns="http://www.w3.org/2005/Atom">  
   <id>sb://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/$default?timeout=60&api-version=2014-01</id>  
   <title type="text">$Default</title>  
   <published>2015-09-09T20:31:00Z</published>  
   <updated>2015-09-09T21:16:12Z</updated>  
   <link rel="self" href="sb://your-namespace.servicebus.windows.net/your-event-hub/consumergroups/$default?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>2015-09-09T20:31:00.4479782</CreatedAt>  
         <UpdatedAt>2015-09-09T21:16:12.0432889</UpdatedAt>  
      </ConsumerGroupDescription>  
   </content>  
</entry>

Partilhar via