REST du service Event Hubs - Paramètres et en-têtes courants

  • Article

Ces API vous permettent d’accéder au service Event Hubs pour effectuer des opérations sur des hubs d’événements.

Paramètres communs

Les informations suivantes sont communes à toutes les tâches liées aux éditeurs Event Hubs :

  • Remplacez par {api-version}2014-01 dans l’URL.

  • Remplacez par {namespaceName} le nom de l’espace de noms.

  • Remplacez par {eventHubPath} le chemin d’accès à votre hub d’événements.

  • Remplacez par {publisherId} le nom de votre éditeur.

  • Remplacez par {partitionId} l’ID d’une partition sur un hub d’événements.

En-têtes courants

  • Attribuez à l’en-tête Content-Type la valeur application/atom+xml;type=entry;charset=utf-8.

  • Définissez l’en-tête Authorization sur l’un des jetons suivants :

    • Jeton web JSON (JWT) Azure Active Directory (Azure AD). Exemple : Authorization: Bearer <Azure AD JWT token>.

      Pour plus d’informations sur la génération d’un jeton Azure AD, consultez Obtenir un jeton Azure AD.

    • Jeton SAS . Exemple : Authorization: SharedAccessSignature sr=<NAMESPACE NAME>.servicebus.windows.net&sig=<SHARED ACCESS KEY>&se=<TOKEN EXPIRY INSTANT>&skn=<SHARED KEY NAME>.

      Pour plus d’informations sur la génération d’un jeton SAP, consultez Générer un jeton de signature d’accès partagé.

  • (Facultatif) Définissez l’en-tête NoRetryx-ms-retrypolicy sur , pour désactiver les nouvelles tentatives automatiques sur les opérations d’envoi en cas d’erreurs temporaires.

    POST https://your-namespace.servicebus.windows.net/your-event-hub/messages?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  

{ "DeviceId":"dev-01", "Temperature":"37.0" }

  • Définissez l’en-tête facultatif UserProperties sur une liste de propriétés personnalisées avec le nom de propriété comme clé et la valeur de la propriété comme valeur. Par exemple :

    WindAlert: Strong Winds  
GeneralAlert: Thunderstorms

Tâches

Vous pouvez effectuer les opérations de stratégie d’éditeur suivantes :