Trigger mit Timer für Azure Functions

Dieser Artikel erläutert das Arbeiten mit Triggern mit Timer in Azure Functions. Mit einem Trigger mit Timer können Sie eine Funktion nach einem Zeitplan ausführen.

Dies sind Referenzinformationen für Azure Functions-Entwickler. Falls Sie mit Azure Functions noch nicht vertraut sind, beginnen Sie mit den folgenden Ressourcen:

• Entwicklerreferenz zu Azure Functions

• Konzepte für Azure Functions-Trigger und -Bindungen

• Lokales Codieren und Testen von Azure Functions

Informationen zum manuellen Ausführen einer per Timer ausgelösten Funktion finden Sie unter Manuelles Ausführen einer Funktion ohne HTTP-Trigger.

Unterstützung für diese Bindung wird automatisch in allen Entwicklungsumgebungen bereitgestellt. Sie müssen das Paket nicht manuell installieren oder die Erweiterung registrieren.

Den Quellcode für das Zeitgebererweiterungspaket finden Sie im GitHub-Repository azure-webjobs-sdk-extensions.

Beispiel

//<docsnippet_fixed_delay_retry_example>
[Function(nameof(TimerFunction))]
[FixedDelayRetry(5, "00:00:10")]
public static void Run([TimerTrigger("0 */5 * * * *")] TimerInfo timerInfo,
    FunctionContext context)
{
    var logger = context.GetLogger(nameof(TimerFunction));

[FunctionName("TimerTriggerCSharp")]
public static void Run([TimerTrigger("0 */5 * * * *")]TimerInfo myTimer, ILogger log)
{
    if (myTimer.IsPastDue)
    {
        log.LogInformation("Timer is running late!");
    }
    log.LogInformation($"C# Timer trigger function executed at: {DateTime.Now}");
}

@FunctionName("keepAlive")
public void keepAlive(
  @TimerTrigger(name = "keepAliveTrigger", schedule = "0 */5 * * * *") String timerInfo,
      ExecutionContext context
 ) {
     // timeInfo is a JSON string, you can deserialize it to an object using your favorite JSON library
     context.getLogger().info("Timer is triggered: " + timerInfo);
}

import datetime
import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="mytimer")
@app.timer_trigger(schedule="0 */5 * * * *", 
              arg_name="mytimer",
              run_on_startup=True) 
def test_function(mytimer: func.TimerRequest) -> None:
    utc_timestamp = datetime.datetime.utcnow().replace(
        tzinfo=datetime.timezone.utc).isoformat()
    if mytimer.past_due:
        logging.info('The timer is past due!')
    logging.info('Python timer trigger function ran at %s', utc_timestamp)

{
    "schedule": "0 */5 * * * *",
    "name": "myTimer",
    "type": "timerTrigger",
    "direction": "in"
}

import datetime
import logging

import azure.functions as func


def main(mytimer: func.TimerRequest) -> None:
    utc_timestamp = datetime.datetime.now(datetime.timezone.utc).isoformat()

    if mytimer.past_due:
        logging.info('The timer is past due!')

    logging.info('Python timer trigger function ran at %s', utc_timestamp)

import { app, InvocationContext, Timer } from '@azure/functions';

export async function timerTrigger1(myTimer: Timer, context: InvocationContext): Promise<void> {
    context.log('Timer function processed request.');
}

app.timer('timerTrigger1', {
    schedule: '0 */5 * * * *',
    handler: timerTrigger1,
});

const { app } = require('@azure/functions');

app.timer('timerTrigger1', {
    schedule: '0 */5 * * * *',
    handler: (myTimer, context) => {
        context.log('Timer function processed request.');
    },
});

{
    "schedule": "0 */5 * * * *",
    "name": "myTimer",
    "type": "timerTrigger",
    "direction": "in"
}

module.exports = async function (context, myTimer) {
    var timeStamp = new Date().toISOString();

    if (myTimer.isPastDue)
    {
        context.log('Node is running late!');
    }
    context.log('Node timer trigger function ran!', timeStamp);   
};

{
    "schedule": "0 */5 * * * *",
    "name": "myTimer",
    "type": "timerTrigger",
    "direction": "in"
}

# Input bindings are passed in via param block.
param($myTimer)

# Get the current universal time in the default string format.
$currentUTCtime = (Get-Date).ToUniversalTime()

# The 'IsPastDue' property is 'true' when the current function invocation is later than scheduled.
if ($myTimer.IsPastDue) {
    Write-Host "PowerShell timer is running late!"
}

# Write an information log with the current time.
Write-Host "PowerShell timer trigger function ran! TIME: $currentUTCtime"

Wenn Sie die Entwicklung lokal ausführen, fügen Sie Ihre Anwendungseinstellungen in der Datei local.settings.json in der Values-Sammlung hinzu.

Vollständige Beispiele finden Sie im Abschnitt „Beispiele“.

Verwendung

Bei Aufruf einer Trigger-mit-Timer-Funktion wird ein Timerobjekt an die Funktion übergeben. Der folgende JSON-Code ist eine Beispieldarstellung des Timerobjekts.

{
    "Schedule":{
        "AdjustForDST": true
    },
    "ScheduleStatus": {
        "Last":"2016-10-04T10:15:00+00:00",
        "LastUpdated":"2016-10-04T10:16:00+00:00",
        "Next":"2016-10-04T10:20:00+00:00"
    },
    "IsPastDue":false
}

{
    "schedule":{
        "adjustForDST": true
    },
    "scheduleStatus": {
        "last":"2016-10-04T10:15:00+00:00",
        "lastUpdated":"2016-10-04T10:16:00+00:00",
        "next":"2016-10-04T10:20:00+00:00"
    },
    "isPastDue":false
}

Die Eigenschaft isPastDue lautet true, wenn der aktuelle Funktionsaufruf später als geplant erfolgt. Beispielsweise kann ein Neustart der Funktionen-App dazu führen, dass ein Aufruf nicht erkannt wird.

NCRONTAB-Ausdrücke

Azure Functions verwendet die Bibliothek NCronTab, um NCRONTAB-Ausdrücke zu interpretieren. Ein NCRONTAB-Ausdruck ähnelt einem CRON-Ausdruck, enthält jedoch am Anfang ein zusätzliches sechstes Feld für sekundengenaue Zeitangaben:

{second} {minute} {hour} {day} {month} {day-of-week}

Jedes Feld kann einen der folgenden Werttypen aufweisen:

Um Monate oder Tage anzugeben, können Sie numerische Werte, Namen oder Abkürzungen von Namen verwenden:

• Bei Tagen reichen die numerischen Werte von 0 bis 6, wobei die 0 für Sonntag steht.
• Die Namen werden auf Englisch angegeben. Beispiel: Monday, January.
• Bei Namen wird die Groß-/Kleinschreibung nicht berücksichtigt.
• Namen können abgekürzt werden. Es wird empfohlen, für Abkürzungen drei Buchstaben zu verwenden. Beispiel: Mon, Jan.

NCRONTAB-Beispiele

Die folgenden Beispiele zeigen NCRONTAB-Ausdrücke, die Sie für den Trigger mit Timer in Azure Functions verwenden können:

NCRONTAB-Zeitzonen

Die Zahlen in einem NCRONTAB-Ausdruck beziehen sich auf eine Uhrzeit und ein Datum, nicht auf einen Zeitraum. Beispielsweise bezieht sich eine 5 im Feld hour auf 5:00 Uhr, nicht auf alle 5 Stunden.

Als Standardzeitzone wird in Verbindung mit den CRON-Ausdrücken die Coordinated Universal Time (UTC) verwendet. Wenn Sie möchten, dass Ihr CRON-Ausdruck auf einer anderen Zeitzone basiert, erstellen Sie eine App-Einstellung für die Funktionen-App mit dem Namen WEBSITE_TIME_ZONE.

Der Wert dieser Einstellung hängt davon ab, unter welchem Betriebssystem und Plan Ihre Funktions-App ausgeführt wird.

Ein Beispiel: Für die Zeitzone „Eastern Time“ in den USA (dargestellt durch Eastern Standard Time unter Windows oder America/New_York unter Linux) wird derzeit UTC-05:00 in der Standardzeit und UTC-04:00 in der Sommerzeit verwendet. Damit ein Timertrigger jeden Tag um 10:00 vormittags in der Zeitzone „Eastern Time“ ausgelöst wird, erstellen Sie eine App-Einstellung für Ihre Funktions-App mit dem Namen WEBSITE_TIME_ZONE, legen den Wert auf Eastern Standard Time (Windows) bzw. America/New_York (Linux) fest, und verwenden dann den folgenden NCRONTAB-Ausdruck:

"0 0 10 * * *"

Wenn Sie WEBSITE_TIME_ZONE verwenden, wird die Uhrzeit an Abweichungen in der jeweiligen Zeitzone angepasst, einschließlich Sommerzeit und Änderungen an der Standardzeit.

TimeSpan

TimeSpan kann nur für eine Funktionen-App verwendet werden, die in einem App Service-Plan ausgeführt wird.

Im Gegensatz zu einem NCRONTAB-Ausdruck gibt ein TimeSpan Wert das Zeitintervall zwischen den einzelnen Funktionsaufrufen an. Wenn eine Funktion abgeschlossen wird, nachdem sie länger als über das angegebene Intervall ausgeführt wurde, ruft der Timer die Funktion sofort erneut auf.

Dieser Wert wird als Zeichenfolge ausgedrückt, und das TimeSpan-Format ist hh:mm:ss, wenn hh kleiner ist als 24. Wenn die ersten beiden Ziffern 24 oder höher sind, ist das Format dd:hh:mm. Im Folgenden finden Sie einige Beispiele:

Horizontales Skalieren

Wenn eine Funktionen-App auf mehrere Instanzen horizontal hochskaliert wird, wird nur eine einzige Instanz einer per Timer ausgelösten Funktion für alle Instanzen ausgeführt. Es wird nicht erneut ausgelöst, wenn noch ein ausstehender Aufruf ausgeführt wird.

Funktionen-Apps mit gemeinsamer Nutzung von Speicher

Wenn Sie Speicherkonten für Funktions-Apps freigeben, die nicht für App Service bereitgestellt sind, müssen Sie möglicherweise jeder App explizit die Host-ID zuweisen.

Sie können den identifizierenden Wert auslassen oder die identifizierende Konfiguration für jede Funktions-App manuell auf einen anderen Wert festlegen.

Der Trigger mit Timer verwendet eine Speichersperre, um sicherzustellen, dass nur eine Timerinstanz vorhanden ist, wenn eine Funktions-App auf mehrere Instanzen horizontal hochskaliert wird. Wenn zwei Funktions-Apps dieselbe identifizierende Konfiguration aufweisen und jede einen Trigger mit Timer verwendet, wird nur ein Timer ausgeführt.

Wiederholungsverhalten

Im Gegensatz zum Warteschlangentrigger führt der Trigger mit Timer nach dem Fehlschlagen einer Funktion keine Wiederholung aus. Wenn eine Funktion fehlerhaft ist, wird sie erst beim nächsten Termin im Zeitplan erneut aufgerufen.

Manuelles Aufrufen eines Triggers mit Timer

Der Trigger mit Timer für Azure Functions bietet einen HTTP-Webhook, der aufgerufen werden kann, um die Funktion manuell auszulösen. Dies kann in den folgenden Szenarios besonders hilfreich sein.

• Testen der Integration
• Slotaustausch im Rahmen einer Feuerprobe oder Aufwärmaktivität
• Anfängliche Bereitstellung einer Funktion zum sofortigen Auffüllen eines Caches oder einer Nachschlagetabelle in einer Datenbank

Details zum manuellen Aufrufen einer mit einem Timer ausgelösten Funktion finden Sie unter Manuelles Ausführen einer Funktion ohne HTTP-Trigger.

Problembehandlung

Informationen zur Behebung bei Problemen mit dem Zeitgebertrigger finden Sie unter Investigating and reporting issues with timer triggered functions not firing (Untersuchen und Melden von Problemen beim Auslösen zeitgesteuerter Triggerfunktionen).

Verbindungen

Timertrigger verfügen über eine implizite Abhängigkeit vom BLOB-Speicher, außer wenn sie lokal über die Azure Functions Core Tools ausgeführt werden. Das System verwendet BLOB-Speicher, um mehrere Instanzen zu koordinieren, wenn die App skaliert wird. Er greift mithilfe der Hostspeicherverbindung (AzureWebJobsStorage) auf BLOB-Speicher zu. Wenn Sie den Hostspeicher für die Verwendung einer identitätsbasierten Verbindung konfigurieren, sollte die Identität über die Rolle "Besitzer von Speicher-BLOB-Daten" verfügen. Dies ist die Standardanforderung für den Hostspeicher.

Nächste Schritte