Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. web
  6. StaticSiteCustomDomain
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.23.0
published on Saturday, Jul 18, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.web.StaticSiteCustomDomain

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.
Viewing docs for Azure Native v3.23.0
published on Saturday, Jul 18, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Static Site Custom Domain Overview ARM resource.

    Uses Azure REST API version 2025-05-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, 2024-04-01, 2024-11-01, 2025-03-01, 2026-03-01-preview, 2026-03-15. 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",
    });

});

    package main

import (
	web "github.com/pulumi/pulumi-azure-native-sdk/web/v3"
	"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
	})
}

    pulumi {
  required_providers {
    azure-native = {
      source = "pulumi/azure-native"
    }
  }
}

resource "azure-native_web_staticsitecustomdomain" "staticSiteCustomDomain" {
  domain_name         = "custom.domain.net"
  name                = "testStaticSite0"
  resource_group_name = "rg"
}

    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.ArrayList;
import java.util.Arrays;
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());

    }
}

    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",
});

    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")

    resources:
  staticSiteCustomDomain:
    type: azure-native:web:StaticSiteCustomDomain
    properties:
      domainName: custom.domain.net
      name: testStaticSite0
      resourceGroupName: rg

    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.


    resource "azure-native_web_static_site_custom_domain" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args StaticSiteCustomDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args StaticSiteCustomDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StaticSiteCustomDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
});

    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"),
})

    resource "azure-native_web_static_site_custom_domain" "staticSiteCustomDomainResource" {
  lifecycle {
    create_before_destroy = true
  }
  name                = "string"
  resource_group_name = "string"
  domain_name         = "string"
  kind                = "string"
  validation_method   = "string"
}

    var staticSiteCustomDomainResource = new StaticSiteCustomDomain("staticSiteCustomDomainResource", StaticSiteCustomDomainArgs.builder()
    .name("string")
    .resourceGroupName("string")
    .domainName("string")
    .kind("string")
    .validationMethod("string")
    .build());

    static_site_custom_domain_resource = azure_native.web.StaticSiteCustomDomain("staticSiteCustomDomainResource",
    name="string",
    resource_group_name="string",
    domain_name="string",
    kind="string",
    validation_method="string")

    const staticSiteCustomDomainResource = new azure_native.web.StaticSiteCustomDomain("staticSiteCustomDomainResource", {
    name: "string",
    resourceGroupName: "string",
    domainName: "string",
    kind: "string",
    validationMethod: "string",
});

    type: azure-native:web:StaticSiteCustomDomain
properties:
    domainName: string
    kind: string
    name: string
    resourceGroupName: string
    validationMethod: string

    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 string
    Name of the static site.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    DomainName string
    The custom domain name.
    Kind string
    Kind of resource.
    ValidationMethod string
    Validation method for adding a custom domain
    Name string
    Name of the static site.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    DomainName string
    The custom domain name.
    Kind string
    Kind of resource.
    ValidationMethod string
    Validation method for adding a custom domain
    name string
    Name of the static site.
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    domain_name string
    The custom domain name.
    kind string
    Kind of resource.
    validation_method string
    Validation method for adding a custom domain
    name String
    Name of the static site.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    domainName String
    The custom domain name.
    kind String
    Kind of resource.
    validationMethod String
    Validation method for adding a custom domain
    name string
    Name of the static site.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    domainName string
    The custom domain name.
    kind string
    Kind of resource.
    validationMethod string
    Validation method for adding a custom domain
    name str
    Name of the static site.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    domain_name str
    The custom domain name.
    kind str
    Kind of resource.
    validation_method str
    Validation method for adding a custom domain
    name String
    Name of the static site.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    domainName String
    The custom domain name.
    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
    SystemData Pulumi.AzureNative.Web.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ValidationToken string
    The TXT record validation token
    azure_api_version string
    The Azure API version of the resource.
    created_on string
    The date and time on which the custom domain was created for the static site.
    error_message string
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the custom domain
    system_data object
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    validation_token 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
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    validationToken String
    The TXT record validation token

    Supporting Types

    SystemDataResponse, SystemDataResponseArgs

    Metadata pertaining to creation and last modification of the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    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
    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
    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
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    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
    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
    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
    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
    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
    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
    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
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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}

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

    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.
    Viewing docs for Azure Native v3.23.0
    published on Saturday, Jul 18, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial