Partilhar via


durable-functions package

Classes

AggregatedError

Um erro específico gerado quando context.df.Task.all() falha. Sua mensagem contém uma agregação de todas as exceções que falharam. Deve seguir o formato abaixo:

context.df.Task.all() encontrou as mensagens de erro abaixo:

Nome: DurableError Message: A função de atividade "ActivityA" falhou. StackTrace: <stacktrace>

Nome: DurableError Message: A função de atividade "ActivityB" falhou. StackTrace: <stacktrace>

DummyEntityContext

Um contexto de entidade com valores padrão fictícios para facilitar a simulação/stubbing da API de Funções Duráveis.

DummyOrchestrationContext

Um contexto de orquestração com valores padrão fictícios para facilitar a simulação/stubbing da API de Funções Duráveis.

DurableClient

Cliente para iniciar, consultar, encerrar e elevar eventos para orquestração e instâncias de entidade.

DurableError

Um erro específico lançado quando uma atividade agendada ou um suborquestrador falhou. Este erro pode ser verificado através de instanceof guardas para capturar apenas exceções lançadas pela biblioteca DurableJS.

DurableOrchestrationContext

Fornece funcionalidade para código de aplicativo implementando uma operação de orquestração.

DurableOrchestrationStatus

Representa o status de uma instância de orquestração durável.

Pode ser obtido usando DurableClient.getStatus()

EntityId

Um identificador exclusivo para uma entidade, que consiste em classe de entidade e chave de entidade.

EntityStateResponse

A resposta retornada por DurableClient.readEntityState().

HttpManagementPayload

Estrutura de dados contendo pontos de extremidade HTTP de gerenciamento de instâncias.

ManagedIdentityTokenSource

Implementação de Origem de Token para Identidades Gerenciadas do Azure.

Exemplo

Obtenha uma lista de Assinaturas do Azure chamando a API HTTP do 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 para armazenar estatísticas sobre esta execução do histórico de purga. O tipo de retorno de DurableClient.purgeHistory()

RetryOptions

Define políticas de repetição que podem ser passadas como parâmetros para várias operações.

Interfaces

ActivityOptions
ActivityTrigger
CallHttpOptions

Objeto Options fornecido para métodos de callHttp() em contextos de orquestração

DurableClientInput
DurableClientOptions

Configura as entradas, saídas e manipulador para uma função Durable Client.

DurableEntityContext

Fornece funcionalidade para código de aplicativo implementando uma operação de entidade.

EntityContext

Objeto de contexto passado para funções de entidade.

EntityOptions
EntityTrigger
GetStatusOptions

Objeto Options passado para o método getStatus() cliente

HttpDurableClientOptions

Configura opções para uma função de Cliente Durável acionada por HTTP.

OrchestrationContext

Objeto de contexto passado para funções de orquestração.

OrchestrationFilter

Objeto Options passado para APIs DurableClient para filtrar orquestrações nas quais executar ações

OrchestrationOptions
OrchestrationTrigger
RegisteredActivityTask

Uma tarefa de funções duráveis.

RegisteredOrchestrationTask

Uma tarefa de funções duráveis.

StartNewOptions

Options objeto fornecido como um segundo argumento opcional para o método client.startNew()

Task

Uma tarefa de funções duráveis.

TaskHubOptions

Objeto Options passado para APIs DurableClient para especificar propriedades do hub de tarefas

TimerDurableClientOptions

Configura opções para uma função de Cliente Durável acionada por temporizador.

TimerTask

Retornado de DurableClient.createTimer(Date) se a chamada não estiver yield-ed. Representa um temporizador pendente. Consulte a documentação em de Tarefas para obter mais informações.

Todos os temporizadores pendentes devem ser concluídos ou cancelados para que uma orquestração seja concluída.

Exemplo

Cancelar um temporizador

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

Exemplo

Criar um tempo limite

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

Options objeto passado para o método durableClient.waitForCompletionOrCreateCheckStatusResponse() para especificar tempos limite para quanto tempo esperar pela saída da função durável e com que frequência verificar a saída.

Aliases de Tipo

ActivityHandler
DurableClientHandler

Tipo de uma função de manipulador que é acionada por algum gatilho e recebe um instância de DurableClient como uma entrada.

EntityHandler
HttpDurableClientHandler
OrchestrationHandler

Tipo de gerador que pode ser registrado como orquestração

RegisteredActivity
RegisteredOrchestration
TimerDurableClientHandler
TokenSource

Enumerações

OrchestrationRuntimeStatus

O status de uma instância de orquestração.

Funções

getClient(InvocationContext)

Retorna uma instância OrchestrationClient.

Detalhes de Função

getClient(InvocationContext)

Retorna uma instância OrchestrationClient.

function getClient(context: InvocationContext): DurableClient

Parâmetros

context
InvocationContext

O objeto de contexto da função do Azure cujo corpo chama esse método.

Devoluções