Atualizar Hub de Eventos

Artigo
08/05/2023

Atualizações um hub de eventos. Ao atualizar um hub de eventos, você só pode alterar as propriedades listadas aqui. Uma tentativa de alterar quaisquer outras propriedades resulta em um erro. As propriedades que podem ser alteradas, mas não especificadas, são definidas como seus valores padrão.

Propriedades

Nome da Propriedade	Disponível desde a API versão	Padrão	Descrição da propriedade
MessageRetentionInDays	2014-01	0	MessageRetentionInDays

Solicitação

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

Cabeçalhos de solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por todas as solicitações relacionadas aos Hubs de Eventos.

Cabeçalhos de solicitação adicionais

Cabeçalho da solicitação	Obrigatório ou opcional	Descrição
If-Match	Obrigatório	Defina esse cabeçalho como "*" para atualizar o hub de eventos. Você deve fornecer todos os valores de propriedade desejados no hub de eventos atualizado; quaisquer valores não fornecidos são definidos como os valores padrão do serviço. Se esse cabeçalho estiver ausente, a chamada de atualização retornará um erro indicando que esse hub de eventos já existe.

Corpo da solicitação

A entrada do Atom com a descrição inserida no conteúdo. Por exemplo:

<entry xmlns='http://www.w3.org/2005/Atom'>  
  <content type='application/xml'>  
    {EventHubDescription}  
  </content>  
</entry>

Resposta

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

Códigos de resposta

Código	Descrição
200	Êxito.
400	Solicitação inválida.
401	Falha de autorização.
409	Conflito devido ao cabeçalho If-Match ausente.
500	Erro interno.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá a descrição do hub de eventos. As propriedades ausentes da solicitação PUT são retornadas com valores padrão. Se a solicitação não for bem-sucedida, o corpo conterá um código de erro e uma mensagem de erro.

Nome do elemento	Descrição
`AuthorizationRules`	As regras de autorização.
`MessageRetentionInDays`	O número de dias para reter os eventos para esse hub de eventos.
`Status`	O status atual do hub de eventos (habilitado ou desabilitado).
`CreatedAt`	A hora exata em que o hub de eventos foi criado.
`UpdatedAt`	A hora exata em que o hub de eventos foi atualizado.
`PartitionCount`	O número atual de partições no hub de eventos.
`PartitionIds`	Identificadores para partições criadas para o hub de eventos.

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 cabeçalhos e parâmetros comuns. Por exemplo: Authorization: Bearer <Azure AD token>.

PUT https://your-namespace.servicebus.windows.net/your-event-hub?timeout=60&api-version=2014-01 HTTP/1.1  
Authorization: SharedAccessSignature sr=your-namespace.servicebus.windows.net&sig=tYu8qdH563Pc96Lky0SFs5PhbGnljF7mLYQwCZmk9M0%3d&se=1403736877&skn=RootManageSharedAccessKey  
Content-Type: application/atom+xml;type=entry;charset=utf-8  
Host: your-namespace.servicebus.windows.net
If-Match: *
Content-Length: 264  
Expect: 100-continue  
Connection: Keep-Alive  
  
<entry xmlns='http://www.w3.org/2005/Atom'>  
  <content type='application/xml'>  
    <EventHubDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">  
      <MessageRetentionInDays>3</MessageRetentionInDays>  
    </EventHubDescription>  
  </content>  
</entry>

Resposta

HTTP/1.1 201 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  
  
<entry xmlns="http://www.w3.org/2005/Atom">  
  <id>https://your-namespace.servicebus.windows.net/your-event-hub?timeout=60&api-version=2014-01</id>  
  <title type="text">your-event-hub</title>  
  <published>2014-06-25T22:43:16Z</published>  
  <updated>2014-06-25T22:43:27Z</updated>  
  <author>  
     <name>your-namespace</name>  
  </author>  
  <link rel="self" href="https://your-namespace.servicebus.windows.net/your-event-hub?timeout=60&api-version=2014-01"/>  
  <content type="application/xml">  
    <EventHubDescription xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">  
        <MessageRetentionInDays>3</MessageRetentionInDays>  
    </EventHubDescription>  
  </content>  
</entry>

Compartilhar via