Azure Native

Pulumi Official
Package maintained by Pulumi
v1.67.0 published on Tuesday, Jul 12, 2022 by Pulumi

Domain

Information about a domain. API Version: 2020-10-01.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:domainregistration:Domain myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName} 

Create a Domain Resource

new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           auth_code: Optional[str] = None,
           auto_renew: Optional[bool] = None,
           consent: Optional[DomainPurchaseConsentArgs] = None,
           contact_admin: Optional[ContactArgs] = None,
           contact_billing: Optional[ContactArgs] = None,
           contact_registrant: Optional[ContactArgs] = None,
           contact_tech: Optional[ContactArgs] = None,
           dns_type: Optional[DnsType] = None,
           dns_zone_id: Optional[str] = None,
           domain_name: Optional[str] = None,
           kind: Optional[str] = None,
           location: Optional[str] = None,
           privacy: Optional[bool] = None,
           resource_group_name: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           target_dns_type: Optional[DnsType] = None)
@overload
def Domain(resource_name: str,
           args: DomainArgs,
           opts: Optional[ResourceOptions] = None)
func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)
type: azure-native:domainregistration:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DomainArgs
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 DomainArgs
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 DomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Domain 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 Domain resource accepts the following input properties:

Consent Pulumi.AzureNative.DomainRegistration.Inputs.DomainPurchaseConsentArgs

Legal agreement consent.

ContactAdmin Pulumi.AzureNative.DomainRegistration.Inputs.ContactArgs

Administrative contact.

ContactBilling Pulumi.AzureNative.DomainRegistration.Inputs.ContactArgs

Billing contact.

ContactRegistrant Pulumi.AzureNative.DomainRegistration.Inputs.ContactArgs

Registrant contact.

ContactTech Pulumi.AzureNative.DomainRegistration.Inputs.ContactArgs

Technical contact.

ResourceGroupName string

Name of the resource group to which the resource belongs.

AuthCode string
AutoRenew bool

true if the domain should be automatically renewed; otherwise, false.

DnsType Pulumi.AzureNative.DomainRegistration.DnsType

Current DNS type

DnsZoneId string

Azure DNS Zone to use

DomainName string

Name of the domain.

Kind string

Kind of resource.

Location string

Resource Location.

Privacy bool

true if domain privacy is enabled for this domain; otherwise, false.

Tags Dictionary<string, string>

Resource tags.

TargetDnsType Pulumi.AzureNative.DomainRegistration.DnsType

Target DNS type (would be used for migration)

Consent DomainPurchaseConsentArgs

Legal agreement consent.

ContactAdmin ContactArgs

Administrative contact.

ContactBilling ContactArgs

Billing contact.

ContactRegistrant ContactArgs

Registrant contact.

ContactTech ContactArgs

Technical contact.

ResourceGroupName string

Name of the resource group to which the resource belongs.

AuthCode string
AutoRenew bool

true if the domain should be automatically renewed; otherwise, false.

DnsType DnsType

Current DNS type

DnsZoneId string

Azure DNS Zone to use

DomainName string

Name of the domain.

Kind string

Kind of resource.

Location string

Resource Location.

Privacy bool

true if domain privacy is enabled for this domain; otherwise, false.

Tags map[string]string

Resource tags.

TargetDnsType DnsType

Target DNS type (would be used for migration)

consent DomainPurchaseConsentArgs

Legal agreement consent.

contactAdmin ContactArgs

Administrative contact.

contactBilling ContactArgs

Billing contact.

contactRegistrant ContactArgs

Registrant contact.

contactTech ContactArgs

Technical contact.

resourceGroupName String

Name of the resource group to which the resource belongs.

authCode String
autoRenew Boolean

true if the domain should be automatically renewed; otherwise, false.

dnsType DnsType

Current DNS type

dnsZoneId String

Azure DNS Zone to use

domainName String

Name of the domain.

kind String

Kind of resource.

location String

Resource Location.

privacy Boolean

true if domain privacy is enabled for this domain; otherwise, false.

tags Map<String,String>

Resource tags.

targetDnsType DnsType

Target DNS type (would be used for migration)

consent DomainPurchaseConsentArgs

Legal agreement consent.

contactAdmin ContactArgs

Administrative contact.

contactBilling ContactArgs

Billing contact.

contactRegistrant ContactArgs

Registrant contact.

contactTech ContactArgs

Technical contact.

resourceGroupName string

Name of the resource group to which the resource belongs.

authCode string
autoRenew boolean

true if the domain should be automatically renewed; otherwise, false.

dnsType DnsType

Current DNS type

dnsZoneId string

Azure DNS Zone to use

domainName string

Name of the domain.

kind string

Kind of resource.

location string

Resource Location.

privacy boolean

true if domain privacy is enabled for this domain; otherwise, false.

tags {[key: string]: string}

Resource tags.

targetDnsType DnsType

Target DNS type (would be used for migration)

consent DomainPurchaseConsentArgs

Legal agreement consent.

contact_admin ContactArgs

Administrative contact.

contact_billing ContactArgs

Billing contact.

contact_registrant ContactArgs

Registrant contact.

contact_tech ContactArgs

Technical contact.

resource_group_name str

Name of the resource group to which the resource belongs.

auth_code str
auto_renew bool

true if the domain should be automatically renewed; otherwise, false.

dns_type DnsType

Current DNS type

dns_zone_id str

Azure DNS Zone to use

domain_name str

Name of the domain.

kind str

Kind of resource.

location str

Resource Location.

privacy bool

true if domain privacy is enabled for this domain; otherwise, false.

tags Mapping[str, str]

Resource tags.

target_dns_type DnsType

Target DNS type (would be used for migration)

consent Property Map

Legal agreement consent.

contactAdmin Property Map

Administrative contact.

contactBilling Property Map

Billing contact.

contactRegistrant Property Map

Registrant contact.

contactTech Property Map

Technical contact.

resourceGroupName String

Name of the resource group to which the resource belongs.

authCode String
autoRenew Boolean

true if the domain should be automatically renewed; otherwise, false.

dnsType "AzureDns" | "DefaultDomainRegistrarDns"

Current DNS type

dnsZoneId String

Azure DNS Zone to use

domainName String

Name of the domain.

kind String

Kind of resource.

location String

Resource Location.

privacy Boolean

true if domain privacy is enabled for this domain; otherwise, false.

tags Map<String>

Resource tags.

targetDnsType "AzureDns" | "DefaultDomainRegistrarDns"

Target DNS type (would be used for migration)

Outputs

All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:

CreatedTime string

Domain creation timestamp.

DomainNotRenewableReasons List<string>

Reasons why domain is not renewable.

ExpirationTime string

Domain expiration timestamp.

Id string

The provider-assigned unique ID for this managed resource.

LastRenewedTime string

Timestamp when the domain was renewed last time.

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.

CreatedTime string

Domain creation timestamp.

DomainNotRenewableReasons []string

Reasons why domain is not renewable.

ExpirationTime string

Domain expiration timestamp.

Id string

The provider-assigned unique ID for this managed resource.

LastRenewedTime string

Timestamp when the domain was renewed last time.

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.

createdTime String

Domain creation timestamp.

domainNotRenewableReasons List<String>

Reasons why domain is not renewable.

expirationTime String

Domain expiration timestamp.

id String

The provider-assigned unique ID for this managed resource.

lastRenewedTime String

Timestamp when the domain was renewed last time.

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.

createdTime string

Domain creation timestamp.

domainNotRenewableReasons string[]

Reasons why domain is not renewable.

expirationTime string

Domain expiration timestamp.

id string

The provider-assigned unique ID for this managed resource.

lastRenewedTime string

Timestamp when the domain was renewed last time.

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.

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

The provider-assigned unique ID for this managed resource.

last_renewed_time str

Timestamp when the domain was renewed last time.

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.

createdTime String

Domain creation timestamp.

domainNotRenewableReasons List<String>

Reasons why domain is not renewable.

expirationTime String

Domain expiration timestamp.

id String

The provider-assigned unique ID for this managed resource.

lastRenewedTime String

Timestamp when the domain was renewed last time.

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.

Supporting Types

Address

Address1 string

First line of an Address.

City string

The city for the address.

Country string

The country for the address.

PostalCode string

The postal code for the address.

State string

The state or province for the address.

Address2 string

The second line of the Address. Optional.

Address1 string

First line of an Address.

City string

The city for the address.

Country string

The country for the address.

PostalCode string

The postal code for the address.

State string

The state or province for the address.

Address2 string

The second line of the Address. Optional.

address1 String

First line of an Address.

city String

The city for the address.

country String

The country for the address.

postalCode String

The postal code for the address.

state String

The state or province for the address.

address2 String

The second line of the Address. Optional.

address1 string

First line of an Address.

city string

The city for the address.

country string

The country for the address.

postalCode string

The postal code for the address.

state string

The state or province for the address.

address2 string

The second line of the Address. Optional.

address1 str

First line of an Address.

city str

The city for the address.

country str

The country for the address.

postal_code str

The postal code for the address.

state str

The state or province for the address.

address2 str

The second line of the Address. Optional.

address1 String

First line of an Address.

city String

The city for the address.

country String

The country for the address.

postalCode String

The postal code for the address.

state String

The state or province for the address.

address2 String

The second line of the Address. Optional.

Contact

Email string

Email address.

NameFirst string

First name.

NameLast string

Last name.

Phone string

Phone number.

AddressMailing Pulumi.AzureNative.DomainRegistration.Inputs.Address

Mailing address.

Fax string

Fax number.

JobTitle string

Job title.

NameMiddle string

Middle name.

Organization string

Organization contact belongs to.

Email string

Email address.

NameFirst string

First name.

NameLast string

Last name.

Phone string

Phone number.

AddressMailing Address

Mailing address.

Fax string

Fax number.

JobTitle string

Job title.

NameMiddle string

Middle name.

Organization string

Organization contact belongs to.

email String

Email address.

nameFirst String

First name.

nameLast String

Last name.

phone String

Phone number.

addressMailing Address

Mailing address.

fax String

Fax number.

jobTitle String

Job title.

nameMiddle String

Middle name.

organization String

Organization contact belongs to.

email string

Email address.

nameFirst string

First name.

nameLast string

Last name.

phone string

Phone number.

addressMailing Address

Mailing address.

fax string

Fax number.

jobTitle string

Job title.

nameMiddle string

Middle name.

organization string

Organization contact belongs to.

email str

Email address.

name_first str

First name.

name_last str

Last name.

phone str

Phone number.

address_mailing Address

Mailing address.

fax str

Fax number.

job_title str

Job title.

name_middle str

Middle name.

organization str

Organization contact belongs to.

email String

Email address.

nameFirst String

First name.

nameLast String

Last name.

phone String

Phone number.

addressMailing Property Map

Mailing address.

fax String

Fax number.

jobTitle String

Job title.

nameMiddle String

Middle name.

organization String

Organization contact belongs to.

DnsType

AzureDns
AzureDns
DefaultDomainRegistrarDns
DefaultDomainRegistrarDns
DnsTypeAzureDns
AzureDns
DnsTypeDefaultDomainRegistrarDns
DefaultDomainRegistrarDns
AzureDns
AzureDns
DefaultDomainRegistrarDns
DefaultDomainRegistrarDns
AzureDns
AzureDns
DefaultDomainRegistrarDns
DefaultDomainRegistrarDns
AZURE_DNS
AzureDns
DEFAULT_DOMAIN_REGISTRAR_DNS
DefaultDomainRegistrarDns
"AzureDns"
AzureDns
"DefaultDomainRegistrarDns"
DefaultDomainRegistrarDns

DomainPurchaseConsent

AgreedAt string

Timestamp when the agreements were accepted.

AgreedBy string

Client IP address.

AgreementKeys List<string>

List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.

AgreedAt string

Timestamp when the agreements were accepted.

AgreedBy string

Client IP address.

AgreementKeys []string

List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.

agreedAt String

Timestamp when the agreements were accepted.

agreedBy String

Client IP address.

agreementKeys List<String>

List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.

agreedAt string

Timestamp when the agreements were accepted.

agreedBy string

Client IP address.

agreementKeys string[]

List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.

agreed_at str

Timestamp when the agreements were accepted.

agreed_by str

Client IP address.

agreement_keys Sequence[str]

List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.

agreedAt String

Timestamp when the agreements were accepted.

agreedBy String

Client IP address.

agreementKeys List<String>

List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.

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
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0