Variáveis do sistema com suporte do Azure Data Factory e do Azure Synapse Analytics

  • Artigo

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Dica

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

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

Escopo do pipeline

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

Nome da variável Descrição
@pipeline().DataFactory Nome dos dados ou do workspace do Synapse em que a execução de pipeline está ocorrendo
@pipeline().Pipeline Nome do pipeline
@pipeline().RunId ID da execução do pipeline específica
@pipeline().TriggerType O tipo de gatilho que invocou o pipeline (por exemplo, ScheduleTrigger, BlobEventsTrigger). Para ver uma lista dos tipos de gatilho com suporte, confira Execução de pipeline e gatilhos. 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 invocou o pipeline
@pipeline().TriggerTime Horário de execução de gatilho que invocou o pipeline. Esse é o horário em que o gatilho realmente foi disparado para invocar a execução de pipeline e pode ser ligeiramente diferente do horário agendado do gatilho.
@pipeline().GroupId ID do grupo ao qual a execução de pipeline pertence.
@pipeline()?.TriggeredByPipelineName Nome do pipeline que aciona a execução de pipeline. Aplicável quando a execução de 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 de pipeline que aciona a execução de pipeline. Aplicável quando a execução de pipeline é acionada por uma atividade ExecutePipeline. Avalie como Nulo quando usado em outras circunstâncias. Observe o ponto de interrogação após @pipeline()

Observação

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

Escopo do gatilho de agendamento

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

Nome da variável Descrição
@trigger().scheduledTime Hora em que o gatilho foi agendado para invocar a execução de pipeline.
@trigger().startTime Hora em que o gatilho realmente foi disparado para invocar a execução de pipeline. Isso pode ser ligeiramente diferente do horário agendado do gatilho.

Escopo do gatilho periódico

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

Nome da variável Descrição
@trigger().outputs.windowStartTime Início da janela associada à execução de gatilho.
@trigger().outputs.windowEndTime Fim da janela associada à execução de gatilho.
@trigger().scheduledTime Hora em que o gatilho foi agendado para invocar a execução de pipeline.
@trigger().startTime Hora em que o gatilho realmente foi disparado para invocar a execução de pipeline. Isso pode ser ligeiramente diferente do horário agendado do gatilho.

Escopo do gatilho de evento de armazenamento

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

Nome da variável Descrição
@triggerBody().fileName Nome do arquivo cuja criação ou exclusão fez com que o gatilho fosse disparado.
@triggerBody().folderPath Caminho para a pasta que contém o arquivo especificado por @triggerBody().fileName. O primeiro segmento do caminho da pasta é o nome do contêiner de Armazenamento de Blob do Azure.
@trigger().startTime Hora em que o gatilho foi disparado para invocar a execução de pipeline.

Observação

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 do gatilho para gatilhos do tipo CustomEventsTrigger.

Observação

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

Nome da variável Descrição
@triggerBody().event.eventType Tipo de eventos que acionam a execução do Gatilho de evento personalizado. O tipo de evento é um campo definido pelo cliente e assume quaisquer valores de tipo de sequência de caracteres.
@triggerBody().event.subject Assunto do evento personalizado que fez com que o gatilho fosse disparado.
@triggerBody().event.data._keyName_ O campo de dados no evento personalizado é um blob do JSON gratuito, que pode ser usado pelo cliente para enviar mensagens e dados. Use os dados. KeyName para referenciar cada campo. Por exemplo, @triggerBody().event.data.callback retorna o valor para o campo de retorno de chamada armazenado em dados.
@trigger().startTime Hora em que o gatilho foi disparado para invocar a execução de pipeline.

Conteúdo relacionado