Windows API REST du service sites web Azure Pack
S’applique à : Windows Azure Pack
Cette documentation explique comment effectuer des tâches courantes dans des sites web à l’aide de l’API REST de gestion des sites web Azure Pack Windows.
Vue d’ensemble
L’API de gestion des sites web Azure Pack Windows fournit un ensemble de services web RESTful qui interagissent avec le service Windows sites web Azure Pack pour gérer vos sites web. L’API possède des entités qui capturent la relation entre un utilisateur final et le service Windows sites web Azure Pack.
L’API de gestion des sites web active un ensemble principal de scénarios d’administration de site :
Créez, supprimez et configurez des sites web.
Interrogez l’état des sites web.
Interroger des métriques telles que l'utilisation des ressources, les quotas, et les limites.
Récupérez des métadonnées telles que des profils de publication.
Configurez l’échelle des sites web.
Utilisateurs finaux
Il existe deux catégories principales d’utilisateurs finaux de l’API REST gestion des sites web Azure Pack Windows :
L’administrateur de site web crée et gère des sites et des ressources supplémentaires dans Windows sites web Azure Pack. Ce rôle correspond à un Windows administrateur ou coadministrateur de l’abonnement Azure Pack.
Le Publisher accède au contenu d’un site et publie du contenu à l’aide d’un protocole tel que FTP ou WebDeploy. Du point de vue du fournisseur d'hébergement, un serveur de publication est un utilisateur FTP. Un serveur de publication ne peut pas effectuer des actions de gestion sur un site.
Ressources
L'API REST Sites Web Windows Azure présente la hiérarchie de ressources suivante pour gérer vos services et déploiements :
/subscriptions
/WebSpaces
/sites
/config
/publishxml
/utilisations
/metrics
/repository
/ServerFarm
Le tableau suivant décrit les ressources précédentes.
Ressource |
Description |
|---|---|
Abonnements |
Un abonnement Azure Pack Windows requis pour l’utilisation de Windows sites web Azure. |
Espaces web |
Espace web qui est une entité logique, associée à l’abonnement de l’utilisateur dans une région géographique donnée. Tous les sites d'une région donnée sont des associés d'un espace Web donné. |
Sites |
Site qui est l’entité de ressource principale, qui est proposée par le service Windows sites web Azure. |
Config |
Ressource qui contient des propriétés de configuration de site telles que AppSettings, ConnectionStrings, ErrorLogging et FrameworkVersions. |
Publishxml |
Fichier au format XML qui contient les paramètres d’un utilisateur pour publier une application web sur Windows sites web Azure. Ce fichier peut être importé et utilisé à partir de Microsoft Visual Studio ou de matrice web. |
Utilisations |
Ressource qui contient des informations sur l’utilisation actuelle du site web. |
Mesures |
Ressource qui contient des informations historiques dans les rapports sur l’utilisation. |
Référentiel |
Référentiel de gestion du contrôle de code source associé au site. |
Serverfarm |
Ensemble d’ordinateurs réservés à l’hébergement de sites pour un locataire particulier dans une région donnée. Actuellement, une seule batterie de serveurs par centre de données est prise en charge. |
Opérations sur les ressources
Création d'une ressource
Les nouvelles ressources sont créées avec un verbe HTTP POST. Le nom de la ressource est utilisé dans le corps de la demande. Si la ressource est créée avec succès, un code d’état HTTP 201 est retourné et l’objet de ressource sérialisé est inclus dans le corps de la réponse. Si un client tente de créer une ressource qui existe déjà, un code d’état de conflit HTTP 409 est retourné.
Lecture d'une ressource
Pour lire l'état actif d'une ressource existante, un verbe HTTP GET est utilisé. Si la ressource existe, le code d’état de la réponse est 200 et le corps de la réponse contient un objet sérialisé. Si la ressource n’existe pas, le code d’état de la réponse est 404, la ressource n’a pas été trouvée.
Mise à jour d'une ressource
Les ressources existantes sont mises à jour avec un verbe HTTP PUT. Le nom de l'objet est passé dans la chaîne de l'URL, et le nouvel état de l'objet est passé dans le corps de la demande. Si la ressource est mise à jour, un code d'état HTTP 200 est retourné. Si la ressource à mettre à jour n'existe pas, un code d'état HTTP 404 (introuvable) est retourné.
Suppression d'une ressource
Une ressource existante est supprimée avec un verbe HTTP DELETE. Le nom de l'objet est passé dans la chaîne de l'URL. Si la ressource est supprimée, un code d'état HTTP 200 est retourné. Si l'objet a déjà été supprimé ou n'existe pas, un code d'état HTTP 404 est retourné.
Contrôle de version de l'API
Comme Windows services Azure, Windows sites web Azure Pack adhèrent à Windows version d’API REST Azure. Les opérations fournies par l’API REST des sites web Azure Pack Windows ont plusieurs versions. Vous devez spécifier la version d’une opération que vous souhaitez utiliser en définissant l’en-tête de requête x-ms-version. Les demandes sans en-tête x-ms-version sont rejetées et retournent une réponse de requête incorrecte (400). Si votre service appelle une version précédente d’une opération et qu’une version plus récente existe, vous pouvez choisir de continuer à appeler la version précédente ou de continuer à modifier votre code pour appeler la version plus récente.
Notes
Bien que les versions d’API puissent changer, Windows sites web Azure Pack prend en charge à la fois la version plus récente de l’API et la version immédiatement précédente.
La valeur d’en-tête de demande x-ms-version doit être spécifiée au format AAAA-MM-DD. L’exemple de code montre le format requis.
En-têtes de requête :
x-ms-version : 2012-10-10