(0) exportieren Drucken
Alle erweitern

Zeitplanungsmodul-REST-API – Referenz

Letzte Aktualisierung: Oktober 2013

In diesem Thema wird beschrieben, wie Sie in Azure Scheduler allgemeine Aufgaben ausführen, indem Sie die REST-API für das Zeitplanungsmodul verwenden.

  • Ein gültiges Azure-Konto und ein aktives Azure-Abonnement sind erforderlich. In dieser Dokumentation wird davon ausgegangen, dass Sie über ein aktives Abonnement und die dazugehörige Abonnement-ID verfügen.

  • Ein Verwaltungszertifikat für das Azure-Abonnement. Ein Verwaltungszertifikat ist erforderlich, um die Authentifizierung des Clientzugriffs auf Ressourcen im Abonnement zu ermöglichen. Sie müssen ein X-509 v3-Zertifikat verwenden, das einen öffentlichen Schlüssel enthält und die Dateinamenerweiterung .cer aufweist. Weitere Informationen zur Erstellung eines Verwaltungszertifikats finden Sie unter Verwalten von Zertifikaten in Azure.

Von der Zeitplanungsmodul-API wird ein REST-Satz von Vorgängen bereitgestellt, die mit dem Azure Scheduler-Dienst interagieren, um geplante Aufträge und Auftragsauflistungen zu verwalten.

Die API für die Zeitplanungsmodul-Verwaltung ermöglicht einen Kernsatz von Szenarien für die Websiteverwaltung:

  1. Programmgesteuertes Erstellen, Aktualisieren und Löschen von "Auftragsauflistungen"

  2. Programmgesteuertes Erstellen, Aktualisieren und Löschen von geplanten Aufträgen

  3. Programmgesteuertes Anzeigen einer Liste mit Auftragsauflistungen und Aufträgen

  4. Programmgesteuertes Anzeigen des Auftragsstatus und -verlaufs

Die Azure Scheduler-REST-API macht die folgende Hierarchie von Ressourcen zum Verwalten der Aufträge und Auftragsauflistungen verfügbar:

/cloudservices

   /jobcollections

      /jobs

         /history

Um zu ermitteln, ob der Dienst die Verarbeitung einer Anforderung beendet hat, rufen Sie Get Operation Status auf. Dies gilt besonders, wenn Sie diese Ressource in einem nachfolgenden Aufruf verwenden oder sicherstellen müssen, dass ein Änderungs- oder Löschvorgang wirklich durchgeführt wurde. Weitere Informationen zu asynchronen Vorgänge finden Sie unter Nachverfolgen von asynchronen Dienstverwaltungsanforderungen.

Neue Ressourcen werden mit einem HTTP POST- oder PUT-Verb erstellt. Wenn die Ressource erfolgreich erstellt wurde, wird der Statuscode HTTP 200 (OK), 201 (erstellt) oder 202 (akzeptiert) zurückgegeben, und das serialisierte Ressourcenobjekt ist im Antworttext enthalten. Wenn ein Client versucht, eine bereits vorhandene Ressource zu erstellen, wird der Statuscode HTTP 400 (ungültige Anforderung) oder 409 (Konflikt) zurückgegeben.

Zum Lesen des aktuellen Status einer vorhandenen Ressource wird ein HTTP GET-Verb verwendet. Wenn die Ressource vorhanden ist, lautet der Statuscode der Antwort 200 oder 202, und der Antworttext enthält ein serialisiertes Objekt. Wenn die Ressource nicht vorhanden ist, lautet der Statuscode der Antwort 400 (ungültige Anforderung) oder 404 (Nicht gefunden).

Vorhandene Ressourcen werden mit einem HTTP PUT- oder PATCH-Verb aktualisiert. Der Name des Objekts wird in die URL-Zeichenfolge übergeben, und der neue Status des Objekts wird in den Anforderungstext übergeben. Wenn die Ressource erfolgreich aktualisiert wird, wird der Statuscode HTTP 200 oder 202 zurückgegeben. Wenn die zu aktualisierende Ressource nicht vorhanden ist, wird der Statuscode HTTP 400 (ungültige Anforderung) oder 404 (Nicht gefunden) zurückgegeben.

Eine vorhandene Ressource wird mit einem HTTP DELETE-Verb gelöscht. Der Name des Objekts wird in die URL-Zeichenfolge übergeben. Wenn die Ressource erfolgreich gelöscht wird, wird der Statuscode HTTP 200 oder 202 zurückgegeben. Falls das Objekt bereits gelöscht wurde oder nicht vorhanden ist, wird HTTP 400 oder 404 zurückgegeben.

Zum erfolgreichen Aufrufen der Azure Scheduler-APIs benötigen Sie ein Verwaltungszertifikat, das dem Abonnement zugeordnet ist. Weitere Informationen finden Sie unter Authentifizieren von Dienstverwaltungsanforderungen. Der Endpunkt des Zeitplanungsmodul-Diensts wird nur per "https" verfügbar gemacht, um die drohende Gefahr der Offenlegung von Informationen zu verringern.

Anzeigen:
© 2014 Microsoft