Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
Uses Azure REST API version 2025-06-01.
Other available API versions: 2023-05-01, 2023-07-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2024-09-01, 2025-01-01-preview, 2025-04-15, 2025-07-01-preview, 2025-09-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cdn [ApiVersion]. See the version guide for details.
Using getAFDCustomDomain
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAFDCustomDomain(args: GetAFDCustomDomainArgs, opts?: InvokeOptions): Promise<GetAFDCustomDomainResult>
function getAFDCustomDomainOutput(args: GetAFDCustomDomainOutputArgs, opts?: InvokeOptions): Output<GetAFDCustomDomainResult>def get_afd_custom_domain(custom_domain_name: Optional[str] = None,
profile_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAFDCustomDomainResult
def get_afd_custom_domain_output(custom_domain_name: Optional[pulumi.Input[str]] = None,
profile_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAFDCustomDomainResult]func LookupAFDCustomDomain(ctx *Context, args *LookupAFDCustomDomainArgs, opts ...InvokeOption) (*LookupAFDCustomDomainResult, error)
func LookupAFDCustomDomainOutput(ctx *Context, args *LookupAFDCustomDomainOutputArgs, opts ...InvokeOption) LookupAFDCustomDomainResultOutput> Note: This function is named LookupAFDCustomDomain in the Go SDK.
public static class GetAFDCustomDomain
{
public static Task<GetAFDCustomDomainResult> InvokeAsync(GetAFDCustomDomainArgs args, InvokeOptions? opts = null)
public static Output<GetAFDCustomDomainResult> Invoke(GetAFDCustomDomainInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetAFDCustomDomainResult> getAFDCustomDomain(GetAFDCustomDomainArgs args, InvokeOptions options)
public static Output<GetAFDCustomDomainResult> getAFDCustomDomain(GetAFDCustomDomainArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:cdn:getAFDCustomDomain
arguments:
# arguments dictionaryThe following arguments are supported:
- Custom
Domain stringName - Name of the domain under the profile which is unique globally.
- Profile
Name string - Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Custom
Domain stringName - Name of the domain under the profile which is unique globally.
- Profile
Name string - Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- custom
Domain StringName - Name of the domain under the profile which is unique globally.
- profile
Name String - Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- custom
Domain stringName - Name of the domain under the profile which is unique globally.
- profile
Name string - Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- custom_
domain_ strname - Name of the domain under the profile which is unique globally.
- profile_
name str - Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- custom
Domain StringName - Name of the domain under the profile which is unique globally.
- profile
Name String - Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getAFDCustomDomain Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Deployment
Status string - Domain
Validation stringState - Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
- Host
Name string - The host name of the domain. Must be a domain name.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Name string
- The name of the resource
- Profile
Name string - The name of the profile which holds the domain.
- Provisioning
State string - Provisioning status
- System
Data Pulumi.Azure Native. Cdn. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Validation
Properties Pulumi.Azure Native. Cdn. Outputs. Domain Validation Properties Response - Values the customer needs to validate domain ownership
- Azure
Dns Pulumi.Zone Azure Native. Cdn. Outputs. Resource Reference Response - Resource reference to the Azure DNS zone
- Extended
Properties Dictionary<string, string> - Key-Value pair representing migration properties for domains.
- Pre
Validated Pulumi.Custom Domain Resource Id Azure Native. Cdn. Outputs. Resource Reference Response - Resource reference to the Azure resource where custom domain ownership was prevalidated
- Tls
Settings Pulumi.Azure Native. Cdn. Outputs. AFDDomain Https Parameters Response - The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
- Azure
Api stringVersion - The Azure API version of the resource.
- Deployment
Status string - Domain
Validation stringState - Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
- Host
Name string - The host name of the domain. Must be a domain name.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Name string
- The name of the resource
- Profile
Name string - The name of the profile which holds the domain.
- Provisioning
State string - Provisioning status
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Validation
Properties DomainValidation Properties Response - Values the customer needs to validate domain ownership
- Azure
Dns ResourceZone Reference Response - Resource reference to the Azure DNS zone
- Extended
Properties map[string]string - Key-Value pair representing migration properties for domains.
- Pre
Validated ResourceCustom Domain Resource Id Reference Response - Resource reference to the Azure resource where custom domain ownership was prevalidated
- Tls
Settings AFDDomainHttps Parameters Response - The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
- azure
Api StringVersion - The Azure API version of the resource.
- deployment
Status String - domain
Validation StringState - Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
- host
Name String - The host name of the domain. Must be a domain name.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name String
- The name of the resource
- profile
Name String - The name of the profile which holds the domain.
- provisioning
State String - Provisioning status
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- validation
Properties DomainValidation Properties Response - Values the customer needs to validate domain ownership
- azure
Dns ResourceZone Reference Response - Resource reference to the Azure DNS zone
- extended
Properties Map<String,String> - Key-Value pair representing migration properties for domains.
- pre
Validated ResourceCustom Domain Resource Id Reference Response - Resource reference to the Azure resource where custom domain ownership was prevalidated
- tls
Settings AFDDomainHttps Parameters Response - The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
- azure
Api stringVersion - The Azure API version of the resource.
- deployment
Status string - domain
Validation stringState - Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
- host
Name string - The host name of the domain. Must be a domain name.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name string
- The name of the resource
- profile
Name string - The name of the profile which holds the domain.
- provisioning
State string - Provisioning status
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- validation
Properties DomainValidation Properties Response - Values the customer needs to validate domain ownership
- azure
Dns ResourceZone Reference Response - Resource reference to the Azure DNS zone
- extended
Properties {[key: string]: string} - Key-Value pair representing migration properties for domains.
- pre
Validated ResourceCustom Domain Resource Id Reference Response - Resource reference to the Azure resource where custom domain ownership was prevalidated
- tls
Settings AFDDomainHttps Parameters Response - The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
- azure_
api_ strversion - The Azure API version of the resource.
- deployment_
status str - domain_
validation_ strstate - Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
- host_
name str - The host name of the domain. Must be a domain name.
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name str
- The name of the resource
- profile_
name str - The name of the profile which holds the domain.
- provisioning_
state str - Provisioning status
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- validation_
properties DomainValidation Properties Response - Values the customer needs to validate domain ownership
- azure_
dns_ Resourcezone Reference Response - Resource reference to the Azure DNS zone
- extended_
properties Mapping[str, str] - Key-Value pair representing migration properties for domains.
- pre_
validated_ Resourcecustom_ domain_ resource_ id Reference Response - Resource reference to the Azure resource where custom domain ownership was prevalidated
- tls_
settings AFDDomainHttps Parameters Response - The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
- azure
Api StringVersion - The Azure API version of the resource.
- deployment
Status String - domain
Validation StringState - Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
- host
Name String - The host name of the domain. Must be a domain name.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name String
- The name of the resource
- profile
Name String - The name of the profile which holds the domain.
- provisioning
State String - Provisioning status
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- validation
Properties Property Map - Values the customer needs to validate domain ownership
- azure
Dns Property MapZone - Resource reference to the Azure DNS zone
- extended
Properties Map<String> - Key-Value pair representing migration properties for domains.
- pre
Validated Property MapCustom Domain Resource Id - Resource reference to the Azure resource where custom domain ownership was prevalidated
- tls
Settings Property Map - The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
Supporting Types
AFDDomainHttpsCustomizedCipherSuiteSetResponse
- Cipher
Suite List<string>Set For Tls12 - Cipher suites for TLS 1.2. Required at least one in minimumTlsVersion TLS 1.2.
- Cipher
Suite List<string>Set For Tls13 - Cipher suites for TLS 1.3. Required at least one in minimumTlsVersion TLS 1.2, TLS 1.3.
- Cipher
Suite []stringSet For Tls12 - Cipher suites for TLS 1.2. Required at least one in minimumTlsVersion TLS 1.2.
- Cipher
Suite []stringSet For Tls13 - Cipher suites for TLS 1.3. Required at least one in minimumTlsVersion TLS 1.2, TLS 1.3.
- cipher
Suite List<String>Set For Tls12 - Cipher suites for TLS 1.2. Required at least one in minimumTlsVersion TLS 1.2.
- cipher
Suite List<String>Set For Tls13 - Cipher suites for TLS 1.3. Required at least one in minimumTlsVersion TLS 1.2, TLS 1.3.
- cipher
Suite string[]Set For Tls12 - Cipher suites for TLS 1.2. Required at least one in minimumTlsVersion TLS 1.2.
- cipher
Suite string[]Set For Tls13 - Cipher suites for TLS 1.3. Required at least one in minimumTlsVersion TLS 1.2, TLS 1.3.
- cipher_
suite_ Sequence[str]set_ for_ tls12 - Cipher suites for TLS 1.2. Required at least one in minimumTlsVersion TLS 1.2.
- cipher_
suite_ Sequence[str]set_ for_ tls13 - Cipher suites for TLS 1.3. Required at least one in minimumTlsVersion TLS 1.2, TLS 1.3.
- cipher
Suite List<String>Set For Tls12 - Cipher suites for TLS 1.2. Required at least one in minimumTlsVersion TLS 1.2.
- cipher
Suite List<String>Set For Tls13 - Cipher suites for TLS 1.3. Required at least one in minimumTlsVersion TLS 1.2, TLS 1.3.
AFDDomainHttpsParametersResponse
- Certificate
Type string - Defines the source of the SSL certificate.
- Cipher
Suite stringSet Type - cipher suite set type that will be used for Https
- Customized
Cipher Pulumi.Suite Set Azure Native. Cdn. Inputs. AFDDomain Https Customized Cipher Suite Set Response - Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized.
- Minimum
Tls stringVersion - TLS protocol version that will be used for Https when cipherSuiteSetType is Customized.
- Secret
Pulumi.
Azure Native. Cdn. Inputs. Resource Reference Response - Resource reference to the secret. ie. subs/rg/profile/secret
- Certificate
Type string - Defines the source of the SSL certificate.
- Cipher
Suite stringSet Type - cipher suite set type that will be used for Https
- Customized
Cipher AFDDomainSuite Set Https Customized Cipher Suite Set Response - Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized.
- Minimum
Tls stringVersion - TLS protocol version that will be used for Https when cipherSuiteSetType is Customized.
- Secret
Resource
Reference Response - Resource reference to the secret. ie. subs/rg/profile/secret
- certificate
Type String - Defines the source of the SSL certificate.
- cipher
Suite StringSet Type - cipher suite set type that will be used for Https
- customized
Cipher AFDDomainSuite Set Https Customized Cipher Suite Set Response - Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized.
- minimum
Tls StringVersion - TLS protocol version that will be used for Https when cipherSuiteSetType is Customized.
- secret
Resource
Reference Response - Resource reference to the secret. ie. subs/rg/profile/secret
- certificate
Type string - Defines the source of the SSL certificate.
- cipher
Suite stringSet Type - cipher suite set type that will be used for Https
- customized
Cipher AFDDomainSuite Set Https Customized Cipher Suite Set Response - Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized.
- minimum
Tls stringVersion - TLS protocol version that will be used for Https when cipherSuiteSetType is Customized.
- secret
Resource
Reference Response - Resource reference to the secret. ie. subs/rg/profile/secret
- certificate_
type str - Defines the source of the SSL certificate.
- cipher_
suite_ strset_ type - cipher suite set type that will be used for Https
- customized_
cipher_ AFDDomainsuite_ set Https Customized Cipher Suite Set Response - Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized.
- minimum_
tls_ strversion - TLS protocol version that will be used for Https when cipherSuiteSetType is Customized.
- secret
Resource
Reference Response - Resource reference to the secret. ie. subs/rg/profile/secret
- certificate
Type String - Defines the source of the SSL certificate.
- cipher
Suite StringSet Type - cipher suite set type that will be used for Https
- customized
Cipher Property MapSuite Set - Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized.
- minimum
Tls StringVersion - TLS protocol version that will be used for Https when cipherSuiteSetType is Customized.
- secret Property Map
- Resource reference to the secret. ie. subs/rg/profile/secret
DomainValidationPropertiesResponse
- Expiration
Date string - The date time that the token expires
- Validation
Token string - Challenge used for DNS TXT record or file based validation
- Expiration
Date string - The date time that the token expires
- Validation
Token string - Challenge used for DNS TXT record or file based validation
- expiration
Date String - The date time that the token expires
- validation
Token String - Challenge used for DNS TXT record or file based validation
- expiration
Date string - The date time that the token expires
- validation
Token string - Challenge used for DNS TXT record or file based validation
- expiration_
date str - The date time that the token expires
- validation_
token str - Challenge used for DNS TXT record or file based validation
- expiration
Date String - The date time that the token expires
- validation
Token String - Challenge used for DNS TXT record or file based validation
ResourceReferenceResponse
- Id string
- Resource ID.
- Id string
- Resource ID.
- id String
- Resource ID.
- id string
- Resource ID.
- id str
- Resource ID.
- id String
- Resource ID.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
