🏷️ Naming Conventions
Status: Work in Progress
This document outlines naming conventions for Azure Data Factory and related Azure resources used by the Integration team. It aims to ensure consistency, clarity, and maintainability across environments.
📘 Reference
For naming conventions not covered here, please refer to Microsoft’s official guidelines:
- Define your naming convention – Cloud Adoption Framework
- [Abbreviation recommendations for Azure resources](https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-abobject type prefix (see list below)
<description>= meaningful identifier<env>= environment (e.g.,dev,rec,int,prd)
Object Type Prefixes
| Prefix | Object Type |
|---|---|
adf | Azure Data Factory |
df | Data Flow |
dls | Data Lake Storage |
ds | Dataset |
fun | Function App |
key | Key Vault |
pl | Pipeline |
rg | Resource Group |
sto | Storage Account |
tr | Trigger |
ls | Linked Service |
mid | Managed Identity |
🔧 Azure Data Factory
Format: adf<project><env>
<project>= project/subproject abbreviation (see internal XLS list)<env>= environment (e.g.,dev,rec,int,prd)- No uppercase letters allowed.
Example: adfpimimportdev
Each ADF instance contains folders for subprojects.
📦 Pipeline
Format: pl<description><order>
<description>= short name (e.g.,GroupHierarchy)<order>= 3-digit sequence number
Example: plGroupHierarchy001
🔄 Data Flow
Format: df<description>
Example: dfGroupHierarchyPrepRefs
🗃️ Data Lake Storage
Format: dls<description><env>
<description>= e.g.,jdeaccess<env>= environment (e.g.,dev,prd)- No uppercase for pure Azure objects.
Example: dlsjdeaccessdev
📁 Dataset
Format: ds<description>
Example: dsBlobStoragePrqtConStg
⚙️ Function App
Format: fun<description><env>
Example: fungetunitconversiondev
🔐 Key Vault
Format: key<description><env>
Example: keybasewarevaultprd
Secret Naming Convention (to be defined)
Format: <app>--<type>--<subtype>
- Type:
Credentials,FunctionKey - Subtype:
ConnectionString,Endpoint,ClientId,ClientSecret
⚠️ Shared Key Vaults should not be modified per environment. Use hardcoded values in project configs if needed.
🔗 Linked Service
Format: ls<description>
Example: lsBloStoPrqtConStgPIM
👤 Managed Identity
Format: mid<resourcegroup><env>
Example: midrgdatalakedev
Note: Naming and usage scope of managed identities is under review (see TBON & Nicolas Engel).
🧩 To Be Defined
- Environment aliases (e.g.,
dev,rec,int,prd) - Naming silos for ADF and Key Vaults