Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. web
  5. getStaticSiteCustomDomain
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.web.getStaticSiteCustomDomain

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Description for Gets an existing custom domain for a particular static site. Azure REST API version: 2022-09-01.

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

Using getStaticSiteCustomDomain

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getStaticSiteCustomDomain(args: GetStaticSiteCustomDomainArgs, opts?: InvokeOptions): Promise<GetStaticSiteCustomDomainResult>
function getStaticSiteCustomDomainOutput(args: GetStaticSiteCustomDomainOutputArgs, opts?: InvokeOptions): Output<GetStaticSiteCustomDomainResult>
Copy
def get_static_site_custom_domain(domain_name: Optional[str] = None,
                                  name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetStaticSiteCustomDomainResult
def get_static_site_custom_domain_output(domain_name: Optional[pulumi.Input[str]] = None,
                                  name: Optional[pulumi.Input[str]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetStaticSiteCustomDomainResult]
Copy
func LookupStaticSiteCustomDomain(ctx *Context, args *LookupStaticSiteCustomDomainArgs, opts ...InvokeOption) (*LookupStaticSiteCustomDomainResult, error)
func LookupStaticSiteCustomDomainOutput(ctx *Context, args *LookupStaticSiteCustomDomainOutputArgs, opts ...InvokeOption) LookupStaticSiteCustomDomainResultOutput
Copy

> Note: This function is named LookupStaticSiteCustomDomain in the Go SDK.

public static class GetStaticSiteCustomDomain 
{
    public static Task<GetStaticSiteCustomDomainResult> InvokeAsync(GetStaticSiteCustomDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetStaticSiteCustomDomainResult> Invoke(GetStaticSiteCustomDomainInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetStaticSiteCustomDomainResult> getStaticSiteCustomDomain(GetStaticSiteCustomDomainArgs args, InvokeOptions options)
public static Output<GetStaticSiteCustomDomainResult> getStaticSiteCustomDomain(GetStaticSiteCustomDomainArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:web:getStaticSiteCustomDomain
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DomainName
This property is required.
Changes to this property will trigger replacement.
string
The custom domain name.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the static site resource to search in.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
DomainName
This property is required.
Changes to this property will trigger replacement.
string
The custom domain name.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the static site resource to search in.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
domainName
This property is required.
Changes to this property will trigger replacement.
String
The custom domain name.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the static site resource to search in.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
domainName
This property is required.
Changes to this property will trigger replacement.
string
The custom domain name.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of the static site resource to search in.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
domain_name
This property is required.
Changes to this property will trigger replacement.
str
The custom domain name.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of the static site resource to search in.
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.
domainName
This property is required.
Changes to this property will trigger replacement.
String
The custom domain name.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the static site resource to search in.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.

getStaticSiteCustomDomain Result

The following output properties are available:

CreatedOn string
The date and time on which the custom domain was created for the static site.
DomainName string
The domain name for the static site custom domain.
ErrorMessage string
Id string
Resource Id.
Name string
Resource Name.
Status string
The status of the custom domain
Type string
Resource type.
ValidationToken string
The TXT record validation token
Kind string
Kind of resource.
CreatedOn string
The date and time on which the custom domain was created for the static site.
DomainName string
The domain name for the static site custom domain.
ErrorMessage string
Id string
Resource Id.
Name string
Resource Name.
Status string
The status of the custom domain
Type string
Resource type.
ValidationToken string
The TXT record validation token
Kind string
Kind of resource.
createdOn String
The date and time on which the custom domain was created for the static site.
domainName String
The domain name for the static site custom domain.
errorMessage String
id String
Resource Id.
name String
Resource Name.
status String
The status of the custom domain
type String
Resource type.
validationToken String
The TXT record validation token
kind String
Kind of resource.
createdOn string
The date and time on which the custom domain was created for the static site.
domainName string
The domain name for the static site custom domain.
errorMessage string
id string
Resource Id.
name string
Resource Name.
status string
The status of the custom domain
type string
Resource type.
validationToken string
The TXT record validation token
kind string
Kind of resource.
created_on str
The date and time on which the custom domain was created for the static site.
domain_name str
The domain name for the static site custom domain.
error_message str
id str
Resource Id.
name str
Resource Name.
status str
The status of the custom domain
type str
Resource type.
validation_token str
The TXT record validation token
kind str
Kind of resource.
createdOn String
The date and time on which the custom domain was created for the static site.
domainName String
The domain name for the static site custom domain.
errorMessage String
id String
Resource Id.
name String
Resource Name.
status String
The status of the custom domain
type String
Resource type.
validationToken String
The TXT record validation token
kind String
Kind of resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native