Azure Data Factory Series Part 1: Naming Conventions

It is quite important to give your ADF resources meaningful names and follow a consistent naming convention structure. The following suggestions proved to be practical in several projects.

We are eager to learn from you and your experiences so please leave your comment.

There are several types of resources in ADF:

  • Parameters, variables, and activities
  • Pipelines
  • Data Flows
  • Datasets
  • Linked Services
  • Triggers

Please find the naming conventions for the respective resource in the sections below.

Parameters, Variables, and Activities

Parameters and Variables

TypeName
ParameterDerived from Hungarian notation.

Identifier starts with par followed by data type and free text.

parStrFileName
VariableDerived from Hungarian notation.

Identifier starts with var followed by data type and free text.

varStrFileName
varArrFileNames
Parameters and Variables

Activites

TypeName
Set variableSETVAR followed by variable name and followed by the number of the occurrence in the pipeline.
Each portion of the name is separated by an underscore.
The first occurrence of activity SETVAR defining a particular variable starts at 1 and is then incremented with each occurrence.

Two times during a pipeline varStrApprovalNeeded is set to a different value:

SETVAR_varStrApprovalNeeded_1
SETVAR_varStrApprovalNeeded_2
LookupType of DDL statement (SELECT, INSERT, CALL) followed by an underscore followed by free text.
Each portion of the name is separated by an underscore.

SELECT_Approval_Needed
OthersKeyword (SWITCH, WEB, FUNC, etc.) followed by free text.
Each portion of the name is separated by an underscore.

FUNC_ETL_Python_Script
WEB_ETL_Python_Script
SWITCH_Equals
IF_Equals
Activites

Pipelines

TypeNameNumberingTextExamples
Data movement PL_DATA_Multiple levels,
separated by underscore
Free,
separated by underscore
Main pipeline:
PL_DATA_0_0_0_Main_Pipeline

Sub pipeline:
PL_DATA_0_1_0_Sub_Pipeline

Sub pipeline of sub pipeline:
PL_DATA_0_1_1_Sub_Sub_Pipeline
HelperPL_DATA_HELPER_NoKeyword HELPER
followed by free text, separated by underscore
PL_DATA_HELPER_SendMail
Naming conventions for Pipelines/Data Flows

Data Flows

TypeNameNumberingTextExamples
Data FlowPL_FLOW_Multiple levels,
separated by underscore
Free,
separated by underscore
PL_FLOW_0_0_0_Data_Flow
Naming conventions for Pipelines/Data Flows

Datasets

NameData StoreFormatTextExamples
DS_Four letters abbreviation of data storeFour letters abbreviation of formatFree textDS_BLOB_BINA_Sink

Linked Services

NameData StoreTextExamples
LN_Four letters abbreviation of data storeFree textLN_BLOB_itstorage

Triggers

NameTypeTextExamples
TR_Four letters abbreviation of type (SCHE, TUMB, STOR)Free textTR_STOR_itconsumption_datastorage_Approved_CSV