Windows REST API för Azure Pack Websites Service
Gäller för: Windows Azure Pack
Den här dokumentationen beskriver hur du utför vanliga uppgifter på webbplatser med hjälp av rest-API:et Windows Azure Pack Web Sites Management.
Översikt
Windows Azure Pack Web Sites Management API tillhandahåller en RESTful-uppsättning webbtjänster som interagerar med tjänsten Windows Azure Pack-webbplatser för att hantera dina webbplatser. API:et har entiteter som samlar in relationen mellan en slutanvändare och tjänsten Windows Azure Pack-webbplatser.
API:et för webbplatshantering möjliggör en grundläggande uppsättning scenarier för webbplatsadministration:
Skapa, ta bort och konfigurera webbplatser.
Fråga efter tillstånd för webbplatser.
Fråga efter mått som resursanvändning, kvoter och gränser.
Hämta metadata, till exempel publiceringsprofiler.
Konfigurera skalan för webbplatser.
Slutanvändare
Det finns två huvudkategorier av slutanvändare av rest-API:et Windows Azure Pack Web Sites Management:
Webbplatsadministratören skapar och hanterar webbplatser och kompletterande resurser i Windows Azure Pack-webbplatser. Den här rollen motsvarar en Windows Azure Pack-prenumerationens administratör eller medadministratör.
Publisher kommer åt en webbplats innehåll och publicerar innehåll med hjälp av ett protokoll som FTP eller WebDeploy. Från en värdleverantörs synvinkel är en utgivare en FTP-användare. En utgivare kan inte utföra hanteringsåtgärder på en webbplats.
Resurser
REST-API:et för Windows Azure-webbplatser visar följande resurshierarki för att hantera dina tjänster och distributioner:
/subscriptions
/WebSpaces
/sites
/config
/publishxml
/usages
/metrics
/repository
/ServerFarm
I följande tabell beskrivs föregående resurser.
Resurs |
Beskrivning |
|---|---|
Prenumerationer |
En Windows Azure Pack-prenumeration som krävs för användning av Windows Azure-webbplatser. |
Webbytor |
En webbrymd som är en logisk entitet som är associerad med användarens prenumeration i en viss geografisk region. Alla webbplatser i en viss region är associerade med en viss webbrymd. |
Webbplatser |
En webbplats som är den viktigaste resursentiteten, som erbjuds av tjänsten Windows Azure-webbplatser. |
Konfigurera |
En resurs som innehåller egenskaper för platskonfiguration, till exempel AppSettings, ConnectionStrings, ErrorLogging och FrameworkVersions. |
Publiceraxml |
Filen i XML-format som innehåller en användares inställningar för att publicera ett webbprogram till Windows Azure-webbplatser. Den här filen kan importeras till och användas från Microsoft Visual Studio eller Webbmatris. |
Användningsområden |
En resurs som innehåller information om aktuell webbplatsanvändning. |
Mått |
En resurs som innehåller historisk information i rapporter om användning. |
Lagringsplats |
Lagringsplatsen för källkontrollhantering som är associerad med platsen. |
Serverfarm |
En uppsättning datorer som är reserverade för värdplatser för en viss klientorganisation i en viss region. För närvarande stöds endast en servergrupp per datacenter. |
Åtgärder för resurser
Skapa en resurs
Nya resurser skapas med ett HTTP POST-verb. Resursnamnet skickas i begärandetexten. Om resursen har skapats returneras en HTTP 201-statuskod och det serialiserade resursobjektet ingår i svarstexten. Om en klient försöker skapa en resurs som redan finns returneras en HTTP 409-konfliktstatuskod.
Läsa en resurs
Om du vill läsa det aktuella tillståndet för en befintlig resurs används ett HTTP GET-verb. Om resursen finns är svarsstatuskoden 200 och svarstexten innehåller ett serialiserat objekt. Om resursen inte finns är svarsstatuskoden 404. Resursen hittades inte.
Uppdatera en resurs
Befintliga resurser uppdateras med ett HTTP PUT-verb. Objektets namn skickas i URL-strängen och objektets nya tillstånd skickas i begärandetexten. Om resursen har uppdaterats returneras en HTTP 200-statuskod. Om resursen som ska uppdateras inte finns returneras statuskoden HTTP 404 (hittades inte).
Ta bort en resurs
En befintlig resurs tas bort med ett HTTP DELETE-verb. Namnet på objektet skickas i URL-strängen. Om resursen har tagits bort returneras en HTTP 200-statuskod. Om objektet redan har tagits bort eller inte finns returneras HTTP 404.
API-versionshantering
Precis som Windows Azure-tjänster följer Windows Azure Pack-webbplatser Windows Azure REST API-versionshantering. Åtgärder som tillhandahålls av rest-API:et för Windows Azure Pack-webbplatser har flera versioner. Du måste ange vilken version av en åtgärd som du vill använda genom att ange rubriken för x-ms-version-begäran. Begäranden utan ett x-ms-versionshuvud avvisas och returnerar ett (400) svar på felaktig begäran. Om tjänsten anropar en tidigare version av en åtgärd och det finns en nyare version kan du välja att fortsätta anropa den tidigare versionen eller fortsätta att ändra koden för att anropa den nyare versionen.
Anteckning
Även om API-versioner kan ändras, stöder Windows Azure Pack-webbplatser både den nyare API-versionen och den tidigare versionen omedelbart.
Värdet för begärandehuvud för x-ms-version måste anges i formatet ÅÅÅÅÅ-MM-DD. Kodexemplet visar det format som krävs.
Begärandehuvuden:
x-ms-version: 2012-10-10