Atualizar Hub de Eventos
Atualizações um hub de eventos. Ao atualizar um hub de eventos, só pode alterar as propriedades listadas aqui. Uma tentativa de alterar quaisquer outras propriedades resulta num erro. As propriedades que podem ser alteradas, mas não especificadas, estão definidas para os respetivos valores predefinidos.
Propriedades
Nome da Propriedade | Disponível desde a versão da API | Predefinição | Descrição da Propriedade |
---|---|---|---|
MessageRetentionInDays | 2014-01 | 0 | MessageRetentionInDays |
Pedir
Método | URI do pedido |
---|---|
PUT | https://{serviceNamespace}.servicebus.windows.net/{eventHubPath} |
Cabeçalhos de 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).
Cabeçalhos de Pedido Adicionais
Cabeçalho do Pedido | Obrigatório ou Opcional | Description |
---|---|---|
If-Match | Necessário | Defina este cabeçalho como "*" para atualizar o hub de eventos. Tem de fornecer todos os valores de propriedade pretendidos no hub de eventos atualizado; quaisquer valores não fornecidos são definidos para os valores predefinidos do serviço. Se este cabeçalho estiver em falta, a chamada de atualização devolve um erro que indica que este hub de eventos já existe. |
Corpo do Pedido
Entrada de átomo com a descrição incorporada 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 estado HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.
Códigos de Resposta
Código | Descrição |
---|---|
200 | Com êxito. |
400 | Pedido incorreto. |
401 | Falha de autorização. |
409 | Conflito devido ao cabeçalho If-Match em falta. |
500 | Erro interno. |
Corpo da Resposta
Se o pedido for bem-sucedido, o corpo da resposta contém a descrição do hub de eventos. As propriedades em falta no pedido PUT são devolvidas com valores predefinidos. Se o pedido não for bem-sucedido, o corpo contém um código de erro e uma mensagem de erro.
Nome do Elemento | Description |
---|---|
AuthorizationRules |
As regras de autorização. |
MessageRetentionInDays |
O número de dias para reter os eventos deste hub de eventos. |
Status |
O estado atual do hub de eventos (ativado ou desativado). |
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
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?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>
Response
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>