WINDOWS API REST del servicio Azure Pack Websites
Se aplica a: Windows Azure Pack
En esta documentación se describe cómo realizar tareas comunes en sitios web mediante la API DE REST de administración de sitios web de Windows Azure Pack.
Información general
La API de administración de sitios web de Azure Pack Windows proporciona un conjunto RESTful de servicios web que interactúan con el servicio azure Pack Web Sites Windows para administrar los sitios web. La API tiene entidades que capturan la relación entre un usuario final y el servicio Windows Azure Pack Web Sites.
La API de administración de sitios web permite un conjunto básico de escenarios de administración de sitios:
Crear, eliminar y configurar sitios web.
Consulte el estado de los sitios web.
Consultar métricas como el uso de recursos, cuotas y límites.
Recuperar metadatos como perfiles de publicación.
Configure la escala de sitios web.
Usuarios finales
Hay dos categorías principales de usuarios finales de la API DE REST de administración de sitios web de Windows azure Pack:
El administrador del sitio web crea y administra sitios y recursos complementarios en Windows sitios web de Azure Pack. Este rol corresponde a un Windows administrador o coadministrador de la suscripción de Azure Pack.
El Publisher accede al contenido de un sitio y publica contenido mediante un protocolo como FTP o WebDeploy. Desde el punto de vista de un proveedor de hospedaje, un publicador es un usuario de FTP. Un publicador no puede realizar acciones de administración en un sitio.
Recursos
La API de REST de Sitios web Windows Azure expone la jerarquía de recursos siguiente para administrar los servicios y las implementaciones:
/subscriptions
/WebSpaces
/sites
/config
/publishxml
/usages
/metrics
/repository
/ServerFarm
En la tabla siguiente se describen los recursos anteriores.
Recurso |
Descripción |
|---|---|
Suscripciones |
Una suscripción Windows Azure Pack necesaria para el uso de Windows Sitios web de Azure. |
Espacios web |
Un espacio web que es una entidad lógica, que está asociada a la suscripción del usuario en una región geográfica determinada. Todos los sitios de una región determinada son asociados de un espacio web dado. |
Sitios |
Un sitio que es la entidad de recursos principal, que ofrece el servicio Windows Sitios web de Azure. |
Configuración |
Un recurso que contiene propiedades de configuración del sitio, como AppSettings, ConnectionStrings, ErrorLogging y FrameworkVersions. |
Publishxml |
El archivo en formato XML que contiene la configuración de un usuario para publicar una aplicación web en Windows Azure Web Sites. Este archivo se puede importar y usar desde Microsoft Visual Studio o Matriz web. |
Usos |
Un recurso que contiene información sobre el uso actual del sitio web. |
Métricas |
Un recurso que contiene información histórica en informes sobre el uso. |
Repositorio |
Repositorio de administración de control de código fuente asociado al sitio. |
Serverfarm |
Un conjunto de equipos que están reservados para hospedar sitios para un inquilino determinado en una región determinada. Actualmente, solo se admite una granja de servidores por centro de datos. |
Operaciones en los recursos
Crear un recurso
Los nuevos recursos se crean con un verbo HTTP POST. El nombre del recurso se pasa en el cuerpo de la solicitud. Si el recurso se crea correctamente, se devuelve un código de estado HTTP 201 y el objeto de recurso serializado se incluye en el cuerpo de la respuesta. Si un cliente intenta crear un recurso que ya existe, se devuelve un código de estado de conflicto HTTP 409.
Leer un recurso
Para conocer el estado actual de un recurso existente, se utiliza un verbo HTTP GET. Si el recurso existe, el código de estado de respuesta es 200 y el cuerpo de la respuesta contiene un objeto serializado. Si el recurso no existe, el código de estado de respuesta es 404, no se encontró el recurso.
Actualizar un recurso
Los recursos existentes se actualizan con un verbo HTTP PUT. El nombre del objeto se pasa en la cadena de dirección URL y el nuevo estado del objeto se pasa en el cuerpo de la solicitud. Si el recurso se actualiza correctamente, se devuelve el código de estado HTTP 200. Si el recurso que se va a actualizar no existe, se devuelve un código de estado HTTP 404 (no encontrado).
Eliminar un recurso
Un recurso existente se elimina con un verbo HTTP DELETE. El nombre del objeto se pasa en la cadena de dirección URL. Si el recurso se elimina correctamente, se devuelve un código de estado HTTP 200. Si el objeto ya se ha eliminado o no existe, se devuelve HTTP 404.
Control de versiones de la API
Al igual que Windows los servicios de Azure, Windows sitios web de Azure Pack se adhieren al control de versiones de la API REST de Azure Windows. Las operaciones proporcionadas por Windows API rest de sitios web de Azure Pack tienen varias versiones. Debe especificar qué versión de una operación desea usar estableciendo el encabezado de solicitud x-ms-version. Las solicitudes sin un encabezado x-ms-version se rechazan y devuelven una respuesta de solicitud incorrecta (400). Si el servicio llama a una versión anterior de una operación y existe una versión más reciente, puede optar por continuar llamando a la versión anterior o seguir modificando el código para llamar a la versión más reciente.
Nota
Aunque las versiones de API pueden cambiar, Windows Azure Pack Web Sites admite la versión de API más reciente y la versión anterior inmediatamente.
El valor del encabezado de solicitud x-ms-version debe especificarse en el formato AAAA-MM-DD. En el ejemplo de código se muestra el formato necesario.
Encabezados de solicitud:
x-ms-version: 2012-10-10