Variables système prises en charge par Azure Data Factory et Azure Synapse Analytics

  • Article

S’APPLIQUE À : Azure Data Factory Azure Synapse Analytics

Conseil

Essayez Data Factory dans Microsoft Fabric, une solution d’analyse tout-en-un pour les entreprises. Microsoft Fabric couvre tous les aspects, du déplacement des données à la science des données, en passant par l’analyse en temps réel, l’aide à la décision et la création de rapports. Découvrez comment démarrer un nouvel essai gratuitement !

Cet article décrit les variables système prises en charge par Azure Data Factory et Azure Synapse. Vous pouvez utiliser ces variables dans des expressions lors de la définition d’entités dans l’un ou l’autre service.

Étendue du pipeline

Ces variables système peuvent être référencées n’importe où dans le code JSON de pipeline.

Nom de la variable Description
@pipeline().DataFactory Nom de la fabrique de données ou de l’espace de travail Synapse dans lequel s’effectue l’exécution de pipeline
@pipeline().Pipeline Nom du pipeline
@pipeline().RunId ID de l’exécution du pipeline spécifique
@pipeline().TriggerType Type du déclencheur qui a appelé le pipeline (par exemple ScheduleTrigger ou BlobEventsTrigger). Pour connaître la liste des types de déclencheurs pris en charge, consultez Exécution de pipeline et déclencheurs. Le type de déclencheur Manual indique que le pipeline a été déclenché manuellement.
@pipeline().TriggerId ID du déclencheur qui a appelé le pipeline.
@pipeline().TriggerName Nom du déclencheur qui a appelé le pipeline.
@pipeline().TriggerTime Heure de l’exécution du déclencheur qui a appelé le pipeline. Il s’agit de l’heure à laquelle le déclencheur s’est réellement déclenché pour appeler l’exécution du pipeline. Elle peut différer légèrement de l’heure planifiée du déclencheur.
@pipeline().GroupId ID du groupe auquel appartient l’exécution du pipeline.
@pipeline()?.TriggeredByPipelineName Nom du pipeline qui déclenche l’exécution du pipeline. Applicable lorsque l’exécution du pipeline est déclenchée par une activité ExecutePipeline. Donne la valeur Null lorsqu’elle est utilisée dans d’autres circonstances. Notez le point d’interrogation après @pipeline()
@pipeline()?.TriggeredByPipelineRunId ID d’exécution du pipeline qui déclenche l’exécution du pipeline. Applicable lorsque l’exécution du pipeline est déclenchée par une activité ExecutePipeline. Donne la valeur Null lorsqu’elle est utilisée dans d’autres circonstances. Notez le point d’interrogation après @pipeline()

Notes

Les variables système de date/heure liées aux déclencheurs (dans la portée du pipeline ou dans celle du déclencheur) retournent des dates UTC au format ISO 8601, par exemple 2017-06-01T22:20:00.4061448Z.

Étendue de déclencheur de planification

Il est possible de faire référence à ces variables système n’importe où dans les déclencheurs JSON de type ScheduleTrigger.

Nom de la variable Description
@trigger().scheduledTime Heure à laquelle le déclencheur a été planifié pour appeler l’exécution du pipeline.
@trigger().startTime Heure à laquelle le déclencheur s’est réellement déclenché pour appeler l’exécution du pipeline. Elle peut différer légèrement de l’heure planifiée du déclencheur.

Étendue de déclencheur de fenêtre bascule

Il est possible de faire référence à ces variables système n’importe où dans les déclencheurs JSON de type TumblingWindowTrigger.

Nom de la variable Description
@trigger().outputs.windowStartTime Début de la fenêtre associée à l’exécution du déclencheur.
@trigger().outputs.windowEndTime Fin de la fenêtre associée à l’exécution du déclencheur.
@trigger().scheduledTime Heure à laquelle le déclencheur a été planifié pour appeler l’exécution du pipeline.
@trigger().startTime Heure à laquelle le déclencheur s’est réellement déclenché pour appeler l’exécution du pipeline. Elle peut différer légèrement de l’heure planifiée du déclencheur.

Étendue du déclencheur d’événements de stockage

Il est possible de faire référence à ces variables système n’importe où dans les déclencheurs JSON de type BlobEventsTrigger.

Nom de la variable Description
@triggerBody().fileName Nom du fichier dont la création ou la suppression a entraîné le déclenchement du déclencheur.
@triggerBody().folderPath Chemin du dossier contenant le fichier spécifié par @triggerBody().fileName. Le premier segment du chemin du dossier correspond au nom du conteneur de Stockage Blob Azure.
@trigger().startTime Heure à laquelle le déclencheur s’est déclenché pour appeler l’exécution du pipeline.

Notes

Si vous créez votre pipeline et votre déclencheur dans Azure Synapse Analytics, vous devez utiliser @trigger().outputs.body.fileName et @trigger().outputs.body.folderPath en guise de paramètres. Ces deux propriétés capturent les informations BLOB. Utilisez ces propriétés au lieu de @triggerBody().fileName et @triggerBody().folderPath.

Étendue du déclencheur d’événements peresonnalisé

Il est possible de faire référence à ces variables système n’importe où dans le déclencheur JSON de type CustomEventsTrigger.

Notes

Le service s’attend à ce que les événements personnalisés soient mis en forme avec le schéma d’événement Azure Event Grid.

Nom de la variable Description
@triggerBody().event.eventType Type d’événements ayant déclenché l’exécution du déclencheur d’événements personnalisé. Le type d’événement est un champ défini par le client et il prend n’importe quelle valeur de type chaîne.
@triggerBody().event.subject Objet de l’événement personnalisé qui provoque le déclenchement du déclencheur.
@triggerBody().event.data._keyName_ Le champ de données dans un événement personnalisé est un Blob gratuit à partir du Blob JSON, que le client peut utiliser pour envoyer des messages et des données. Utilisez data.keyName pour faire référence à chaque champ. Par exemple, @triggerBody().event.data.callback retourne la valeur du champ rappel stocké sous données.
@trigger().startTime Heure à laquelle le déclencheur s’est déclenché pour appeler l’exécution du pipeline.

Contenu connexe