Windows Azure Pack Websites Service REST API
Van toepassing op: Windows Azure Pack
In deze documentatie wordt beschreven hoe u algemene taken op websites uitvoert met behulp van de Windows Beheer-REST API voor Azure Pack-websites.
Overzicht
De Windows Beheer-API voor Azure Pack-websites biedt een RESTful set webservices die communiceren met de Windows Azure Pack-websitesservice om uw websites te beheren. De API bevat entiteiten die de relatie tussen een eindgebruiker en de service Windows Azure Pack-websites vastleggen.
De beheer-API voor websites maakt een kernset sitebeheerscenario's mogelijk:
Websites maken, verwijderen en configureren.
Query's uitvoeren op de status van websites.
Metrische gegevens van query's, zoals resourcegebruik, quota en limieten.
Metagegevens ophalen, zoals publicatieprofielen.
Configureer de schaal van websites.
Eindgebruikers
Er zijn twee hoofdcategorieën van eindgebruikers van de Windows Azure Pack Web Sites Management REST API:
De websitebeheerder maakt en beheert sites en aanvullende resources in Windows Azure Pack-websites. Deze rol komt overeen met de beheerder of medebeheerder van een Windows Azure Pack-abonnement.
De Publisher de inhoud van een site opent en inhoud publiceert met behulp van een protocol zoals FTP of WebDeploy. Vanuit het oogpunt van een hostingprovider is een uitgever een FTP-gebruiker. Een uitgever kan geen beheeracties uitvoeren op een site.
Resources
De Windows Azure Web Sites REST API maakt de volgende hiërarchie van resources beschikbaar voor het beheren van uw services en implementaties:
/subscriptions
/WebSpaces
/sites
/config
/publishxml
/usages
/metrics
/repository
/ServerFarm
In de volgende tabel worden de voorgaande resources beschreven.
Resource |
Beschrijving |
|---|---|
Abonnementen |
Een Windows Azure Pack-abonnement dat is vereist voor gebruik van Windows Azure-websites. |
Webspaces |
Een webruimte die een logische entiteit is, die is gekoppeld aan het abonnement van de gebruiker in een bepaalde geografische regio. Alle sites in een bepaalde regio zijn gekoppeld aan een bepaalde webruimte. |
Sites |
Een site die de kernresource-entiteit is, die wordt aangeboden door de Windows Azure-websiteservice. |
Configureren |
Een resource die siteconfiguratie-eigenschappen bevat, zoals AppSettings, ConnectionStrings, ErrorLogging en FrameworkVersions. |
Publishxml |
Het bestand in XML-indeling met de instellingen van een gebruiker om een webtoepassing te publiceren naar Windows Azure-websites. Dit bestand kan worden geïmporteerd in en gebruikt vanuit Microsoft Visual Studio of Web Matrix. |
Gebruik |
Een resource die informatie bevat over het huidige websitegebruik. |
Metrische gegevens |
Een resource met historische informatie in rapporten over gebruik. |
Opslagplaats |
De opslagplaats voor broncodebeheer die is gekoppeld aan de site. |
Serverfarm |
Een set computers die zijn gereserveerd voor het hosten van sites voor een bepaalde tenant in een bepaalde regio. Op dit moment wordt slechts één serverfarm per datacenter ondersteund. |
Bewerkingen op resources
Een resource maken
Nieuwe resources worden gemaakt met een HTTP POST-werkwoord. De resourcenaam wordt doorgegeven in de aanvraagbody. Als de resource is gemaakt, wordt een HTTP 201-statuscode geretourneerd en wordt het geserialiseerde resourceobject opgenomen in de hoofdtekst van het antwoord. Als een client probeert een resource te maken die al bestaat, wordt een HTTP 409-conflictstatuscode geretourneerd.
Een resource lezen
Als u de huidige status van een bestaande resource wilt lezen, wordt een HTTP GET-werkwoord gebruikt. Als de resource bestaat, is de antwoordstatuscode 200 en bevat de hoofdtekst van het antwoord een geserialiseerd object. Als de resource niet bestaat, is de antwoordstatuscode 404, is de resource niet gevonden.
Een resource bijwerken
Bestaande resources worden bijgewerkt met een HTTP PUT-werkwoord. De naam van het object wordt doorgegeven in de URL-tekenreeks en de nieuwe status van het object wordt doorgegeven in de aanvraagbody. Als de resource is bijgewerkt, wordt een HTTP 200-statuscode geretourneerd. Als de resource die moet worden bijgewerkt niet bestaat, wordt een HTTP 404-statuscode (niet gevonden) geretourneerd.
Een resource verwijderen
Een bestaande resource wordt verwijderd met een HTTP DELETE-werkwoord. De naam van het object wordt doorgegeven in de URL-tekenreeks. Als de resource is verwijderd, wordt een HTTP 200-statuscode geretourneerd. Als het object al is verwijderd of niet bestaat, wordt HTTP 404 geretourneerd.
API-versiebeheer
Net als Windows Azure-services voldoen Windows Azure Pack-websites aan Windows Versiebeheer van Azure REST API. Bewerkingen die worden geleverd door de Windows REST API voor Azure Pack-websites hebben meerdere versies. U moet opgeven welke versie van een bewerking u wilt gebruiken door de aanvraagheader x-ms-version in te stellen. Aanvragen zonder een header van de x-ms-versie worden geweigerd en retourneren een (400) Ongeldige aanvraagreactie. Als uw service een eerdere versie van een bewerking aanroept en er een nieuwere versie bestaat, kunt u ervoor kiezen om door te gaan met het aanroepen van de vorige versie of door te gaan met het wijzigen van uw code om de nieuwere versie aan te roepen.
Notitie
Hoewel API-versies kunnen worden gewijzigd, ondersteunt Windows Azure Pack-websites zowel de nieuwere API-versie als de vorige versie.
De waarde van de aanvraagheader x-ms-versie moet worden opgegeven in de indeling JJJJ-MM-DD. In het codevoorbeeld ziet u de vereiste indeling.
Aanvraagheaders:
x-ms-version: 2012-10-10