Partilhar via

Variáveis de sistema suportadas pelo Azure Data Factory e Azure Synapse Analytics

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Tip

Experimente o Data Factory no Microsoft Fabric, uma solução de análise tudo-em-um para empresas. O Microsoft Fabric abrange tudo, desde a movimentação de dados até ciência de dados, análises em tempo real, business intelligence e relatórios. Saiba como iniciar uma nova avaliação gratuitamente!

Este artigo descreve as variáveis de sistema suportadas pelo Azure Data Factory e Azure Synapse. Você pode usar essas variáveis em expressões ao definir entidades dentro de qualquer serviço.

Pipeline scope

Essas variáveis de sistema podem ser referenciadas em qualquer lugar no pipeline JSON.

Variable Name Description
@pipeline().DataFactory Nome dos dados ou espaço de trabalho Synapse em que a execução do pipeline está ocorrendo.
@pipeline().Pipeline Nome do gasoduto
@pipeline().RunId ID da execução específica do pipeline
@pipeline().TriggerType O tipo de gatilho que invocou o pipeline (por exemplo, ScheduleTrigger, BlobEventsTrigger). Para obter uma lista dos tipos de gatilho suportados, consulte Execução e gatilhos de pipeline. Um tipo de gatilho de Manual indica que o pipeline foi acionado manualmente.
@pipeline().TriggerId ID do gatilho que invocou o pipeline
@pipeline().TriggerName Nome do gatilho que acionou o pipeline
@pipeline().TriggerTime Hora da execução do gatilho que invocou o pipeline. Este é o momento em que o gatilho realmente disparou para invocar a execução do pipeline, e pode diferir ligeiramente do tempo agendado do gatilho.
@pipeline().GroupId ID do grupo ao qual a execução do pipeline pertence.
@pipeline()?.TriggeredByPipelineName Nome do pipeline que aciona a execução do processo. Aplicável quando a execução do pipeline é acionada por uma atividade ExecutePipeline. Avalie como Nulo quando usado em outras circunstâncias. Observe o ponto de interrogação após @pipeline()
@pipeline()?.TriggeredByPipelineRunId ID de execução do pipeline que dispara a execução do pipeline. Aplicável quando a execução do pipeline é acionada por uma atividade ExecutePipeline. Avalie como Nulo quando usado em outras circunstâncias. Observe o ponto de interrogação após @pipeline()

Note

As variáveis do sistema relacionadas à data/hora do disparador (tanto nos escopos de pipeline quanto de disparador) retornam datas UTC no formato ISO 8601, por exemplo, 2017-06-01T22:20:00.4061448Z.

Âmbito do disparador de agendamento

Essas variáveis de sistema podem ser referenciadas em qualquer lugar no JSON de gatilho para gatilhos do tipo ScheduleTrigger.

Variable Name Description
@trigger().scheduledTime Hora em que o gatilho foi agendado para acionar a execução do pipeline.
@trigger().startTime Momento em que o gatilho realmente disparou para iniciar a execução do pipeline. Isso pode diferir ligeiramente do horário agendado do gatilho.

Escopo do gatilho da janela deslizante

Essas variáveis de sistema podem ser referenciadas em qualquer lugar no JSON de gatilho para gatilhos do tipo TumblingWindowTrigger.

Variable Name Description
@trigger().outputs.windowStartTime Início da janela associada ao disparo do gatilho.
@trigger().outputs.windowEndTime Fim da janela associada à execução do gatilho.
@trigger().scheduledTime Hora em que o gatilho foi agendado para acionar a execução do pipeline.
@trigger().startTime Momento em que o gatilho realmente disparou para iniciar a execução do pipeline. Isso pode diferir ligeiramente do horário agendado do gatilho.

Escopo do acionador de eventos de armazenamento

Essas variáveis de sistema podem ser referenciadas em qualquer lugar no JSON de gatilho para gatilhos do tipo BlobEventsTrigger.

Variable Name Description
@triggerBody().fileName Nome do arquivo cuja criação ou exclusão causou o disparo do gatilho.
@triggerBody().folderPath Caminho para a pasta que contém o arquivo especificado pelo @triggerBody().fileName. O primeiro segmento do caminho da pasta é o nome do contentor de Armazenamento de Blobs do Azure.
@trigger().startTime Momento em que o gatilho disparou para invocar a execução do pipeline.

Note

Se você estiver criando seu pipeline e gatilho no Azure Synapse Analytics, deverá usar @trigger().outputs.body.fileName e @trigger().outputs.body.folderPath como parâmetros. Essas duas propriedades capturam informações de blob. Use essas propriedades em vez de usar @triggerBody().fileName e @triggerBody().folderPath.

Escopo do gatilho de evento personalizado

Essas variáveis de sistema podem ser referenciadas em qualquer lugar no JSON de gatilho para gatilhos do tipo CustomEventsTrigger.

Note

O serviço espera que os eventos personalizados sejam formatados com o esquema de eventos da Grade de Eventos do Azure.

Variable Name Description
@triggerBody().event.eventType Tipo de eventos que ativaram o Gatilho de Evento Personalizado. Tipo de evento é um campo definido pelo cliente e pode ter quaisquer valores do tipo string.
@triggerBody().event.subject Assunto do evento personalizado que causou a ativação do gatilho.
@triggerBody().event.data._keyName_ O campo de dados no evento personalizado é um blob JSON livremente utilizável, que o cliente pode usar para enviar mensagens e dados. Utilize dados. keyName para fazer referência a cada campo. Por exemplo, @triggerBody().event.data.callback retorna o valor do campo de retorno de chamada armazenado em dados.
@trigger().startTime Momento em que o gatilho disparou para invocar a execução do pipeline.

Note

Se estiver a criar o teu pipeline e gatilho no Azure Synapse Analytics, deves usar @trigger().outputs.body.event como parâmetros. Esta propriedade captura informações sobre eventos. Use esta propriedade em vez de usar @triggerBody().event.

Related content

  • Last updated on