Condividi tramite

durable-functions package

Classi

AggregatedError

Errore specifico generato quando context.df.Task.all() ha esito negativo. Il messaggio contiene un'aggregazione di tutte le eccezioni non riuscite. Deve seguire il formato seguente:

context.df.Task.all() ha rilevato i messaggi di errore seguenti:

Nome: DurableError Message: la funzione di attività "ActivityA" non è riuscita. StackTrace: <stacktrace>

Nome: DurableError Message: la funzione di attività "ActivityB" non è riuscita. StackTrace: <stacktrace>
DummyEntityContext

Contesto di entità con valori predefiniti fittizi per facilitare il mocking/stubing dell'API Durable Functions.
DummyOrchestrationContext

Contesto di orchestrazione con valori predefiniti fittizi per facilitare il mocking/stubing dell'API Durable Functions.
DurableClient

Client per l'avvio, l'esecuzione di query, la terminazione e la generazione di eventi alle istanze di orchestrazione ed entità.
DurableError

Errore specfic generato quando un'attività pianificata o un suborchestrator non è riuscita. Questo errore può essere verificato tramite instanceof guardie per rilevare solo le eccezioni generate dalla libreria DurableJS.
DurableOrchestrationContext

Fornisce funzionalità per il codice dell'applicazione che implementa un'operazione di orchestrazione.
DurableOrchestrationStatus

Rappresenta lo stato di un'istanza di orchestrazione durevole.

Può essere recuperato usando DurableClient.getStatus()
EntityId

Identificatore univoco per un'entità costituita da classe di entità e chiave di entità.
EntityStateResponse

Risposta restituita da DurableClient.readEntityState().
HttpManagementPayload

Struttura di dati contenente gli endpoint HTTP di gestione delle istanze.
ManagedIdentityTokenSource

Implementazione dell'origine del token per identità gestite di Azure.

esempio di

Ottenere un elenco di sottoscrizioni di Azure chiamando l'API HTTP di Azure Resource Manager.

const df = require("durable-functions");

df.app.orchestration(function* (context) {
  return yield context.df.callHttp({
      method: "GET",
      url: "https://management.azure.com/subscriptions?api-version=2019-06-01",
      tokenSource: df.ManagedIdentityTokenSource("https://management.core.windows.net"),
  });
});
PurgeHistoryResult

Classe per contenere statistiche su questa esecuzione della cronologia di ripulitura. Tipo restituito di DurableClient.purgeHistory()
RetryOptions

Definisce i criteri di ripetizione dei tentativi che possono essere passati come parametri a varie operazioni.

Interfacce

ActivityOptions
ActivityTrigger
CallHttpOptions

Oggetto Options fornito ai metodi di callHttp() sui contesti di orchestrazione
DurableClientInput
DurableClientOptions

Configura gli input, gli output e il gestore per una funzione Durable Client.
DurableEntityContext

Fornisce funzionalità per il codice dell'applicazione che implementa un'operazione di entità.
EntityContext

Oggetto context passato a Funzioni di entità.
EntityOptions
EntityTrigger
GetStatusOptions

Oggetto Options passato al metodo getStatus() client
HttpDurableClientOptions

Configura le opzioni per una funzione Durable Client attivata da HTTP.
OrchestrationContext

Oggetto context passato alle funzioni di orchestrazione.
OrchestrationFilter

Oggetto Options passato alle API DurableClient per filtrare le orchestrazioni su cui eseguire azioni
OrchestrationOptions
OrchestrationTrigger
RegisteredActivityTask

Attività Durable Functions.
RegisteredOrchestrationTask

Attività Durable Functions.
StartNewOptions

Oggetto Options fornito come secondo argomento facoltativo per il metodo client.startNew()
Task

Attività Durable Functions.
TaskHubOptions

Oggetto Options passato alle API DurableClient per specificare le proprietà dell'hub attività
TimerDurableClientOptions

Configura le opzioni per una funzione Durable Client attivata dal timer.
TimerTask

Restituito da DurableClient.createTimer(Date) se la chiamata non è yield-ed. Rappresenta un timer in sospeso. Per altre informazioni, vedere la documentazione su Task.

Per il completamento di un'orchestrazione, è necessario completare o annullare tutti i timer in sospeso.

esempio di

Annullare un timer

// calculate expiration date
const timeoutTask = context.df.createTimer(expirationDate);

// do some work

if (!timeoutTask.isCompleted) {
    // An orchestration won't get marked as completed until all its scheduled
    // tasks have returned, or been cancelled. Therefore, it is important
    // to cancel timers when they're no longer needed
    timeoutTask.cancel();
}

esempio di

Creare un timeout

const now = Date.now();
const expiration = new Date(now.valueOf()).setMinutes(now.getMinutes() + 30);

const timeoutTask = context.df.createTimer(expirationDate);
const otherTask = context.df.callActivity("DoWork");

const winner = yield context.df.Task.any([timeoutTask, otherTask]);

if (winner === otherTask) {
    // do some more work
}

if (!timeoutTask.isCompleted) {
    // An orchestration won't get marked as completed until all its scheduled
    // tasks have returned, or been cancelled. Therefore, it is important
    // to cancel timers when they're no longer needed
    timeoutTask.cancel();
}
WaitForCompletionOptions

Oggetto Options passato al metodo durableClient.waitForCompletionOrCreateCheckStatusResponse() per specificare i timeout per quanto tempo attendere l'output dalla funzione durevole e la frequenza con cui verificare la presenza di output.

Alias tipo

ActivityHandler
DurableClientHandler

Tipo di una funzione del gestore attivata da alcuni trigger e riceve un'istanza DurableClient come input.
EntityHandler
HttpDurableClientHandler
OrchestrationHandler

Tipo di generatore che può essere registrato come orchestrazione
RegisteredActivity
RegisteredOrchestration
TimerDurableClientHandler
TokenSource

Enumerazioni

OrchestrationRuntimeStatus

Stato di un'istanza di orchestrazione.

Funzioni

getClient(InvocationContext)

Restituisce un'istanza di OrchestrationClient.

Dettagli funzione

getClient(InvocationContext)

Restituisce un'istanza di OrchestrationClient.

function getClient(context: InvocationContext): DurableClient

Parametri

context
InvocationContext

Oggetto contesto della funzione di Azure il cui corpo chiama questo metodo.

Restituisce

DurableClient