Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cdn
  5. getAFDCustomDomain
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.5.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cdn.getAFDCustomDomain

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.5.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

    Uses Azure REST API version 2024-09-01.

    Other available API versions: 2023-05-01, 2023-07-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2025-04-15. 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 dictionary

    The following arguments are supported:

    CustomDomainName string
    Name of the domain under the profile which is unique globally.
    ProfileName string
    Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    CustomDomainName string
    Name of the domain under the profile which is unique globally.
    ProfileName string
    Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    customDomainName String
    Name of the domain under the profile which is unique globally.
    profileName String
    Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    customDomainName string
    Name of the domain under the profile which is unique globally.
    profileName string
    Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
    resourceGroupName string
    Name of the Resource group within the Azure subscription.
    custom_domain_name str
    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 profile which is unique within the resource group.
    resource_group_name str
    Name of the Resource group within the Azure subscription.
    customDomainName String
    Name of the domain under the profile which is unique globally.
    profileName String
    Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
    resourceGroupName String
    Name of the Resource group within the Azure subscription.

    getAFDCustomDomain Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    DeploymentStatus string
    DomainValidationState string
    Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
    HostName string
    The host name of the domain. Must be a domain name.
    Id string
    Resource ID.
    Name string
    Resource name.
    ProfileName string
    The name of the profile which holds the domain.
    ProvisioningState string
    Provisioning status
    SystemData Pulumi.AzureNative.Cdn.Outputs.SystemDataResponse
    Read only system data
    Type string
    Resource type.
    ValidationProperties Pulumi.AzureNative.Cdn.Outputs.DomainValidationPropertiesResponse
    Values the customer needs to validate domain ownership
    AzureDnsZone Pulumi.AzureNative.Cdn.Outputs.ResourceReferenceResponse
    Resource reference to the Azure DNS zone
    ExtendedProperties Dictionary<string, string>
    Key-Value pair representing migration properties for domains.
    PreValidatedCustomDomainResourceId Pulumi.AzureNative.Cdn.Outputs.ResourceReferenceResponse
    Resource reference to the Azure resource where custom domain ownership was prevalidated
    TlsSettings Pulumi.AzureNative.Cdn.Outputs.AFDDomainHttpsParametersResponse
    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.
    AzureApiVersion string
    The Azure API version of the resource.
    DeploymentStatus string
    DomainValidationState string
    Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
    HostName string
    The host name of the domain. Must be a domain name.
    Id string
    Resource ID.
    Name string
    Resource name.
    ProfileName string
    The name of the profile which holds the domain.
    ProvisioningState string
    Provisioning status
    SystemData SystemDataResponse
    Read only system data
    Type string
    Resource type.
    ValidationProperties DomainValidationPropertiesResponse
    Values the customer needs to validate domain ownership
    AzureDnsZone ResourceReferenceResponse
    Resource reference to the Azure DNS zone
    ExtendedProperties map[string]string
    Key-Value pair representing migration properties for domains.
    PreValidatedCustomDomainResourceId ResourceReferenceResponse
    Resource reference to the Azure resource where custom domain ownership was prevalidated
    TlsSettings AFDDomainHttpsParametersResponse
    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.
    azureApiVersion String
    The Azure API version of the resource.
    deploymentStatus String
    domainValidationState String
    Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
    hostName String
    The host name of the domain. Must be a domain name.
    id String
    Resource ID.
    name String
    Resource name.
    profileName String
    The name of the profile which holds the domain.
    provisioningState String
    Provisioning status
    systemData SystemDataResponse
    Read only system data
    type String
    Resource type.
    validationProperties DomainValidationPropertiesResponse
    Values the customer needs to validate domain ownership
    azureDnsZone ResourceReferenceResponse
    Resource reference to the Azure DNS zone
    extendedProperties Map<String,String>
    Key-Value pair representing migration properties for domains.
    preValidatedCustomDomainResourceId ResourceReferenceResponse
    Resource reference to the Azure resource where custom domain ownership was prevalidated
    tlsSettings AFDDomainHttpsParametersResponse
    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.
    azureApiVersion string
    The Azure API version of the resource.
    deploymentStatus string
    domainValidationState string
    Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
    hostName string
    The host name of the domain. Must be a domain name.
    id string
    Resource ID.
    name string
    Resource name.
    profileName string
    The name of the profile which holds the domain.
    provisioningState string
    Provisioning status
    systemData SystemDataResponse
    Read only system data
    type string
    Resource type.
    validationProperties DomainValidationPropertiesResponse
    Values the customer needs to validate domain ownership
    azureDnsZone ResourceReferenceResponse
    Resource reference to the Azure DNS zone
    extendedProperties {[key: string]: string}
    Key-Value pair representing migration properties for domains.
    preValidatedCustomDomainResourceId ResourceReferenceResponse
    Resource reference to the Azure resource where custom domain ownership was prevalidated
    tlsSettings AFDDomainHttpsParametersResponse
    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_version str
    The Azure API version of the resource.
    deployment_status str
    domain_validation_state str
    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
    Resource ID.
    name str
    Resource name.
    profile_name str
    The name of the profile which holds the domain.
    provisioning_state str
    Provisioning status
    system_data SystemDataResponse
    Read only system data
    type str
    Resource type.
    validation_properties DomainValidationPropertiesResponse
    Values the customer needs to validate domain ownership
    azure_dns_zone ResourceReferenceResponse
    Resource reference to the Azure DNS zone
    extended_properties Mapping[str, str]
    Key-Value pair representing migration properties for domains.
    pre_validated_custom_domain_resource_id ResourceReferenceResponse
    Resource reference to the Azure resource where custom domain ownership was prevalidated
    tls_settings AFDDomainHttpsParametersResponse
    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.
    azureApiVersion String
    The Azure API version of the resource.
    deploymentStatus String
    domainValidationState String
    Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
    hostName String
    The host name of the domain. Must be a domain name.
    id String
    Resource ID.
    name String
    Resource name.
    profileName String
    The name of the profile which holds the domain.
    provisioningState String
    Provisioning status
    systemData Property Map
    Read only system data
    type String
    Resource type.
    validationProperties Property Map
    Values the customer needs to validate domain ownership
    azureDnsZone Property Map
    Resource reference to the Azure DNS zone
    extendedProperties Map<String>
    Key-Value pair representing migration properties for domains.
    preValidatedCustomDomainResourceId Property Map
    Resource reference to the Azure resource where custom domain ownership was prevalidated
    tlsSettings 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

    AFDDomainHttpsParametersResponse

    CertificateType string
    Defines the source of the SSL certificate.
    MinimumTlsVersion string
    TLS protocol version that will be used for Https
    Secret Pulumi.AzureNative.Cdn.Inputs.ResourceReferenceResponse
    Resource reference to the secret. ie. subs/rg/profile/secret
    CertificateType string
    Defines the source of the SSL certificate.
    MinimumTlsVersion string
    TLS protocol version that will be used for Https
    Secret ResourceReferenceResponse
    Resource reference to the secret. ie. subs/rg/profile/secret
    certificateType String
    Defines the source of the SSL certificate.
    minimumTlsVersion String
    TLS protocol version that will be used for Https
    secret ResourceReferenceResponse
    Resource reference to the secret. ie. subs/rg/profile/secret
    certificateType string
    Defines the source of the SSL certificate.
    minimumTlsVersion string
    TLS protocol version that will be used for Https
    secret ResourceReferenceResponse
    Resource reference to the secret. ie. subs/rg/profile/secret
    certificate_type str
    Defines the source of the SSL certificate.
    minimum_tls_version str
    TLS protocol version that will be used for Https
    secret ResourceReferenceResponse
    Resource reference to the secret. ie. subs/rg/profile/secret
    certificateType String
    Defines the source of the SSL certificate.
    minimumTlsVersion String
    TLS protocol version that will be used for Https
    secret Property Map
    Resource reference to the secret. ie. subs/rg/profile/secret

    DomainValidationPropertiesResponse

    ExpirationDate string
    The date time that the token expires
    ValidationToken string
    Challenge used for DNS TXT record or file based validation
    ExpirationDate string
    The date time that the token expires
    ValidationToken string
    Challenge used for DNS TXT record or file based validation
    expirationDate String
    The date time that the token expires
    validationToken String
    Challenge used for DNS TXT record or file based validation
    expirationDate string
    The date time that the token expires
    validationToken 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
    expirationDate String
    The date time that the token expires
    validationToken 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

    CreatedAt string
    The timestamp of resource creation (UTC)
    CreatedBy string
    An identifier for the identity that created the resource
    CreatedByType string
    The type of identity that created the resource
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    An identifier for the identity that last modified the resource
    LastModifiedByType string
    The type of identity that last modified the resource
    CreatedAt string
    The timestamp of resource creation (UTC)
    CreatedBy string
    An identifier for the identity that created the resource
    CreatedByType string
    The type of identity that created the resource
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    An identifier for the identity that last modified the resource
    LastModifiedByType string
    The type of identity that last modified the resource
    createdAt String
    The timestamp of resource creation (UTC)
    createdBy String
    An identifier for the identity that created the resource
    createdByType String
    The type of identity that created the resource
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    An identifier for the identity that last modified the resource
    lastModifiedByType String
    The type of identity that last modified the resource
    createdAt string
    The timestamp of resource creation (UTC)
    createdBy string
    An identifier for the identity that created the resource
    createdByType string
    The type of identity that created the resource
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    An identifier for the identity that last modified the resource
    lastModifiedByType string
    The type of identity that last modified the resource
    created_at str
    The timestamp of resource creation (UTC)
    created_by str
    An identifier for the identity that created the resource
    created_by_type str
    The type of identity that created the resource
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    An identifier for the identity that last modified the resource
    last_modified_by_type str
    The type of identity that last modified the resource
    createdAt String
    The timestamp of resource creation (UTC)
    createdBy String
    An identifier for the identity that created the resource
    createdByType String
    The type of identity that created the resource
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    An identifier for the identity that last modified the resource
    lastModifiedByType String
    The type of identity that last modified the resource

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.5.0 published on Monday, May 19, 2025 by Pulumi
    pulumi/pulumi-azure-native