Udostępnij za pośrednictwem

Uproszczone zestawy interfejsów API REST

  • Artykuł

Uproszczone zestawy interfejsów API REST do zarządzania jednostkami są następujące:

  • Get w dowolnym nieużywanym węźle nazewnictwa (na przykład / lub /test) jest operacją odnajdywania i zwraca listę elementów podrzędnych kanału informacyjnego AtomPub. Zostanie zwrócony tylko "węzeł natychmiastowy". Jeśli na przykład masz kolejki w lokalizacji A/B/C i wykonasz polecenie GET na "/", zwraca wartość "/A". Jeśli wykonujesz polecenie GET na "/A", zwraca tylko wartość "/A/B" i tak dalej.

  • Wyrażenie "GET" względem dowolnego zajętego węzła (na przykład /test1/test2, /test1/example lub /test2) to operacja get i zwraca AtomPub wpis z opisem.

  • Wyrażenie "PUT" względem dowolnego nieuprzyjętego węzła jest operacją tworzenia. Treść żądania to i AtomPub wpis z opisem.

  • "DELETE" względem dowolnego zajętego węzła jest operacją usuwania.

  • Polecenie "DELETE" względem dowolnego węzła nieuprzyjętego jest ignorowane i zwraca powodzenie.

Opisy jednostek

Kolejka jest opisywana za pomocą QueueDescription elementu. Schemat szczegółów elementu można bezpośrednio wywnioskować z klasy QueueDescription .NET Framework. Ładunek XML do tworzenia lub aktualizowania kolejki może zatem mieć następującą formę, w której wszystkie pominięte właściwości zakładają ich wartości domyślne:

<?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>

Tematy są opisywane za pomocą <TopicDescription> elementu. Schemat szczegółów elementu można bezpośrednio wywnioskować z klasy TopicDescription .NET Framework.

Subskrypcje są opisane za pomocą <SubscriptionDescription> elementu . Schemat szczegółów elementu można bezpośrednio wywnioskować z klasy SubscriptionDescription .NET Framework.

Subskrypcje są podrzędne tematów i dlatego muszą zostać utworzone w kolekcji "subskrypcje" istniejącego tematu. Jeśli ścieżka jednostki tematu to https://{serviceNamespace}.servicebus.windows.net/{topic-name}, prawidłową ścieżką do utworzenia nowej subskrypcji jest https://{serviceNamespace}.servicebus.windows.net/{topic-name}/subscriptions/{subscription-name}. Nazwy subskrypcji nie mogą mieć wielu segmentów.

Reguły są opisane za pomocą <RuleDescription> elementu . Schemat szczegółów elementu można bezpośrednio wywnioskować z klasy RuleDescription .NET Framework.

Reguły są podwładnymi subskrypcji tematów i dlatego muszą zostać utworzone w kolekcji "rules" istniejącej subskrypcji tematu. Jeśli ścieżka jednostki subskrypcji tematu to https://{serviceNamespace}.servicebus.windows.net/{topic-name}/subscriptions/{subscription-name}, prawidłową ścieżką do utworzenia nowej reguły jest https://{serviceNamespace}.servicebus.windows.net/{topic-name}/subscriptions/{subscription-name}/rules/{rule-name}. Nazwy subskrypcji nie mogą mieć wielu segmentów.