Azure Native v3.1.0, Apr 8 25

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.domainregistration.getDomain

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Using getDomain

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.

TypeScript
Python
Go
C#
Java
YAML

function getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>

def get_domain(domain_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(domain_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]

func LookupDomain(ctx *Context, args *LookupDomainArgs, opts ...InvokeOption) (*LookupDomainResult, error)
func LookupDomainOutput(ctx *Context, args *LookupDomainOutputArgs, opts ...InvokeOption) LookupDomainResultOutput

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

public static class GetDomain 
{
    public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
public static Output<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:domainregistration:getDomain
  arguments:
    # arguments dictionary

The following arguments are supported:

DomainName string: Name of the domain.
ResourceGroupName string: Name of the resource group to which the resource belongs.

DomainName string: Name of the domain.
ResourceGroupName string: Name of the resource group to which the resource belongs.

domainName String: Name of the domain.
resourceGroupName String: Name of the resource group to which the resource belongs.

domainName string: Name of the domain.
resourceGroupName string: Name of the resource group to which the resource belongs.

domain_name str: Name of the domain.
resource_group_name str: Name of the resource group to which the resource belongs.

domainName String: Name of the domain.
resourceGroupName String: Name of the resource group to which the resource belongs.

getDomain Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
CreatedTime string: Domain creation timestamp.
DomainNotRenewableReasons List<string>: Reasons why domain is not renewable.
ExpirationTime string: Domain expiration timestamp.
Id string: Resource Id.
LastRenewedTime string: Timestamp when the domain was renewed last time.
Location string: Resource Location.
ManagedHostNames List<Pulumi.AzureNative.DomainRegistration.Outputs.HostNameResponse>: All hostnames derived from the domain and assigned to Azure resources.
Name string: Resource Name.
NameServers List<string>: Name servers.
ProvisioningState string: Domain provisioning state.
ReadyForDnsRecordManagement bool: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to.
RegistrationStatus string: Domain registration status.
Type string: Resource type.
AuthCode string
AutoRenew bool: true if the domain should be automatically renewed; otherwise, false.
DnsType string: Current DNS type
DnsZoneId string: Azure DNS Zone to use
Kind string: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
Privacy bool: true if domain privacy is enabled for this domain; otherwise, false.
Tags Dictionary<string, string>: Resource tags.
TargetDnsType string: Target DNS type (would be used for migration)

AzureApiVersion string: The Azure API version of the resource.
CreatedTime string: Domain creation timestamp.
DomainNotRenewableReasons []string: Reasons why domain is not renewable.
ExpirationTime string: Domain expiration timestamp.
Id string: Resource Id.
LastRenewedTime string: Timestamp when the domain was renewed last time.
Location string: Resource Location.
ManagedHostNames []HostNameResponse: All hostnames derived from the domain and assigned to Azure resources.
Name string: Resource Name.
NameServers []string: Name servers.
ProvisioningState string: Domain provisioning state.
ReadyForDnsRecordManagement bool: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to.
RegistrationStatus string: Domain registration status.
Type string: Resource type.
AuthCode string
AutoRenew bool: true if the domain should be automatically renewed; otherwise, false.
DnsType string: Current DNS type
DnsZoneId string: Azure DNS Zone to use
Kind string: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
Privacy bool: true if domain privacy is enabled for this domain; otherwise, false.
Tags map[string]string: Resource tags.
TargetDnsType string: Target DNS type (would be used for migration)

azureApiVersion String: The Azure API version of the resource.
createdTime String: Domain creation timestamp.
domainNotRenewableReasons List<String>: Reasons why domain is not renewable.
expirationTime String: Domain expiration timestamp.
id String: Resource Id.
lastRenewedTime String: Timestamp when the domain was renewed last time.
location String: Resource Location.
managedHostNames List<HostNameResponse>: All hostnames derived from the domain and assigned to Azure resources.
name String: Resource Name.
nameServers List<String>: Name servers.
provisioningState String: Domain provisioning state.
readyForDnsRecordManagement Boolean: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to.
registrationStatus String: Domain registration status.
type String: Resource type.
authCode String
autoRenew Boolean: true if the domain should be automatically renewed; otherwise, false.
dnsType String: Current DNS type
dnsZoneId String: Azure DNS Zone to use
kind String: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
privacy Boolean: true if domain privacy is enabled for this domain; otherwise, false.
tags Map<String,String>: Resource tags.
targetDnsType String: Target DNS type (would be used for migration)

azureApiVersion string: The Azure API version of the resource.
createdTime string: Domain creation timestamp.
domainNotRenewableReasons string[]: Reasons why domain is not renewable.
expirationTime string: Domain expiration timestamp.
id string: Resource Id.
lastRenewedTime string: Timestamp when the domain was renewed last time.
location string: Resource Location.
managedHostNames HostNameResponse[]: All hostnames derived from the domain and assigned to Azure resources.
name string: Resource Name.
nameServers string[]: Name servers.
provisioningState string: Domain provisioning state.
readyForDnsRecordManagement boolean: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to.
registrationStatus string: Domain registration status.
type string: Resource type.
authCode string
autoRenew boolean: true if the domain should be automatically renewed; otherwise, false.
dnsType string: Current DNS type
dnsZoneId string: Azure DNS Zone to use
kind string: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
privacy boolean: true if domain privacy is enabled for this domain; otherwise, false.
tags {[key: string]: string}: Resource tags.
targetDnsType string: Target DNS type (would be used for migration)

azure_api_version str: The Azure API version of the resource.
created_time str: Domain creation timestamp.
domain_not_renewable_reasons Sequence[str]: Reasons why domain is not renewable.
expiration_time str: Domain expiration timestamp.
id str: Resource Id.
last_renewed_time str: Timestamp when the domain was renewed last time.
location str: Resource Location.
managed_host_names Sequence[HostNameResponse]: All hostnames derived from the domain and assigned to Azure resources.
name str: Resource Name.
name_servers Sequence[str]: Name servers.
provisioning_state str: Domain provisioning state.
ready_for_dns_record_management bool: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to.
registration_status str: Domain registration status.
type str: Resource type.
auth_code str
auto_renew bool: true if the domain should be automatically renewed; otherwise, false.
dns_type str: Current DNS type
dns_zone_id str: Azure DNS Zone to use
kind str: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
privacy bool: true if domain privacy is enabled for this domain; otherwise, false.
tags Mapping[str, str]: Resource tags.
target_dns_type str: Target DNS type (would be used for migration)

azureApiVersion String: The Azure API version of the resource.
createdTime String: Domain creation timestamp.
domainNotRenewableReasons List<String>: Reasons why domain is not renewable.
expirationTime String: Domain expiration timestamp.
id String: Resource Id.
lastRenewedTime String: Timestamp when the domain was renewed last time.
location String: Resource Location.
managedHostNames List<Property Map>: All hostnames derived from the domain and assigned to Azure resources.
name String: Resource Name.
nameServers List<String>: Name servers.
provisioningState String: Domain provisioning state.
readyForDnsRecordManagement Boolean: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to.
registrationStatus String: Domain registration status.
type String: Resource type.
authCode String
autoRenew Boolean: true if the domain should be automatically renewed; otherwise, false.
dnsType String: Current DNS type
dnsZoneId String: Azure DNS Zone to use
kind String: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
privacy Boolean: true if domain privacy is enabled for this domain; otherwise, false.
tags Map<String>: Resource tags.
targetDnsType String: Target DNS type (would be used for migration)

Supporting Types

HostNameResponse

AzureResourceName string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name.
AzureResourceType string: Type of the Azure resource the hostname is assigned to.
CustomHostNameDnsRecordType string: Type of the DNS record.
HostNameType string: Type of the hostname.
Name string: Name of the hostname.
SiteNames List<string>: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager.

AzureResourceName string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name.
AzureResourceType string: Type of the Azure resource the hostname is assigned to.
CustomHostNameDnsRecordType string: Type of the DNS record.
HostNameType string: Type of the hostname.
Name string: Name of the hostname.
SiteNames []string: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager.

azureResourceName String: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name.
azureResourceType String: Type of the Azure resource the hostname is assigned to.
customHostNameDnsRecordType String: Type of the DNS record.
hostNameType String: Type of the hostname.
name String: Name of the hostname.
siteNames List<String>: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager.

azureResourceName string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name.
azureResourceType string: Type of the Azure resource the hostname is assigned to.
customHostNameDnsRecordType string: Type of the DNS record.
hostNameType string: Type of the hostname.
name string: Name of the hostname.
siteNames string[]: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager.

azure_resource_name str: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name.
azure_resource_type str: Type of the Azure resource the hostname is assigned to.
custom_host_name_dns_record_type str: Type of the DNS record.
host_name_type str: Type of the hostname.
name str: Name of the hostname.
site_names Sequence[str]: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager.

azureResourceName String: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name.
azureResourceType String: Type of the Azure resource the hostname is assigned to.
customHostNameDnsRecordType String: Type of the DNS record.
hostNameType String: Type of the hostname.
name String: Name of the hostname.
siteNames List<String>: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.domainregistration.getDomain

On this page

On this page

Using getDomain

getDomain Result

Supporting Types

HostNameResponse

Package Details

On this page

On this page