CustomDomainArgs

data class CustomDomainArgs(val customDomainName: Output<String>? = null, val endpointName: Output<String>? = null, val hostName: Output<String>? = null, val profileName: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<CustomDomainArgs>

Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com. Uses Azure REST API version 2024-09-01. In version 2.x of the Azure Native provider, it used API version 2023-05-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/#accessing-any-api-version-via-local-packages for details.

Example Usage

CustomDomains_Create

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var customDomain = new AzureNative.Cdn.CustomDomain("customDomain", new()
{
CustomDomainName = "www-someDomain-net",
EndpointName = "endpoint1",
HostName = "www.someDomain.net",
ProfileName = "profile1",
ResourceGroupName = "RG",
});
});
package main
import (
cdn "github.com/pulumi/pulumi-azure-native-sdk/cdn/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cdn.NewCustomDomain(ctx, "customDomain", &cdn.CustomDomainArgs{
CustomDomainName: pulumi.String("www-someDomain-net"),
EndpointName: pulumi.String("endpoint1"),
HostName: pulumi.String("www.someDomain.net"),
ProfileName: pulumi.String("profile1"),
ResourceGroupName: pulumi.String("RG"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cdn.CustomDomain;
import com.pulumi.azurenative.cdn.CustomDomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var customDomain = new CustomDomain("customDomain", CustomDomainArgs.builder()
.customDomainName("www-someDomain-net")
.endpointName("endpoint1")
.hostName("www.someDomain.net")
.profileName("profile1")
.resourceGroupName("RG")
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:cdn:CustomDomain www-someDomain-net /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}

Constructors

Link copied to clipboard
constructor(customDomainName: Output<String>? = null, endpointName: Output<String>? = null, hostName: Output<String>? = null, profileName: Output<String>? = null, resourceGroupName: Output<String>? = null)

Properties

Link copied to clipboard
val customDomainName: Output<String>? = null

Name of the custom domain within an endpoint.

Link copied to clipboard
val endpointName: Output<String>? = null

Name of the endpoint under the profile which is unique globally.

Link copied to clipboard
val hostName: Output<String>? = null

The host name of the custom domain. Must be a domain name.

Link copied to clipboard
val profileName: Output<String>? = null

Name of the CDN profile which is unique within the resource group.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

Name of the Resource group within the Azure subscription.

Functions

Link copied to clipboard
open override fun toJava(): CustomDomainArgs