@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getAFDCustomDomain(args: GetAFDCustomDomainArgs, opts?: pulumi.InvokeOptions): Promise<GetAFDCustomDomainResult>;
export interface GetAFDCustomDomainArgs {
/**
* Name of the domain under the profile which is unique globally.
*/
customDomainName: string;
/**
* Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
*/
profileName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.
*/
export interface GetAFDCustomDomainResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Resource reference to the Azure DNS zone
*/
readonly azureDnsZone?: outputs.cdn.ResourceReferenceResponse;
readonly deploymentStatus: string;
/**
* Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
*/
readonly domainValidationState: string;
/**
* Key-Value pair representing migration properties for domains.
*/
readonly extendedProperties?: {
[key: string]: string;
};
/**
* The host name of the domain. Must be a domain name.
*/
readonly hostName: string;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* Resource reference to the Azure resource where custom domain ownership was prevalidated
*/
readonly preValidatedCustomDomainResourceId?: outputs.cdn.ResourceReferenceResponse;
/**
* The name of the profile which holds the domain.
*/
readonly profileName: string;
/**
* Provisioning status
*/
readonly provisioningState: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.cdn.SystemDataResponse;
/**
* 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.
*/
readonly tlsSettings?: outputs.cdn.AFDDomainHttpsParametersResponse;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* Values the customer needs to validate domain ownership
*/
readonly validationProperties: outputs.cdn.DomainValidationPropertiesResponse;
}
/**
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getAFDCustomDomainOutput(args: GetAFDCustomDomainOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAFDCustomDomainResult>;
export interface GetAFDCustomDomainOutputArgs {
/**
* Name of the domain under the profile which is unique globally.
*/
customDomainName: pulumi.Input<string>;
/**
* Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
*/
profileName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}