These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
azure-native.domainregistration.getDomain
Explore with Pulumi AI
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
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)
public static Output<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:domainregistration:getDomain
  arguments:
    # arguments dictionaryThe following arguments are supported:
- DomainName string
- Name of the domain.
- ResourceGroup stringName 
- Name of the resource group to which the resource belongs.
- DomainName string
- Name of the domain.
- ResourceGroup stringName 
- Name of the resource group to which the resource belongs.
- domainName String
- Name of the domain.
- resourceGroup StringName 
- Name of the resource group to which the resource belongs.
- domainName string
- Name of the domain.
- resourceGroup stringName 
- Name of the resource group to which the resource belongs.
- domain_name str
- Name of the domain.
- resource_group_ strname 
- Name of the resource group to which the resource belongs.
- domainName String
- Name of the domain.
- resourceGroup StringName 
- Name of the resource group to which the resource belongs.
getDomain Result
The following output properties are available:
- CreatedTime string
- Domain creation timestamp.
- DomainNot List<string>Renewable Reasons 
- Reasons why domain is not renewable.
- ExpirationTime string
- Domain expiration timestamp.
- Id string
- Resource Id.
- LastRenewed stringTime 
- Timestamp when the domain was renewed last time.
- Location string
- Resource Location.
- ManagedHost List<Pulumi.Names Azure Native. Domain Registration. Outputs. Host Name Response> 
- 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.
- ReadyFor boolDns Record Management 
- 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.Azure Native. Domain Registration. Outputs. System Data Response 
- 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
- DnsZone stringId 
- Azure DNS Zone to use
- Kind string
- Kind of resource.
- Privacy bool
- true if domain privacy is enabled for this domain; otherwise, false.
- Dictionary<string, string>
- Resource tags.
- TargetDns stringType 
- Target DNS type (would be used for migration)
- CreatedTime string
- Domain creation timestamp.
- DomainNot []stringRenewable Reasons 
- Reasons why domain is not renewable.
- ExpirationTime string
- Domain expiration timestamp.
- Id string
- Resource Id.
- LastRenewed stringTime 
- Timestamp when the domain was renewed last time.
- Location string
- Resource Location.
- ManagedHost []HostNames Name Response 
- All hostnames derived from the domain and assigned to Azure resources.
- Name string
- Resource Name.
- NameServers []string
- Name servers.
- ProvisioningState string
- Domain provisioning state.
- ReadyFor boolDns Record Management 
- 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 SystemData Response 
- 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
- DnsZone stringId 
- Azure DNS Zone to use
- Kind string
- Kind of resource.
- Privacy bool
- true if domain privacy is enabled for this domain; otherwise, false.
- map[string]string
- Resource tags.
- TargetDns stringType 
- Target DNS type (would be used for migration)
- createdTime String
- Domain creation timestamp.
- domainNot List<String>Renewable Reasons 
- Reasons why domain is not renewable.
- expirationTime String
- Domain expiration timestamp.
- id String
- Resource Id.
- lastRenewed StringTime 
- Timestamp when the domain was renewed last time.
- location String
- Resource Location.
- managedHost List<HostNames Name Response> 
- 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.
- readyFor BooleanDns Record Management 
- 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 SystemData Response 
- 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
- dnsZone StringId 
- Azure DNS Zone to use
- kind String
- Kind of resource.
- privacy Boolean
- true if domain privacy is enabled for this domain; otherwise, false.
- Map<String,String>
- Resource tags.
- targetDns StringType 
- Target DNS type (would be used for migration)
- createdTime string
- Domain creation timestamp.
- domainNot string[]Renewable Reasons 
- Reasons why domain is not renewable.
- expirationTime string
- Domain expiration timestamp.
- id string
- Resource Id.
- lastRenewed stringTime 
- Timestamp when the domain was renewed last time.
- location string
- Resource Location.
- managedHost HostNames Name Response[] 
- All hostnames derived from the domain and assigned to Azure resources.
- name string
- Resource Name.
- nameServers string[]
- Name servers.
- provisioningState string
- Domain provisioning state.
- readyFor booleanDns Record Management 
- 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 SystemData Response 
- 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
- dnsZone stringId 
- Azure DNS Zone to use
- kind string
- Kind of resource.
- privacy boolean
- true if domain privacy is enabled for this domain; otherwise, false.
- {[key: string]: string}
- Resource tags.
- targetDns stringType 
- Target DNS type (would be used for migration)
- created_time str
- Domain creation timestamp.
- domain_not_ Sequence[str]renewable_ reasons 
- Reasons why domain is not renewable.
- expiration_time str
- Domain expiration timestamp.
- id str
- Resource Id.
- last_renewed_ strtime 
- Timestamp when the domain was renewed last time.
- location str
- Resource Location.
- managed_host_ Sequence[Hostnames Name Response] 
- 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_ booldns_ record_ management 
- 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 SystemData Response 
- 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_ strid 
- Azure DNS Zone to use
- kind str
- Kind of resource.
- privacy bool
- true if domain privacy is enabled for this domain; otherwise, false.
- Mapping[str, str]
- Resource tags.
- target_dns_ strtype 
- Target DNS type (would be used for migration)
- createdTime String
- Domain creation timestamp.
- domainNot List<String>Renewable Reasons 
- Reasons why domain is not renewable.
- expirationTime String
- Domain expiration timestamp.
- id String
- Resource Id.
- lastRenewed StringTime 
- Timestamp when the domain was renewed last time.
- location String
- Resource Location.
- managedHost List<Property Map>Names 
- 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.
- readyFor BooleanDns Record Management 
- 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
- dnsZone StringId 
- Azure DNS Zone to use
- kind String
- Kind of resource.
- privacy Boolean
- true if domain privacy is enabled for this domain; otherwise, false.
- Map<String>
- Resource tags.
- targetDns StringType 
- Target DNS type (would be used for migration)
Supporting Types
HostNameResponse  
- AzureResource stringName 
- 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.
- AzureResource stringType 
- Type of the Azure resource the hostname is assigned to.
- CustomHost stringName Dns Record Type 
- Type of the DNS record.
- HostName stringType 
- 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.
- AzureResource stringName 
- 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.
- AzureResource stringType 
- Type of the Azure resource the hostname is assigned to.
- CustomHost stringName Dns Record Type 
- Type of the DNS record.
- HostName stringType 
- 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.
- azureResource StringName 
- 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.
- azureResource StringType 
- Type of the Azure resource the hostname is assigned to.
- customHost StringName Dns Record Type 
- Type of the DNS record.
- hostName StringType 
- 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.
- azureResource stringName 
- 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.
- azureResource stringType 
- Type of the Azure resource the hostname is assigned to.
- customHost stringName Dns Record Type 
- Type of the DNS record.
- hostName stringType 
- 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_ strname 
- 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_ strtype 
- Type of the Azure resource the hostname is assigned to.
- custom_host_ strname_ dns_ record_ type 
- Type of the DNS record.
- host_name_ strtype 
- 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.
- azureResource StringName 
- 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.
- azureResource StringType 
- Type of the Azure resource the hostname is assigned to.
- customHost StringName Dns Record Type 
- Type of the DNS record.
- hostName StringType 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi