Exportar (0) Imprimir
Expandir todo

Referencia de la API de REST de administración de Sitios web

Actualizado: enero de 2014

En esta documentación se describe cómo realizar tareas comunes en Sitios web de Windows Azure mediante la API de REST de administración de Sitios web de Windows Azure.

noteNota
Para recuperar (HTTP GET) una suscripción existente mediante la API de REST, vea Obtener suscripción.

  • Se requiere una cuenta válida de Azure y una suscripción de Azure activa. En esta documentación se supone que ya tiene una suscripción activa y un identificador de suscripción asociado.

  • Un certificado de administración para la suscripción de Azure. Se requiere un certificado de administración para autenticar el acceso de cliente a los recursos de la suscripción. Debe utilizarse un certificado X-509 v3 que contenga una clave pública y tenga un nombre de archivo con extensión .cer. Para obtener información sobre cómo crear un certificado de administración, vea Crear y cargar un certificado de administración para Windows Azure. El certificado de administración debe residir en el almacén de certificados Personal predeterminado del equipo local y también se debe cargar en su cuenta de Azure. Para cargar un certificado de administración en Azure, en el Portal de administración principal, elija la página Configuración en el panel de la izquierda. En Certificados de administración, en la parte inferior de la página, elija Cargar para cargar el archivo .cert en su cuenta.

    noteNota
    Se puede cargar más de un certificado de administración en una suscripción de Azure. Cada certificado de administración está asociado a la suscripción, y es independiente de cualquier servicio o implementación en la nube. Para simplificar la administración, es conveniente limitar el número de certificados de administración y reutilizar los existentes.

La API de administración de Sitios web de Windows Azure proporciona un conjunto REST de servicios Web que interactúan con el servicio Sitios web de Windows Azure para administrar los sitios web. La API tiene entidades que capturan la relación entre un usuario final y el servicio Sitios web de Windows Azure.

La API de administración de Sitios web habilita un conjunto básico de escenarios de administración de sitios:

  1. Crear, eliminar y configurar sitios web.

  2. Consultar el estado de sitios web.

  3. Consultar métricas como el uso de recursos, cuotas y límites.

  4. Recuperar metadatos como perfiles de publicación.

  5. Configurar la escala de sitios web.

Hay dos categorías principales de usuarios finales de la API de REST de administración de Sitios web de Windows Azure:

  1. El Web site administrator crea y administra sitios y recursos complementarios en Sitios web de Windows Azure. Este rol corresponde a un administrador o coadministrador de una suscripción de Windows Azure.

  2. El Publisher tiene acceso 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.

La API de REST de Sitios web de Windows Azure expone la siguiente jerarquía de recursos para administrar los servicios y las implementaciones:

/subscriptions

   /WebSpaces

      /sites

         /config

         /publishxml

         /usages

         /metrics

         /repository

   /ServerFarm

En la tabla siguiente se describen cada uno de los recursos anteriores.

 

Recurso Descripción

Subscriptions

Se necesita una suscripción de Windows Azure para usar Sitios web de Windows Azure.

Webspaces

Un espacio web es una entidad lógica asociada a la suscripción de un usuario en una región geográfica determinada. Todos los sitios de una región determinada son asociados de un espacio web dado.

Sites

Un sitio es la entidad básica de recursos que ofrece el servicio Sitios web de Windows Azure.

Config

Expone propiedades de configuración del sitio como AppSettings, ConnectionStrings, registro de errores y FrameworkVersions.

Publishxml

Archivo en formato XML que contiene la configuración de un usuario para publicar una aplicación web en Sitios web de Windows Azure. Este archivo se puede importar a Visual Studio o Web Matrix y utilizarlo desde allí.

Usages

Contiene información sobre el uso actual del sitio web.

Metrics

Contiene información histórica (informes) sobre el uso.

Repository

Repositorio de administración de control de código fuente asociado al sitio.

Serverfarm

Conjunto dedicado de servidores para hospedar sitios para un inquilino determinado en una región concreta. Actualmente, solo se admite una granja de servidores por centro de datos.

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 (creado) 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 HTTP 409 (conflicto).

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 la respuesta es 200 y el cuerpo de la respuesta contiene un objeto serializado. Si el recurso no existe, el código de estado de la respuesta es 404 (no encontrado).

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).

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.

Todoas las API de administración de Sitios web de Windows Azure admiten dos formatos de datos: "Plain Old Xml" (POX) o JSON. El autor de llamada de API puede elegir el formato estableciendo los encabezados HTTP adecuados en la solicitud de la manera siguiente:

 

Formato de datos Encabezado HTTP

XML

"Content-Type: text/xml", "Accept: text/xml"

JSON

"Content-Type: application/json", "Accept: application/json"

Al igual que otros servicios de Windows Azure, Sitios web de Windows Azure también se ajusta al control de versiones de la API de REST de Windows Azure. Las operaciones proporcionadas por la API de REST de Sitios web de Windows Azure tienen varias versiones. Puede especificar la versión que desea usar de una operación estableciendo el encabezado de solicitud x-ms-version. Si omite el encabezado x-ms-version, se utilizará la versión predeterminada. Si el servicio llama a una versión anterior de una operación y existe una versión más reciente, puede elegir entre seguir llamando a la versión anterior o modificar el código para que llame a la versión más reciente.

WarningAdvertencia
Si la versión que especifica está desusada, se utilizará en su lugar la versión predeterminada.

El valor del encabezado de solicitud x-ms-version debe especificarse con el formato AAAA-MM-DD. Por ejemplo:

Request Headers:

x-ms-version: 2013-08-01

Para llamar a las API de Sitios web de Windows Azure correctamente, necesitará un certificado de administración asociado a la suscripción. Para obtener más información, vea Autenticar solicitudes de administración de servicios.

Mostrar:
© 2014 Microsoft