Skip to main content

Azure

Configuration for Azure services, including authentication credentials and DNS settings. These settings define how your application interacts with Azure resources

Properties

NameTypeDescriptionRequired
networkingobjectConfiguration for DNS zones and domain names in Azure, including both public and private DNS settings
yes
authenticationobjectCredentials and identifiers required for authenticating with Azure services
yes

Additional Properties: not allowed
Example

{
"networking": {
"domain_name": "example.com",
"application_domain": false,
"public_dns_zone_name": "public.example.com",
"private_dns_zone_name": "private.example.com",
"public_dns_zone_resource_group_name": "my-public-dns-resource-group",
"private_dns_zone_resource_group_name": "my-private-dns-resource-group"
},
"authentication": {
"client_id": "12345678-1234-1234-1234-123456789012",
"tenant_id": "87654321-4321-4321-4321-210987654321",
"client_secret": "ThisIsAMockSecretDoNotUseInProduction!",
"subscription_id": "11111111-2222-3333-4444-555555555555"
}
}

networking: Networking

Configuration for DNS zones and domain names in Azure, including both public and private DNS settings

Properties

NameTypeDescriptionRequired
domain_namestringThe root domain name to be used for your Azure resources. Must be a valid domain name that you own or control
Pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$
yes
application_domainbooleanUse account name as part of applications domains
Default: false
no
public_dns_zone_namestringThe name of your Azure DNS public zone. This zone will handle public-facing DNS resolution for your domain
Pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$
yes
private_dns_zone_namestringThe name of your Azure DNS private zone. This zone will handle internal DNS resolution within your virtual network
Pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$
no
public_dns_zone_resource_group_name
(Public DNS Zone Resource Group)
stringThe name of the Azure Resource Group containing your public DNS zone. Resource group names must be unique within your subscription
Maximal Length: 90
Pattern: ^[a-zA-Z0-9-_]{1,90}$
yes
private_dns_zone_resource_group_name
(Private DNS Zone Resource Group)
stringThe name of the Azure Resource Group containing your private DNS zone. Resource group names must be unique within your subscription
Maximal Length: 90
Pattern: ^[a-zA-Z0-9-_]{1,90}$
no

Example

{
"domain_name": "example.com",
"application_domain": false,
"public_dns_zone_name": "public.example.com",
"private_dns_zone_name": "private.example.com",
"public_dns_zone_resource_group_name": "my-public-dns-resource-group",
"private_dns_zone_resource_group_name": "my-private-dns-resource-group"
}

authentication: Authentication

Credentials and identifiers required for authenticating with Azure services

Properties

NameTypeDescriptionRequired
client_idstringThe unique identifier (UUID) of your Azure Active Directory application registration
yes
tenant_idstringThe unique identifier (UUID) of your Azure Active Directory tenant where the application is registered
yes
client_secretstringThe secret key generated for your Azure Active Directory application. Keep this value secure and never share it
Minimal Length: 16
yes
subscription_idstringThe unique identifier (UUID) of your Azure subscription where resources will be deployed
yes

Example

{
"client_id": "12345678-1234-1234-1234-123456789012",
"tenant_id": "87654321-4321-4321-4321-210987654321",
"client_secret": "ThisIsAMockSecretDoNotUseInProduction!",
"subscription_id": "11111111-2222-3333-4444-555555555555"
}