Exporter (0) Imprimer
Développer tout

Référence de l'API REST de planification

Mis à jour: mai 2015

Cette rubrique explique comment exécuter des tâches courantes dans Azure Scheduler à l'aide de l'API REST de gestion de Scheduler.

  • Un compte Azure valide et un abonnement Azure actif sont nécessaires. Cette documentation suppose que vous avez déjà un abonnement actif et un ID d'abonnement associé.

  • Un certificat de gestion pour votre abonnement Azure. Un certificat de gestion est nécessaire pour authentifier l'accès client aux ressources de votre abonnement. Vous devez utiliser un certificat x.509 v3 qui contient une clé publique et a l'extension de nom de fichier .cer. Pour plus d'informations sur la création d'un certificat de gestion, consultez Gérer des certificats dans Azure.

L'API de Scheduler fournit un ensemble d'opérations RESTful qui interagissent avec le service Azure Scheduler pour gérer vos travaux planifiés et collections de travaux.

L'API de gestion d'Azure Scheduler permet un ensemble de base de scénarios d'administration de site :

  1. Créer, mettre à jour et supprimer des « collections de travaux » par programmation

  2. Créer, mettre à jour et supprimer des travaux planifiés par programmation

  3. Afficher la liste de collections de travaux et de travaux par programmation

  4. Afficher l'état et l'historique des travaux par programmation

L'API REST d'Azure Scheduler présente la hiérarchie suivante de ressources pour gérer vos travaux et collections de travaux :

/cloudservices

   /jobcollections

      /jobs

         /history

Pour déterminer si le service a terminé le traitement d'une requête, appelez Get Operation Status, surtout si vous devez utiliser cette ressource sur un appel suivant ou si vous devez vous assurer qu'une modification ou une suppression s'est vraiment produite. Pour plus d'informations sur les opérations asynchrones, consultez Suivre les demandes de gestion des services asynchrones.

Les nouvelles ressources sont créées avec un verbe HTTP POST ou PUT. Si la ressource est créée correctement, un code d'état HTTP 200 (OK), 201 (créé) ou 202 (accepté) 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 HTTP 400 (demande incorrecte) ou 409 (conflit) est retourné.

Pour lire l'état actif d'une ressource existante, un verbe HTTP GET est utilisé. Si la ressource existe, le code d'état de réponse est 200 ou 202 et le corps de la réponse contient un objet sérialisé. Si la ressource n'existe pas, le code d'état de réponse est 400 (demande incorrecte) ou 404 (introuvable).

Les ressources existantes sont mises à jour avec un verbe HTTP PUT ou PATCH. 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 ou 202 est retourné. Si la ressource à mettre à jour n'existe pas, un code d'état HTTP 400 (demande incorrecte) ou 404 (introuvable) est retourné.

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 ou 202 est retourné. Si l'objet a déjà été supprimé ou n'existe pas, un code d'état HTTP 400 ou 404 est retourné.

Pour appeler les API d'Azure Scheduler, vous avez besoin d'un certificat de gestion associé à votre abonnement. Pour plus d'informations, consultez Authentification des demandes de gestion des services. Le point de terminaison du service Scheduler est exposé uniquement via https, pour réduire les menaces de divulgation d'informations.

Voir aussi

Afficher:
© 2015 Microsoft