Azure Native v1.97.0, Mar 13 23

azure-native.domainregistration.getDomain

Get a domain. API Version: 2020-10-01.

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.

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)
// Output-based functions aren't available in Java yet

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:

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.
SystemData Pulumi.AzureNative.DomainRegistration.Outputs.SystemDataResponse: The system metadata relating to this resource.
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.
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)

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.
SystemData SystemDataResponse: The system metadata relating to this resource.
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.
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)

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.
systemData SystemDataResponse: The system metadata relating to this resource.
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.
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)

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.
systemData SystemDataResponse: The system metadata relating to this resource.
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.
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)

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.
system_data SystemDataResponse: The system metadata relating to this resource.
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.
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)

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.
systemData Property Map: The system metadata relating to this resource.
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.
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.

SystemDataResponse

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.

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.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0