Windows rozhraní REST API služby Azure Pack Websites
Platí pro: Windows Azure Pack
Tato dokumentace popisuje, jak provádět běžné úlohy na webových webech pomocí rozhraní REST API pro správu webových webů sady Azure Pack Windows.
Přehled
Rozhraní API pro správu webů sady Azure Pack Windows poskytuje sadu webových služeb RESTful, které komunikují se službou weby Windows Azure Pack weby pro správu vašich webů. Rozhraní API obsahuje entity, které zachycují vztah mezi koncovým uživatelem a službou Windows Weby sady Azure Pack.
Rozhraní API pro správu webů umožňuje základní sadu scénářů správy webu:
Vytváření, odstraňování a konfigurace webů
Zadejte dotaz na stav webů.
Dotazování metrik, jako jsou využití prostředků, kvóty a limity
Načtěte metadata, jako jsou profily publikování.
Nakonfigurujte měřítko webů.
Koncoví uživatelé
Existují dvě hlavní kategorie koncových uživatelů rozhraní REST API pro správu webových webů sady Azure Pack Windows:
Správce webu vytvoří a spravuje weby a doplňkové prostředky na webu Windows webech sady Azure Pack. Tato role odpovídá správci nebo spolusprávci předplatného sady Azure Pack Windows.
Publisher přistupuje k obsahu webu a publikuje obsah pomocí protokolu, jako je FTP nebo WebDeploy. Z pohledu poskytovatele hostingu je vydavatel uživatelem FTP. Vydavatel nemůže na webu provádět akce správy.
Zdroje informací
Rozhraní REST API Windows weby Azure zveřejňuje následující hierarchii prostředků pro správu služeb a nasazení:
/subscriptions
/WebSpaces
/sites
/config
/publishxml
/usages
/metrics
/repository
/ServerFarm
Následující tabulka popisuje předchozí prostředky.
Prostředek |
Popis |
|---|---|
Předplatná |
Předplatné Windows Azure Pack, které se vyžaduje pro použití Windows weby Azure. |
Webové prostory |
Webový prostor, který je logická entita, která je přidružená k předplatnému uživatele v dané geografické oblasti. Všechny weby v dané oblasti jsou přidružené k danému webovému prostoru. |
Lokality |
Web, který je základní entitou prostředků, která je nabízena službou Windows Weby Azure. |
Config |
Prostředek, který obsahuje vlastnosti konfigurace lokality, jako jsou AppSettings, ConnectionStrings, ErrorLogging a FrameworkVersions. |
Publishxml |
Soubor ve formátu XML, který obsahuje nastavení uživatele pro publikování webové aplikace do Windows weby Azure. Tento soubor lze importovat a použít z Microsoft Visual Studio nebo webové matice. |
Použití |
Prostředek, který obsahuje informace o aktuálním využití webu. |
Metriky |
Prostředek, který obsahuje historické informace v sestavách o využití. |
Repository |
Úložiště správy správy zdrojového kódu, které je přidružené k lokalitě. |
Serverfarm |
Sada počítačů, které jsou vyhrazené pro hostování lokalit pro konkrétního tenanta v dané oblasti. V současné době se podporuje pouze jedna serverová farma na datové centrum. |
Operace s prostředky
Vytvoření prostředku
Nové prostředky se vytvářejí pomocí příkazu HTTP POST. Název prostředku se předá v textu požadavku. Pokud se prostředek úspěšně vytvoří, vrátí se stavový kód HTTP 201 a serializovaný objekt prostředku se zahrne do textu odpovědi. Pokud se klient pokusí vytvořit prostředek, který již existuje, vrátí se stavový kód konfliktu HTTP 409.
Čtení prostředku
Ke čtení aktuálního stavu existujícího prostředku se použije příkaz HTTP GET. Pokud prostředek existuje, stavový kód odpovědi je 200 a text odpovědi obsahuje serializovaný objekt. Pokud prostředek neexistuje, stavový kód odpovědi je 404, prostředek nebyl nalezen.
Aktualizace prostředku
Existující prostředky se aktualizují příkazem HTTP PUT. Název objektu se předá v řetězci adresy URL a nový stav objektu se předá v textu požadavku. Pokud se prostředek úspěšně aktualizuje, vrátí se stavový kód HTTP 200. Pokud prostředek, který chcete aktualizovat, neexistuje, vrátí se stavový kód HTTP 404 (nenalezena).
Odstranění prostředku
Existující prostředek se odstraní pomocí příkazu HTTP DELETE. Název objektu se předá v řetězci adresy URL. Pokud se prostředek úspěšně odstraní, vrátí se stavový kód HTTP 200. Pokud už objekt byl odstraněn nebo neexistuje, vrátí se http 404.
Správa verzí rozhraní API
Podobně jako Windows služby Azure Windows weby Azure Packu dodržují Windows správu verzí rozhraní Azure REST API. Operace poskytované rozhraním REST API sady Windows Azure Pack weby mají více verzí. Musíte určit, kterou verzi operace chcete použít, nastavením hlavičky požadavku x-ms-version. Požadavky bez hlavičky x-ms-version jsou odmítnuty a vrátí odpověď (400) Chybný požadavek. Pokud vaše služba volá předchozí verzi operace a existuje novější verze, můžete pokračovat v volání předchozí verze nebo pokračovat v úpravě kódu tak, aby volala novější verzi.
Poznámka
I když se verze rozhraní API můžou změnit, Windows weby sady Azure Pack podporují novější i bezprostředně předchozí verzi rozhraní API.
Hodnota hlavičky požadavku x-ms-version musí být zadána ve formátu RRRR-MM-DD. Příklad kódu ukazuje požadovaný formát.
Hlavičky požadavku:
x-ms-version: 2012-10-10