WINDOWS REST API службы веб-сайтов Azure Pack
Область применения: Windows Azure Pack
В этой документации описывается, как выполнять распространенные задачи на веб-сайтах с помощью REST API управления веб-сайтами Windows Пакета Azure.
Обзор
API управления веб-сайтами Windows Azure Pack предоставляет набор веб-служб RESTful, взаимодействующих со службой веб-сайтов Windows Azure Pack для управления веб-сайтами. API содержит сущности, которые фиксируют связь между конечным пользователем и службой Windows веб-сайтов Azure Pack.
API управления веб-сайтами позволяет использовать основной набор сценариев администрирования сайта:
Создание, удаление и настройка веб-сайтов.
Запрос состояния веб-сайтов.
Запрос метрик, таких как использование ресурсов, квоты и ограничения.
Получение метаданных, таких как профили публикации.
Настройте масштаб веб-сайтов.
Пользователи
Существует две основные категории конечных пользователей Windows REST API управления веб-сайтами azure Pack:
Администратор веб-сайта создает сайты и дополнительные ресурсы и управляет ими в Windows веб-сайтах Azure Pack. Эта роль соответствует Windows администратору или соадминистратору подписки Azure Pack.
Publisher обращается к содержимому сайта и публикует содержимое с помощью протокола, например FTP или WebDeploy. С точки зрения поставщика услуг размещения, издатель является FTP-пользователем. Издатель не может управлять сайтом.
Ресурсы
API REST служб веб-сайтов Windows Azure предоставляет следующую иерархию ресурсов, предназначенных для управления службами и развертываниями.
/subscriptions
/WebSpaces
/sites
/config
/publishxml
/usages
/метрики
/repository
/ServerFarm
В следующей таблице описаны предыдущие ресурсы.
Ресурс |
Описание |
|---|---|
Подписки |
Подписка Windows Пакета Azure, необходимая для использования Windows веб-сайтов Azure. |
Веб-пространства |
Веб-пространство, представляющее собой логическую сущность, которая связана с подпиской пользователя в заданном географическом регионе. Все сайты в заданном регионе входят в данное веб-пространство. |
Сайты |
Сайт, являющийся основной сущностью ресурса, которая предлагается службой Windows веб-сайтов Azure. |
Config |
Ресурс, содержащий свойства конфигурации сайта, такие как AppSettings, ConnectionStrings, ErrorLogging и FrameworkVersions. |
Publishxml |
Файл в формате XML, содержащий параметры пользователя для публикации веб-приложения для Windows веб-сайтов Azure. Этот файл можно импортировать и использовать из Microsoft Visual Studio или веб-матрицы. |
Применение |
Ресурс, содержащий сведения о текущем использовании веб-сайта. |
Метрики |
Ресурс, содержащий исторические сведения в отчетах об использовании. |
Хранилище |
Репозиторий управления версиями, связанный с сайтом. |
Serverfarm |
Набор компьютеров, зарезервированных для размещения сайтов для определенного клиента в заданном регионе. В настоящее время поддерживается только одна ферма серверов на центр обработки данных. |
Операции с ресурсами
Создание ресурса
Новые ресурсы создаются с помощью команды HTTP POST. Имя ресурса передается в тексте запроса. Если ресурс создан успешно, возвращается код состояния HTTP 201, а сериализованный объект ресурса включается в текст ответа. Если клиент пытается создать уже существующий ресурс, возвращается код состояния конфликта HTTP 409.
Считывание ресурса
Для считывания текущего состояния существующего ресурса используется HTTP-команда GET. Если ресурс существует, код состояния ответа равен 200, а текст ответа содержит сериализованный объект. Если ресурс не существует, код состояния ответа — 404, ресурс не найден.
Обновление ресурса
Существующие ресурсы обновляются с помощью HTTP-команды PUT. Имя объекта передается в строке URL-адреса, а новое состояние объекта передается в тексте запроса. Если ресурс успешно обновлен, возвращается код состояния HTTP 200. Если ресурс, который требуется обновить, не существует, то возвращается код состояния HTTP 404 (не найдено).
Удаление ресурса
Существующий ресурс удаляется с помощью HTTP-команды DELETE. Имя объекта передается в строке URL-адреса. Если ресурс успешно удален, то возвращается код состояния HTTP 200. Если объект уже был удален или не существует, то возвращается код состояния HTTP 404.
Управление версиями API
Как и Windows службах Azure, Windows веб-сайты Azure Pack соответствуют Windows управления версиями AZURE REST API. Операции, предоставляемые REST API веб-сайтов Azure Pack Windows, имеют несколько версий. Необходимо указать версию операции, которую вы хотите использовать, задав заголовок запроса x-ms-version. Запросы без заголовка x-ms-version отклоняются и возвращают ответ "Недопустимый запрос" (400). Если служба вызывает предыдущую версию операции и существует более новая версия, можно продолжить вызов предыдущей версии или продолжить изменение кода для вызова более новой версии.
Примечание
Хотя версии API могут изменяться, Windows веб-сайты Azure Pack поддерживают как более новую версию API, так и сразу предыдущую версию.
Значение заголовка запроса x-ms-version должно быть указано в формате ГГГГ-ММ-ДД. В примере кода показан требуемый формат.
Заголовки запросов:
x-ms-version: 2012-10-10