Timertrigger voor Azure Functions

In dit artikel wordt uitgelegd hoe u werkt met timertriggers in Azure Functions. Met een timertrigger kunt u een functie volgens een schema uitvoeren.

Dit is referentie-informatie voor Azure Functions-ontwikkelaars. Als u nog geen ervaring hebt met Azure Functions, begint u met de volgende resources:

• Naslaginformatie over Azure Functions voor ontwikkelaars

• Concepten van Azure Functions-triggers en -bindingen

• Azure-functies lokaal programmeren en testen

Zie Handmatig een niet door HTTP geactiveerde functie uitvoeren voor meer informatie over het handmatig uitvoeren van een door een timer geactiveerde functie.

Ondersteuning voor deze binding wordt automatisch aangeboden in alle ontwikkelomgevingen. U hoeft het pakket niet handmatig te installeren of de uitbreiding te registreren.

Source code for the timer extension package is in the azure-webjobs-sdk-extensions GitHub repository.

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));
    logger.LogInformation($"Function Ran. Next timer schedule = {timerInfo.ScheduleStatus?.Next}");
}

[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=False) 
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"

When you're developing locally, add your application settings in the local.settings.json file in the Values collection.

See the Example section for complete examples.

Usage

Wanneer een timertriggerfunctie wordt aangeroepen, wordt een timerobject doorgegeven aan de functie. De volgende JSON is een voorbeeldweergave van het timerobject.

{
    "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
}

De isPastDue eigenschap is true wanneer de huidige functie aanroep later is dan gepland. Het opnieuw opstarten van een functie-app kan bijvoorbeeld ertoe leiden dat een aanroep wordt gemist.

NCRONTAB expressions

Azure Functions uses the NCronTab library to interpret NCRONTAB expressions. Een NCRONTAB-expressie is vergelijkbaar met een CRON-expressie, behalve dat deze een extra zesde veld aan het begin bevat voor tijdsprecisie in seconden:

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

Elk veld kan een van de volgende typen waarden hebben:

Als u maanden of dagen wilt opgeven, kunt u numerieke waarden, namen of afkortingen van namen gebruiken:

• Voor dagen zijn de numerieke waarden 0 tot 6, waarbij 0 begint met zondag.
• De namen zijn in het Engels. Bijvoorbeeld: Monday, January.
• Namen zijn niet hoofdlettergevoelig.
• Namen kunnen worden afgekort. U wordt aangeraden drie letters te gebruiken voor afkortingen. Bijvoorbeeld: Mon, Jan.

NCRONTAB examples

Hier volgen enkele voorbeelden van NCRONTAB-expressies die u kunt gebruiken voor de timertrigger in Azure Functions.

NCRONTAB-tijdzones

De getallen in een NCRONTAB-expressie verwijzen naar een tijd en datum, niet naar een tijdspanne. Een 5 in het hour veld verwijst bijvoorbeeld naar 5:00 uur, niet om de 5 uur.

De standaardtijdzone die wordt gebruikt met CRON-expressies is Coordinated Universal Time (UTC). Als u uw CRON-expressie wilt laten gebaseerd op een andere tijdzone, maakt u een app-instelling voor uw functie-app met de naam WEBSITE_TIME_ZONE.

De waarde van deze instelling is afhankelijk van het besturingssysteem en de planning waarop uw functie-app wordt uitgevoerd.

Eastern Time in de VS (vertegenwoordigd door Eastern Standard Time (Windows) of America/New_York (Linux)) gebruikt momenteel UTC-05:00 tijdens de standaardtijd en UTC-04:00 tijdens de zomertijd. Als u elke dag een timertrigger wilt activeren om 10:00 uur Eastern Time, maakt u een app-instelling voor uw functie-app met de naam WEBSITE_TIME_ZONE, stelt u de waarde Eastern Standard Time in op (Windows) of America/New_York (Linux) en gebruikt u vervolgens de volgende NCRONTAB-expressie:

"0 0 10 * * *"

Wanneer u gebruikt WEBSITE_TIME_ZONE, wordt de tijd aangepast voor tijdswijzigingen in de specifieke tijdzone, inclusief zomertijd en wijzigingen in de standaardtijd.

TimeSpan

Een TimeSpan kan alleen worden gebruikt voor een functie-app die wordt uitgevoerd op een App Service-plan.

In tegenstelling tot een NCRONTAB-expressie geeft een TimeSpan waarde het tijdsinterval aan tussen elke functieaanroep. Wanneer een functie is voltooid nadat deze langer is dan het opgegeven interval, roept de timer de functie onmiddellijk opnieuw aan.

Uitgedrukt als een tekenreeks, is TimeSpan de hh:mm:ss notatie kleiner hh dan 24. Wanneer de eerste twee cijfers 24 of hoger zijn, is dd:hh:mmde notatie . Hieronder volgen een aantal voorbeelden:

Scale-out

Als een functie-app wordt uitgeschaald naar meerdere exemplaren, wordt slechts één exemplaar van een door een timer geactiveerde functie uitgevoerd op alle exemplaren. Het wordt niet opnieuw geactiveerd als er nog een openstaande aanroep wordt uitgevoerd.

Functie-apps die opslag delen

Als u opslagaccounts deelt tussen functie-apps die niet zijn geïmplementeerd in App Service, moet u mogelijk expliciet host-id toewijzen aan elke app.

U kunt de identificatiewaarde weglaten of de identificatieconfiguratie van elke functie-app handmatig instellen op een andere waarde.

De timertrigger maakt gebruik van een opslagvergrendeling om ervoor te zorgen dat er slechts één timerexemplaren zijn wanneer een functie-app wordt uitgeschaald naar meerdere exemplaren. Als twee functie-apps dezelfde identificatieconfiguratie delen en elk een timertrigger gebruikt, wordt slechts één timer uitgevoerd.

Retry behavior

In tegenstelling tot de wachtrijtrigger wordt de timertrigger niet opnieuw geprobeerd nadat een functie is mislukt. Wanneer een functie mislukt, wordt deze pas de volgende keer in de planning aangeroepen.

Handmatig een timertrigger aanroepen

De timertrigger voor Azure Functions biedt een HTTP-webhook die kan worden aangeroepen om de functie handmatig te activeren. Dit kan zeer nuttig zijn in de volgende scenario's.

• Integration testing
• Sleufwisselingen als onderdeel van een betrouwbaarheidstest of opwarmactiviteit
• Initiële implementatie van een functie om onmiddellijk een cache of opzoektabel in een database te vullen

Raadpleeg een niet door HTTP geactiveerde functie handmatig uitvoeren voor meer informatie over het handmatig aanroepen van een door timer geactiveerde functie.

Troubleshooting

Zie Onderzoeken en rapporteren van problemen met door timer geactiveerde functies die niet worden geactiveerd voor meer informatie over wat u moet doen wanneer de timertrigger niet werkt zoals verwacht.

Connections

Timertriggers hebben een impliciete afhankelijkheid van blobopslag, behalve wanneer ze lokaal worden uitgevoerd via de Azure Functions Core Tools. Het systeem gebruikt blobopslag om meerdere exemplaren te coördineren wanneer de app wordt uitgeschaald. Het opent blobopslag met behulp van de hostopslagverbinding (AzureWebJobsStorage). If you configure the host storage to use an identity-based connection, the identity should have the Storage Blob Data Owner role, which is the default requirement for host storage.

Next steps