# azure/azurenamingtool architecture

> Architecture diagram of the GitHub repository azure/azurenamingtool, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/azure/azurenamingtool
- Repository: https://github.com/azure/azurenamingtool

## Overview

Azure Naming Tool lets administrators manage naming conventions and users generate compliant Azure resource names. The principal flow is user request → naming API → naming service, which assembles configured components and applies resource-type rules; the tool also exposes administration, policy, import/export, and Azure validation capabilities. Storage is configurable, with SQLite and filesystem implementations represented in the tree. Several capabilities are unsampled, so their nodes are included but their internal connections are not inferred.

Main entry points: [`src/Services/ResourceNamingRequestService.cs`](https://github.com/azure/azurenamingtool/blob/main/src/Services/ResourceNamingRequestService.cs) (Name generation), [`src/Data/ConfigurationDbContext.cs`](https://github.com/azure/azurenamingtool/blob/main/src/Data/ConfigurationDbContext.cs) (Configuration context), [`src/Controllers/V2/AdminController.cs`](https://github.com/azure/azurenamingtool/blob/main/src/Controllers/V2/AdminController.cs) (Administration API), [`src/Repositories/SQLiteConfigurationRepository.cs`](https://github.com/azure/azurenamingtool/blob/main/src/Repositories/SQLiteConfigurationRepository.cs) (SQLite storage)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API"]
  node_naming_api["Naming API"]
  node_admin_api["Administration API<br/>[AdminController.cs]"]
  node_resource_api["Resource APIs"]
  node_import_export["Import/export API"]
  node_policy_api["Policy API"]
end

subgraph group_naming["Naming"]
  node_naming_service["Name generation"]
  node_name_rules["Resource type rules<br/>[ResourceType.cs]"]
  node_name_results["Generated names<br/>[GeneratedName.cs]"]
  node_azure_validation["Azure validation"]
  node_conflict_resolution["Conflict resolution"]
end

subgraph group_admin["Configuration"]
  node_config_services["Configuration services"]
  node_custom_components["Custom components<br/>[CustomComponent.cs]"]
  node_admin_logs["Admin logging"]
end

subgraph group_storage["Persistence"]
  node_config_db[("Configuration context")]
  node_config_repository["Configuration repository"]
  node_sqlite_storage["SQLite storage"]
  node_filesystem_storage["Filesystem storage"]
end

node_user(("Administrator or user"))

node_user -.->|"requests a name"| node_naming_api
node_naming_api -->|"dispatches to"| node_naming_service
node_naming_service -->|"uses rules"| node_name_rules
node_naming_service -->|"uses validation"| node_azure_validation
node_naming_service -->|"uses resolution"| node_conflict_resolution
node_admin_api -->|"records activity"| node_admin_logs
node_admin_api -->|"manages history"| node_name_results
node_resource_api -->|"dispatches to"| node_config_services
node_config_db -->|"maps entity"| node_name_rules
node_config_db -->|"maps entity"| node_custom_components
node_config_db -->|"maps entity"| node_name_results
node_sqlite_storage -->|"implements"| node_config_repository
node_sqlite_storage -->|"uses context"| node_config_db
node_filesystem_storage -.->|"implements"| node_config_repository

click node_naming_api "https://github.com/azure/azurenamingtool/blob/main/src/Controllers/V2/ResourceNamingRequestsController.cs"
click node_admin_api "https://github.com/azure/azurenamingtool/blob/main/src/Controllers/V2/AdminController.cs"
click node_resource_api "https://github.com/azure/azurenamingtool/blob/main/src/Controllers/V2/ResourceEnvironmentsController.cs"
click node_import_export "https://github.com/azure/azurenamingtool/blob/main/src/Controllers/V2/ImportExportController.cs"
click node_policy_api "https://github.com/azure/azurenamingtool/blob/main/src/Controllers/V2/PolicyController.cs"
click node_naming_service "https://github.com/azure/azurenamingtool/blob/main/src/Services/ResourceNamingRequestService.cs"
click node_name_rules "https://github.com/azure/azurenamingtool/blob/main/src/Models/ResourceType.cs"
click node_name_results "https://github.com/azure/azurenamingtool/blob/main/src/Models/GeneratedName.cs"
click node_azure_validation "https://github.com/azure/azurenamingtool/blob/main/src/Services/AzureValidationService.cs"
click node_conflict_resolution "https://github.com/azure/azurenamingtool/blob/main/src/Services/ConflictResolutionService.cs"
click node_config_services "https://github.com/azure/azurenamingtool/blob/main/src/Services/ResourceConfigurationCoordinator.cs"
click node_custom_components "https://github.com/azure/azurenamingtool/blob/main/src/Models/CustomComponent.cs"
click node_admin_logs "https://github.com/azure/azurenamingtool/blob/main/src/Services/Interfaces/IAdminLogService.cs"
click node_config_db "https://github.com/azure/azurenamingtool/blob/main/src/Data/ConfigurationDbContext.cs"
click node_config_repository "https://github.com/azure/azurenamingtool/blob/main/src/Repositories/Interfaces/IConfigurationRepository.cs"
click node_sqlite_storage "https://github.com/azure/azurenamingtool/blob/main/src/Repositories/SQLiteConfigurationRepository.cs"
click node_filesystem_storage "https://github.com/azure/azurenamingtool/blob/main/src/Repositories/Implementation/FileSystem/JsonFileConfigurationRepository.cs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_naming_api,node_admin_api,node_resource_api,node_import_export,node_policy_api,node_user toneBlue
class node_naming_service,node_name_rules,node_name_results,node_azure_validation,node_conflict_resolution toneAmber
class node_config_services,node_custom_components,node_admin_logs toneMint
class node_config_db,node_config_repository,node_sqlite_storage,node_filesystem_storage toneRose
```

## Components

### API

- [Naming API](https://github.com/azure/azurenamingtool/blob/main/src/Controllers/V2/ResourceNamingRequestsController.cs): `src/Controllers/V2/ResourceNamingRequestsController.cs`
- [Administration API](https://github.com/azure/azurenamingtool/blob/main/src/Controllers/V2/AdminController.cs): `src/Controllers/V2/AdminController.cs`
- [Resource APIs](https://github.com/azure/azurenamingtool/blob/main/src/Controllers/V2/ResourceEnvironmentsController.cs): `src/Controllers/V2/ResourceEnvironmentsController.cs`
- [Import/export API](https://github.com/azure/azurenamingtool/blob/main/src/Controllers/V2/ImportExportController.cs): `src/Controllers/V2/ImportExportController.cs`
- [Policy API](https://github.com/azure/azurenamingtool/blob/main/src/Controllers/V2/PolicyController.cs): `src/Controllers/V2/PolicyController.cs`

### Naming

- [Name generation](https://github.com/azure/azurenamingtool/blob/main/src/Services/ResourceNamingRequestService.cs): `src/Services/ResourceNamingRequestService.cs`
- [Resource type rules](https://github.com/azure/azurenamingtool/blob/main/src/Models/ResourceType.cs): `src/Models/ResourceType.cs`
- [Generated names](https://github.com/azure/azurenamingtool/blob/main/src/Models/GeneratedName.cs): `src/Models/GeneratedName.cs`
- [Azure validation](https://github.com/azure/azurenamingtool/blob/main/src/Services/AzureValidationService.cs): `src/Services/AzureValidationService.cs`
- [Conflict resolution](https://github.com/azure/azurenamingtool/blob/main/src/Services/ConflictResolutionService.cs): `src/Services/ConflictResolutionService.cs`

### Configuration

- [Configuration services](https://github.com/azure/azurenamingtool/blob/main/src/Services/ResourceConfigurationCoordinator.cs): `src/Services/ResourceConfigurationCoordinator.cs`
- [Custom components](https://github.com/azure/azurenamingtool/blob/main/src/Models/CustomComponent.cs): `src/Models/CustomComponent.cs`
- [Admin logging](https://github.com/azure/azurenamingtool/blob/main/src/Services/Interfaces/IAdminLogService.cs): `src/Services/Interfaces/IAdminLogService.cs`

### Persistence

- [Configuration context](https://github.com/azure/azurenamingtool/blob/main/src/Data/ConfigurationDbContext.cs): `src/Data/ConfigurationDbContext.cs`
- [Configuration repository](https://github.com/azure/azurenamingtool/blob/main/src/Repositories/Interfaces/IConfigurationRepository.cs): `src/Repositories/Interfaces/IConfigurationRepository.cs`
- [SQLite storage](https://github.com/azure/azurenamingtool/blob/main/src/Repositories/SQLiteConfigurationRepository.cs): `src/Repositories/SQLiteConfigurationRepository.cs`
- [Filesystem storage](https://github.com/azure/azurenamingtool/blob/main/src/Repositories/Implementation/FileSystem/JsonFileConfigurationRepository.cs): `src/Repositories/Implementation/FileSystem/JsonFileConfigurationRepository.cs`

### Other components

- **Administrator or user**

## Connections

- Administrator or user → Naming API: requests a name
- Naming API → Name generation: dispatches to (evidence: `src/Controllers/V2/ResourceNamingRequestsController.cs`)
- Name generation → Resource type rules: uses rules (evidence: `src/Services/ResourceNamingRequestService.cs`)
- Name generation → Azure validation: uses validation (evidence: `src/Services/ResourceNamingRequestService.cs`)
- Name generation → Conflict resolution: uses resolution (evidence: `src/Services/ResourceNamingRequestService.cs`)
- Administration API → Admin logging: records activity (evidence: `src/Controllers/V2/AdminController.cs`)
- Administration API → Generated names: manages history
- Resource APIs → Configuration services: dispatches to
- Configuration context → Resource type rules: maps entity (evidence: `src/Data/ConfigurationDbContext.cs`)
- Configuration context → Custom components: maps entity (evidence: `src/Data/ConfigurationDbContext.cs`)
- Configuration context → Generated names: maps entity (evidence: `src/Data/ConfigurationDbContext.cs`)
- SQLite storage → Configuration repository: implements (evidence: `src/Repositories/SQLiteConfigurationRepository.cs`)
- SQLite storage → Configuration context: uses context (evidence: `src/Repositories/SQLiteConfigurationRepository.cs`)
- Filesystem storage → Configuration repository: implements (evidence: `src/Repositories/Implementation/FileSystem/JsonFileConfigurationRepository.cs`)
