Перечисление

  • Статья

Операция Discovery выполняет навигацию иерархических пространств имен, операция Enumeration позволяет перечислять все сущности определенного типа в представлении без структуры. Перечисление выполняется для специальной коллекции зарезервированных ресурсов ($Resources), которая находится в корне пространства имен службы. Для функций перечисление возникает с учетом адреса коллекции, например, “/subscriptions” или “/rules” для подписок и правил раздела.

Запрос

Запрос Enumeration можно сконструировать следующим образом.

Метод Универсальный код ресурса (URI) запроса Версия HTTP
GET https://{serviceNamespace}.servicebus.windows.net/$Resources/{resourceCollection}

или

https://{serviceNamespace}.servicebus.windows.net/{path}/Subscriptions

или

https://{serviceNamespace}.servicebus.windows.net/{path}/Subscriptions/{subscription-name}/rules		 HTTP/1.1

Параметры запроса $skip и $top

Перечисление поддерживает разбиение по страницам. Вы можете получить диапазон сущностей в пространстве имен службы. Параметр запроса $skip указывает, сколько записей должен пропустить запрос при возврате перечисления, и $top, сколько записей должно быть возвращено.

Заголовки запросов

В следующей таблице перечислены обязательные и необязательные заголовки запросов.

Заголовок запроса Описание
Авторизация Указывает маркер подписанного URL-адреса (SAS) с правами "Управление". Дополнительные сведения см. в статье Проверка подлинности служебной шины с помощью подписанных URL-адресов .

Текст запроса

Нет.

Ответ

Ответ включает код состояния HTTP и набор заголовков ответа.

Коды ответов

Код Описание
200 Все в порядке.
401 Не авторизовано. Запрос не авторизован.

Примечание

Пустой канал возвращается, если сущности не существуют.

Сведения о кодах состояний см. в разделе Коды состояний и ошибок.

Заголовки откликов

Ответ для этой операции включает следующие заголовки. Ответ может также включать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.

Заголовок ответа Описание
Тип содержимого Content-Type: application/atom+xml; type=entry

Текст ответа

При успешном завершении возвращается канал Atom, содержащий несколько записей Atom, перечисляющих все доступные ресурсы данного типа а данном пространстве имен. Пример:

<?xml version="1.0" encoding="utf-8" ?>  
<feed xmlns='http://www.w3.org/2005/Atom'>  
  <entry>  
    <id>https://{serviceNamespace}.Windows.net/{path}</id>  
    <published>{createdTime}</published>  
    <updated>{lastUpdatedTime}</updated>  
    <link rel='self'>https://{serviceNamespace}.servicebus.Windows.net/{path}</link>  
    <content type='application/xml'>  
      {description}
    </content>  
  </entry>  
</feed>

Возможное содержимое элемента {description} см. в разделе Обзор.