Windows API REST do Serviço de Sites do Azure Pack
Aplica-se a: Windows Azure Pack
Esta documentação descreve como executar tarefas comuns em sites usando o Windows API REST de gerenciamento de Sites do Azure Pack.
Visão geral
O Windows API de gerenciamento de Sites do Azure Pack fornece um conjunto RESTful de serviços Web que interagem com o serviço de Sites do Azure Pack Windows para gerenciar seus sites. A API tem entidades que capturam a relação entre um usuário final e o Windows serviço de Sites do Azure Pack.
A API de gerenciamento de Sites habilita um conjunto principal de cenários de administração de sites:
Criar, excluir e configurar sites.
Consulte o estado dos sites.
Consulte a métrica, como o uso de recursos, as cotas, e os limites.
Recupere metadados, como perfis de publicação.
Configure a escala de sites.
Usuários Finais
Há duas categorias principais de usuários finais do Windows API REST de Gerenciamento de Sites do Azure Pack:
O administrador do site cria e gerencia sites e recursos suplementares em Windows Sites do Azure Pack. Essa função corresponde a uma Windows administrador ou coadministrador da Assinatura do Azure Pack.
O Publisher acessa o conteúdo de um site e publica conteúdo usando um protocolo como FTP ou WebDeploy. Do ponto de vista de um provedor de host, um publicador é um usuário de FTP. Um publicador não pode executar ações de gerenciamento em um site.
Recursos
A API REST do Windows Azure Web Sites expõe a seguinte hierarquia de recursos para gerenciar seus serviços e implantações:
/subscriptions
/WebSpaces
/sites
/config
/publishxml
/usages
/metrics
/repositório
/ServerFarm
A tabela a seguir descreve os recursos anteriores.
Recurso |
Descrição |
|---|---|
Assinaturas |
Um Windows assinatura do Azure Pack que é necessária para uso de Windows Sites do Azure. |
Webspaces |
Um webspace que é uma entidade lógica, que está associada à assinatura do usuário em uma determinada região geográfica. Todos os sites em uma região específica são associados de um espaço Web específico. |
Sites |
Um site que é a entidade de recurso principal, que é oferecido pelo serviço Windows Sites do Azure. |
Config |
Um recurso que contém propriedades de configuração de site, como AppSettings, ConnectionStrings, ErrorLogging e FrameworkVersions. |
Publishxml |
O arquivo no formato XML que contém as configurações de um usuário para publicar um aplicativo Web em Windows Sites do Azure. Esse arquivo pode ser importado e usado de Microsoft Visual Studio ou Matriz da Web. |
Usos |
Um recurso que contém informações sobre o uso atual do site. |
Métricas |
Um recurso que contém informações históricas em relatórios sobre o uso. |
Repositório |
O repositório de gerenciamento de controle do código-fonte associado ao site. |
Serverfarm |
Um conjunto de computadores reservados para hospedar sites para um locatário específico em uma determinada região. Atualmente, há suporte para apenas um farm de servidores por data center. |
Operações em recursos
Criando um recurso
Novos recursos são criados com um verbo HTTP POST. O nome do recurso é passado no corpo da solicitação. Se o recurso for criado com êxito, um código de status HTTP 201 será retornado e o objeto de recurso serializado será incluído no corpo da resposta. Se um cliente tentar criar um recurso que já existe, um código de status de conflito HTTP 409 será retornado.
Lendo um recurso
Para ler o estado atual de um recurso existente, um verbo HTTP GET será usado. Se o recurso existir, o código de status de resposta será 200 e o corpo da resposta conterá um objeto serializado. Se o recurso não existir, o código de status de resposta será 404, o recurso não foi encontrado.
Atualizando um recurso
Os recursos existentes são atualizados com um verbo HTTP PUT. O nome do objeto é transmitido na cadeia de caracteres de URL e o novo estado do objeto é passado no corpo da solicitação. Se o recurso for atualizado com êxito, o código de status HTTP 200 será retornado. Se o recurso a ser atualizado não existir, um código de status HTTP 404 (não encontrado) será retornado.
Excluindo um recurso
Um recurso existente é excluído com um verbo HTTP DELETE. O nome do objeto é transmitido na cadeia de caracteres de URL. Se o recurso for excluído com êxito, um código de status HTTP 200 será retornado. Se o objeto tiver sido excluído ou não existir, o HTTP 404 será retornado.
Controle de versão de API
Como Windows serviços do Azure, Windows sites do Azure Pack seguem Windows controle de versão da API REST do Azure. As operações fornecidas pelo Windows API REST de Sites do Azure Pack têm várias versões. Você deve especificar qual versão de uma operação deseja usar definindo o cabeçalho de solicitação x-ms-version. As solicitações sem um cabeçalho x-ms-version são rejeitadas e retornam uma resposta de solicitação inválida (400). Se o serviço chamar uma versão anterior de uma operação e existir uma versão mais recente, você poderá optar por continuar chamando a versão anterior ou continuar modificando seu código para chamar a versão mais recente.
Observação
Embora as versões da API possam ser alteradas, Windows Sites do Azure Pack dão suporte à versão mais recente da API e à versão imediatamente anterior.
O valor do cabeçalho da solicitação x-ms-version deve ser especificado no formato YYYY-MM-DD. O exemplo de código mostra o formato necessário.
Cabeçalhos de solicitação:
x-ms-version: 2012-10-10