Ensembles d’API REST simplifiés

  • Article

Les ensembles d'API REST simplifiés pour la gestion des entités sont comme suit :

  • GET sur un nœud d'attribution de noms inoccupé (par exemple, / ou /test) est une opération de découverte et renvoie des enfants de la liste de flux AtomPub. Elle renvoie uniquement le « nœud immédiat ». Par exemple, si vous avez des files d'attente sur A/B/C, et exécutez une opération GET sur « / », « /A » est renvoyé. Si vous exécutez un opération GET sur « /A », elle renvoie uniquement « /A/B », et ainsi de suite.

  • « GET » sur un nœud occupé (par exemple, /test1/test2, /test1/example ou /test2) est une opération d'obtention et renvoie une entrée AtomPub avec la description.

  • « PUT » sur un nœud inoccupé est une opération de création. Le corps de la demande est une entrée AtomPub avec la description.

  • « DELETE » sur un nœud occupé est une opération de suppression.

  • « DELETE » sur un nœud inoccupé est ignoré et renvoie une réussite.

Descriptions d’entité

Une file d’attente est décrite avec un QueueDescription élément. Le schéma détaillé de l’élément peut être déduit directement à partir de la classe .NET Framework QueueDescription . La charge utile XML pour la création ou la mise à jour d’une file d’attente peut donc prendre la forme suivante, dans laquelle toutes les propriétés omises supposent leurs valeurs par défaut :

<?xml version="1.0" encoding="utf-8" ?>  
<entry xmlns="http://www.w3.org/2005/Atom">  
  <content type="application/xml">  
    <QueueDescription xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
       <LockDuration>T1M</LockDuration>
    </QueueDescription>
  </content>  
</entry>

Les rubriques sont décrites avec l’élément <TopicDescription> . Le schéma détaillé de l’élément peut être déduit directement à partir de la classe .NET Framework TopicDescription .

Les abonnements sont décrits avec l’élément <SubscriptionDescription> . Le schéma détaillé de l’élément peut être déduit directement de la classe SubscriptionDescription .NET Framework.

Les abonnements sont des subordonnés de Rubriques et doivent donc être créés dans la collection « abonnements » d’une rubrique existante. Si le chemin d’accès à l’entité de la rubrique est https://{serviceNamespace}.servicebus.windows.net/{topic-name}, le chemin d’accès correct pour la création d’un abonnement est https://{serviceNamespace}.servicebus.windows.net/{topic-name}/subscriptions/{subscription-name}. Les noms d’abonnement ne peuvent pas avoir plusieurs segments.

Les règles sont décrites avec l’élément <RuleDescription> . Le schéma détaillé de l’élément peut être déduit directement de la classe RuleDescription .NET Framework.

Les règles sont des subordonnés des abonnements à des rubriques et doivent donc être créées dans la collection « rules » d’un abonnement à une rubrique existante. Si le chemin d’accès à l’entité de l’abonnement à la rubrique est https://{serviceNamespace}.servicebus.windows.net/{topic-name}/subscriptions/{subscription-name}, le chemin d’accès correct pour la création d’une règle est https://{serviceNamespace}.servicebus.windows.net/{topic-name}/subscriptions/{subscription-name}/rules/{rule-name}. Les noms d’abonnement ne peuvent pas avoir plusieurs segments.