Delen via

durable-functions package

Klassen

AggregatedError

Er is een specifieke fout opgetreden wanneer context.df.Task.all() mislukt. Het bericht bevat een aggregatie van alle uitzonderingen die zijn mislukt. Deze moet de onderstaande indeling volgen:

context.df.Task.all() heeft de onderstaande foutberichten aangetroffen:

Naam: DurableError Message: De activiteitsfunctie ActivityA is mislukt. StackTrace: <stacktrace>

Naam: DurableError Message: De activiteitsfunctie ActivityB is mislukt. StackTrace: <stacktrace>
DummyEntityContext

Een entiteitscontext met dummy-standaardwaarden om de Durable Functions-API te mocken/stubbing te vergemakkelijken.
DummyOrchestrationContext

Een indelingscontext met dummy-standaardwaarden om de Durable Functions-API te mocken/stubben.
DurableClient

Client voor het starten, opvragen, beëindigen en genereren van gebeurtenissen voor indeling en entiteitsexemplaren.
DurableError

Er is een specfic-fout opgetreden wanneer een geplande activiteit of suborchestrator is mislukt. Deze fout kan worden gecontroleerd via instanceof bewakers om alleen uitzonderingen te ondervangen die zijn gegenereerd door de DurableJS-bibliotheek.
DurableOrchestrationContext

Biedt functionaliteit voor toepassingscode voor het implementeren van een indelingsbewerking.
DurableOrchestrationStatus

Vertegenwoordigt de status van een durable orchestration-exemplaar.

Kan worden opgehaald met DurableClient.getStatus()
EntityId

Een unieke id voor een entiteit, bestaande uit entiteitsklasse en entiteitssleutel.
EntityStateResponse

Het antwoord dat wordt geretourneerd door DurableClient.readEntityState().
HttpManagementPayload

Gegevensstructuur met HTTP-eindpunten voor exemplaarbeheer.
ManagedIdentityTokenSource

Tokenbron-implementatie voor Azure Managed Identities.

voorbeeld van

Haal een lijst met Azure-abonnementen op door de HTTP-API van Azure Resource Manager aan te roepen.

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

Klasse voor het bewaren van statistieken over deze uitvoering van de opschoningsgeschiedenis. Het retourtype DurableClient.purgeHistory()
RetryOptions

Definieert beleid voor opnieuw proberen dat als parameters kan worden doorgegeven aan verschillende bewerkingen.

Interfaces

ActivityOptions
ActivityTrigger
CallHttpOptions

Optiesobject dat wordt verstrekt aan callHttp() methoden voor indelingscontexten
DurableClientInput
DurableClientOptions

Hiermee configureert u de invoer, uitvoer en handler voor een Durable Client-functie.
DurableEntityContext

Biedt functionaliteit voor het implementeren van een entiteitsbewerking met toepassingscode.
EntityContext

Contextobject doorgegeven aan entiteitsfuncties.
EntityOptions
EntityTrigger
GetStatusOptions

Opties-object doorgegeven aan client getStatus()-methode
HttpDurableClientOptions

Hiermee configureert u opties voor een door HTTP geactiveerde Durable Client-functie.
OrchestrationContext

Contextobject doorgegeven aan indelingsfuncties.
OrchestrationFilter

Optiesobject doorgegeven aan DurableClient-API's om indelingen te filteren waarop acties moeten worden uitgevoerd
OrchestrationOptions
OrchestrationTrigger
RegisteredActivityTask

Een Durable Functions-taak.
RegisteredOrchestrationTask

Een Durable Functions-taak.
StartNewOptions

Optiesobject dat is opgegeven als een optioneel tweede argument voor de methode client.startNew()
Task

Een Durable Functions-taak.
TaskHubOptions

Optiesobject doorgegeven aan DurableClient-API's om eigenschappen van de taakhub op te geven
TimerDurableClientOptions

Hiermee configureert u opties voor een door een timer geactiveerde Durable Client-functie.
TimerTask

Geretourneerd van DurableClient-.createTimer(Date) als de oproep niet is yield-ed. Vertegenwoordigt een timer die in behandeling is. Zie de documentatie over Taak voor meer informatie.

Alle timers die in behandeling zijn, moeten worden voltooid of geannuleerd om een indeling te voltooien.

voorbeeld van

Een timer annuleren

// 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();
}

voorbeeld van

Een time-out maken

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

Het optiesobject is doorgegeven aan de methode durableClient.waitForCompletionOrCreateCheckStatusResponse() om time-outs op te geven voor hoe lang moet worden gewacht op uitvoer van de duurzame functie en hoe vaak moet worden gecontroleerd op uitvoer.

Type-aliassen

ActivityHandler
DurableClientHandler

Type handler-functie die wordt geactiveerd door een bepaalde trigger en ontvangt een DurableClient--exemplaar als invoer.
EntityHandler
HttpDurableClientHandler
OrchestrationHandler

Type generator dat kan worden geregistreerd als indeling
RegisteredActivity
RegisteredOrchestration
TimerDurableClientHandler
TokenSource

Enums

OrchestrationRuntimeStatus

De status van een indelingsinstantie.

Functies

getClient(InvocationContext)

Hiermee wordt een OrchestrationClient-exemplaar geretourneerd.

Functiedetails

getClient(InvocationContext)

Hiermee wordt een OrchestrationClient-exemplaar geretourneerd.

function getClient(context: InvocationContext): DurableClient

Parameters

context
InvocationContext

Het contextobject van de Azure-functie waarvan de hoofdtekst deze methode aanroept.

Retouren

DurableClient