Mise à jour d'un concentrateur d'événements

Article
08/05/2023

Mises à jour un hub d’événements. Lors de la mise à jour d’un hub d’événements, vous pouvez uniquement modifier les propriétés répertoriées ici. Une tentative de modification d’autres propriétés entraîne une erreur. Les propriétés qui peuvent être modifiées mais qui ne sont pas spécifiées sont définies sur leurs valeurs par défaut.

Propriétés

Nom de la propriété	Disponible depuis la version d'API	Default	Description de la propriété
MessageRetentionInDays	2014-01	0	MessageRetentionInDays

Requête

Méthode	URI de requête
PUT	`https://{serviceNamespace}.servicebus.windows.net/{eventHubPath}`

En-têtes de requête

Consultez Paramètres et en-têtes courants pour les en-têtes et les paramètres utilisés par toutes les requêtes liées à Event Hubs.

En-têtes de requête supplémentaires

En-tête de la demande	Obligatoire ou facultatif	Description
If-Match	Obligatoire	Définissez cet en-tête sur « * » pour mettre à jour le hub d’événements. Vous devez fournir toutes les valeurs de propriété souhaitées sur le hub d’événements mis à jour ; toutes les valeurs non fournies sont définies sur les valeurs par défaut du service. Si cet en-tête est manquant, l’appel de mise à jour retourne une erreur indiquant que ce hub d’événements existe déjà.

Corps de la requête

Entrée Atom avec la description incorporée dans le contenu. Par exemple :

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

response

La réponse inclut un code d'état HTTP, un ensemble d'en-têtes de réponse et un corps de réponse.

Codes de réponse

Code	Description
200	Réussite.
400	Demande incorrecte.
401	Échec de l'autorisation.
409	Conflit en raison de l’en-tête If-Match manquant.
500	Erreur interne.

Corps de la réponse

Si la demande réussit, le corps de la réponse contient la description du hub d’événements. Les propriétés qu'il manquait dans la demande PUT sont renvoyées avec les valeurs par défaut. Si la demande échoue, le corps contient un code d’erreur et un message d’erreur.

Nom de l’élément	Description
`AuthorizationRules`	Règles d’autorisation.
`MessageRetentionInDays`	Nombre de jours pendant lesquels conserver les événements pour ce hub d’événements.
`Status`	Le status actuel du hub d’événements (activé ou désactivé).
`CreatedAt`	Heure exacte à laquelle le hub d’événements a été créé.
`UpdatedAt`	Heure exacte à laquelle le hub d’événements a été mis à jour.
`PartitionCount`	Nombre actuel de partitions sur le hub d’événements.
`PartitionIds`	Identificateurs pour les partitions créées pour le hub d’événements.

Exemples

Requête

Notes

Vous pouvez également utiliser un jeton Azure Active Directory pour l’en-tête d’autorisation , comme indiqué dans les en-têtes et paramètres communs. Par exemple : 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>

Réponse

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>

Partager via