Criar grupo de consumidores

Artigo
02/03/2024

Cria um novo grupo de consumidores. Ao criar um grupo de consumidores, pode especificar as seguintes propriedades em ConsumerGroupDescription. Se não for especificada uma propriedade, os Hubs de Eventos utilizam o valor predefinido para essa propriedade. Veja Propriedades do ConsumerGroupDescription.

Valor predefinido de Propriedades consumerGroupDescription:

Nome da Propriedade	Predefinição
`UserMetadata`	(vazio)

Pedir

Método	URI do pedido
PUT	`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
201	Criado.
400	Pedido incorreto.
401	Falha de autorização.
403	Quota excedida; grupo de consumidores não criado.
409	O grupo de consumidores especificado já existe (ou o caminho especificado já está ocupado).
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>.

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>

Response

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>

Partilhar via