@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets an existing custom domain within an endpoint.
*
* 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-01-01-preview, 2025-04-15, 2025-06-01. 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 getCustomDomain(args: GetCustomDomainArgs, opts?: pulumi.InvokeOptions): Promise<GetCustomDomainResult>;
export interface GetCustomDomainArgs {
/**
* Name of the custom domain within an endpoint.
*/
customDomainName: string;
/**
* Name of the endpoint under the profile which is unique globally.
*/
endpointName: string;
/**
* Name of the CDN profile which is unique within the resource group.
*/
profileName: string;
/**
* Name of the Resource group within the Azure subscription.
*/
resourceGroupName: string;
}
/**
* Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.
*/
export interface GetCustomDomainResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Certificate parameters for securing custom HTTPS
*/
readonly customHttpsParameters?: outputs.cdn.CdnManagedHttpsParametersResponse | outputs.cdn.UserManagedHttpsParametersResponse;
/**
* Provisioning status of the custom domain.
*/
readonly customHttpsProvisioningState: string;
/**
* Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
*/
readonly customHttpsProvisioningSubstate: string;
/**
* The host name of the custom domain. Must be a domain name.
*/
readonly hostName: string;
/**
* Resource ID.
*/
readonly id: string;
/**
* Resource name.
*/
readonly name: string;
/**
* Provisioning status of Custom Https of the custom domain.
*/
readonly provisioningState: string;
/**
* Resource status of the custom domain.
*/
readonly resourceState: string;
/**
* Read only system data
*/
readonly systemData: outputs.cdn.SystemDataResponse;
/**
* Resource type.
*/
readonly type: string;
/**
* Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.
*/
readonly validationData?: string;
}
/**
* Gets an existing custom domain within an endpoint.
*
* 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-01-01-preview, 2025-04-15, 2025-06-01. 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 getCustomDomainOutput(args: GetCustomDomainOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCustomDomainResult>;
export interface GetCustomDomainOutputArgs {
/**
* Name of the custom domain within an endpoint.
*/
customDomainName: pulumi.Input<string>;
/**
* Name of the endpoint under the profile which is unique globally.
*/
endpointName: pulumi.Input<string>;
/**
* Name of the CDN profile which is unique within the resource group.
*/
profileName: pulumi.Input<string>;
/**
* Name of the Resource group within the Azure subscription.
*/
resourceGroupName: pulumi.Input<string>;
}