Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. StaticSiteCustomDomain
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.web.StaticSiteCustomDomain

Explore with Pulumi AI

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Static Site Custom Domain Overview ARM resource.

Uses Azure REST API version 2024-04-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01.

Other available API versions: 2020-12-01, 2021-01-01, 2021-01-15, 2021-02-01, 2021-03-01, 2022-03-01, 2022-09-01, 2023-01-01, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native web [ApiVersion]. See the version guide for details.

Example Usage

Create or update a custom domain for a static site

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var staticSiteCustomDomain = new AzureNative.Web.StaticSiteCustomDomain("staticSiteCustomDomain", new()
    {
        DomainName = "custom.domain.net",
        Name = "testStaticSite0",
        ResourceGroupName = "rg",
    });

});
Copy
package main

import (
	web "github.com/pulumi/pulumi-azure-native-sdk/web/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := web.NewStaticSiteCustomDomain(ctx, "staticSiteCustomDomain", &web.StaticSiteCustomDomainArgs{
			DomainName:        pulumi.String("custom.domain.net"),
			Name:              pulumi.String("testStaticSite0"),
			ResourceGroupName: pulumi.String("rg"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.web.StaticSiteCustomDomain;
import com.pulumi.azurenative.web.StaticSiteCustomDomainArgs;
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 staticSiteCustomDomain = new StaticSiteCustomDomain("staticSiteCustomDomain", StaticSiteCustomDomainArgs.builder()
            .domainName("custom.domain.net")
            .name("testStaticSite0")
            .resourceGroupName("rg")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const staticSiteCustomDomain = new azure_native.web.StaticSiteCustomDomain("staticSiteCustomDomain", {
    domainName: "custom.domain.net",
    name: "testStaticSite0",
    resourceGroupName: "rg",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

static_site_custom_domain = azure_native.web.StaticSiteCustomDomain("staticSiteCustomDomain",
    domain_name="custom.domain.net",
    name="testStaticSite0",
    resource_group_name="rg")
Copy
resources:
  staticSiteCustomDomain:
    type: azure-native:web:StaticSiteCustomDomain
    properties:
      domainName: custom.domain.net
      name: testStaticSite0
      resourceGroupName: rg
Copy

Create StaticSiteCustomDomain Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new StaticSiteCustomDomain(name: string, args: StaticSiteCustomDomainArgs, opts?: CustomResourceOptions);
@overload
def StaticSiteCustomDomain(resource_name: str,
                           args: StaticSiteCustomDomainArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def StaticSiteCustomDomain(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           domain_name: Optional[str] = None,
                           kind: Optional[str] = None,
                           validation_method: Optional[str] = None)
func NewStaticSiteCustomDomain(ctx *Context, name string, args StaticSiteCustomDomainArgs, opts ...ResourceOption) (*StaticSiteCustomDomain, error)
public StaticSiteCustomDomain(string name, StaticSiteCustomDomainArgs args, CustomResourceOptions? opts = null)
public StaticSiteCustomDomain(String name, StaticSiteCustomDomainArgs args)
public StaticSiteCustomDomain(String name, StaticSiteCustomDomainArgs args, CustomResourceOptions options)

type: azure-native:web:StaticSiteCustomDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StaticSiteCustomDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. StaticSiteCustomDomainArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. StaticSiteCustomDomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StaticSiteCustomDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StaticSiteCustomDomainArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var staticSiteCustomDomainResource = new AzureNative.Web.StaticSiteCustomDomain("staticSiteCustomDomainResource", new()
{
    Name = "string",
    ResourceGroupName = "string",
    DomainName = "string",
    Kind = "string",
    ValidationMethod = "string",
});
Copy
example, err := web.NewStaticSiteCustomDomain(ctx, "staticSiteCustomDomainResource", &web.StaticSiteCustomDomainArgs{
	Name:              pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	DomainName:        pulumi.String("string"),
	Kind:              pulumi.String("string"),
	ValidationMethod:  pulumi.String("string"),
})
Copy
var staticSiteCustomDomainResource = new StaticSiteCustomDomain("staticSiteCustomDomainResource", StaticSiteCustomDomainArgs.builder()
    .name("string")
    .resourceGroupName("string")
    .domainName("string")
    .kind("string")
    .validationMethod("string")
    .build());
Copy
static_site_custom_domain_resource = azure_native.web.StaticSiteCustomDomain("staticSiteCustomDomainResource",
    name="string",
    resource_group_name="string",
    domain_name="string",
    kind="string",
    validation_method="string")
Copy
const staticSiteCustomDomainResource = new azure_native.web.StaticSiteCustomDomain("staticSiteCustomDomainResource", {
    name: "string",
    resourceGroupName: "string",
    domainName: "string",
    kind: "string",
    validationMethod: "string",
});
Copy
type: azure-native:web:StaticSiteCustomDomain
properties:
    domainName: string
    kind: string
    name: string
    resourceGroupName: string
    validationMethod: string
Copy

StaticSiteCustomDomain Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The StaticSiteCustomDomain resource accepts the following input properties:

Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the static site.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
DomainName Changes to this property will trigger replacement. string
The custom domain to create.
Kind string
Kind of resource.
ValidationMethod string
Validation method for adding a custom domain
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the static site.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
DomainName Changes to this property will trigger replacement. string
The custom domain to create.
Kind string
Kind of resource.
ValidationMethod string
Validation method for adding a custom domain
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the static site.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
domainName Changes to this property will trigger replacement. String
The custom domain to create.
kind String
Kind of resource.
validationMethod String
Validation method for adding a custom domain
name
This property is required.
Changes to this property will trigger replacement.
string
Name of the static site.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
domainName Changes to this property will trigger replacement. string
The custom domain to create.
kind string
Kind of resource.
validationMethod string
Validation method for adding a custom domain
name
This property is required.
Changes to this property will trigger replacement.
str
Name of the static site.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group to which the resource belongs.
domain_name Changes to this property will trigger replacement. str
The custom domain to create.
kind str
Kind of resource.
validation_method str
Validation method for adding a custom domain
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the static site.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
domainName Changes to this property will trigger replacement. String
The custom domain to create.
kind String
Kind of resource.
validationMethod String
Validation method for adding a custom domain

Outputs

All input properties are implicitly available as output properties. Additionally, the StaticSiteCustomDomain resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
CreatedOn string
The date and time on which the custom domain was created for the static site.
ErrorMessage string
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the custom domain
Type string
Resource type.
ValidationToken string
The TXT record validation token
AzureApiVersion string
The Azure API version of the resource.
CreatedOn string
The date and time on which the custom domain was created for the static site.
ErrorMessage string
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the custom domain
Type string
Resource type.
ValidationToken string
The TXT record validation token
azureApiVersion String
The Azure API version of the resource.
createdOn String
The date and time on which the custom domain was created for the static site.
errorMessage String
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the custom domain
type String
Resource type.
validationToken String
The TXT record validation token
azureApiVersion string
The Azure API version of the resource.
createdOn string
The date and time on which the custom domain was created for the static site.
errorMessage string
id string
The provider-assigned unique ID for this managed resource.
status string
The status of the custom domain
type string
Resource type.
validationToken string
The TXT record validation token
azure_api_version str
The Azure API version of the resource.
created_on str
The date and time on which the custom domain was created for the static site.
error_message str
id str
The provider-assigned unique ID for this managed resource.
status str
The status of the custom domain
type str
Resource type.
validation_token str
The TXT record validation token
azureApiVersion String
The Azure API version of the resource.
createdOn String
The date and time on which the custom domain was created for the static site.
errorMessage String
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the custom domain
type String
Resource type.
validationToken String
The TXT record validation token

Import

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

$ pulumi import azure-native:web:StaticSiteCustomDomain myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native