1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. StaticSiteCustomDomain
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi

azure-native.web.StaticSiteCustomDomain

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi

    Static Site Custom Domain Overview ARM resource. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2020-12-01.

    Other available API versions: 2023-01-01, 2023-12-01.

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

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

    The StaticSiteCustomDomain resource accepts the following input properties:

    Name string
    Name of the static site.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    DomainName string
    The custom domain to create.
    Kind string
    Kind of resource.
    ValidationMethod string
    Validation method for adding a custom domain
    Name string
    Name of the static site.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    DomainName string
    The custom domain to create.
    Kind string
    Kind of resource.
    ValidationMethod string
    Validation method for adding a custom domain
    name String
    Name of the static site.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    domainName String
    The custom domain to create.
    kind String
    Kind of resource.
    validationMethod String
    Validation method for adding a custom domain
    name string
    Name of the static site.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    domainName string
    The custom domain to create.
    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
    Name of the resource group to which the resource belongs.
    domain_name str
    The custom domain to create.
    kind str
    Kind of resource.
    validation_method str
    Validation method for adding a custom domain
    name String
    Name of the static site.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    domainName 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:

    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
    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
    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
    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
    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
    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} 
    

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi