pulumi-azure-native-kotlin/com.pulumi.azurenative.domainregistration.kotlin/Domain

Domain

class Domain : KotlinCustomResource

Information about a domain. Uses Azure REST API version 2024-04-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01. Other available API versions: 2022-09-01, 2023-01-01, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native domainregistration [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create App Service Domain

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var domain = new AzureNative.DomainRegistration.Domain("domain", new()
    {
        AuthCode = "exampleAuthCode",
        AutoRenew = true,
        Consent = new AzureNative.DomainRegistration.Inputs.DomainPurchaseConsentArgs
        {
            AgreedAt = "2021-09-10T19:30:53Z",
            AgreedBy = "192.0.2.1",
            AgreementKeys = new[]
            {
                "agreementKey1",
            },
        },
        ContactAdmin = new AzureNative.DomainRegistration.Inputs.ContactArgs
        {
            AddressMailing = new AzureNative.DomainRegistration.Inputs.AddressArgs
            {
                Address1 = "3400 State St",
                City = "Chicago",
                Country = "United States",
                PostalCode = "67098",
                State = "IL",
            },
            Email = "admin@email.com",
            Fax = "1-245-534-2242",
            JobTitle = "Admin",
            NameFirst = "John",
            NameLast = "Doe",
            NameMiddle = "",
            Organization = "Microsoft Inc.",
            Phone = "1-245-534-2242",
        },
        ContactBilling = new AzureNative.DomainRegistration.Inputs.ContactArgs
        {
            AddressMailing = new AzureNative.DomainRegistration.Inputs.AddressArgs
            {
                Address1 = "3400 State St",
                City = "Chicago",
                Country = "United States",
                PostalCode = "67098",
                State = "IL",
            },
            Email = "billing@email.com",
            Fax = "1-245-534-2242",
            JobTitle = "Billing",
            NameFirst = "John",
            NameLast = "Doe",
            NameMiddle = "",
            Organization = "Microsoft Inc.",
            Phone = "1-245-534-2242",
        },
        ContactRegistrant = new AzureNative.DomainRegistration.Inputs.ContactArgs
        {
            AddressMailing = new AzureNative.DomainRegistration.Inputs.AddressArgs
            {
                Address1 = "3400 State St",
                City = "Chicago",
                Country = "United States",
                PostalCode = "67098",
                State = "IL",
            },
            Email = "registrant@email.com",
            Fax = "1-245-534-2242",
            JobTitle = "Registrant",
            NameFirst = "John",
            NameLast = "Doe",
            NameMiddle = "",
            Organization = "Microsoft Inc.",
            Phone = "1-245-534-2242",
        },
        ContactTech = new AzureNative.DomainRegistration.Inputs.ContactArgs
        {
            AddressMailing = new AzureNative.DomainRegistration.Inputs.AddressArgs
            {
                Address1 = "3400 State St",
                City = "Chicago",
                Country = "United States",
                PostalCode = "67098",
                State = "IL",
            },
            Email = "tech@email.com",
            Fax = "1-245-534-2242",
            JobTitle = "Tech",
            NameFirst = "John",
            NameLast = "Doe",
            NameMiddle = "",
            Organization = "Microsoft Inc.",
            Phone = "1-245-534-2242",
        },
        DnsType = AzureNative.DomainRegistration.DnsType.DefaultDomainRegistrarDns,
        DomainName = "example.com",
        Location = "global",
        Privacy = false,
        ResourceGroupName = "testrg123",
        Tags = null,
    });
});
Content copied to clipboard
package main
import (
	domainregistration "github.com/pulumi/pulumi-azure-native-sdk/domainregistration/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := domainregistration.NewDomain(ctx, "domain", &domainregistration.DomainArgs{
			AuthCode:  pulumi.String("exampleAuthCode"),
			AutoRenew: pulumi.Bool(true),
			Consent: &domainregistration.DomainPurchaseConsentArgs{
				AgreedAt: pulumi.String("2021-09-10T19:30:53Z"),
				AgreedBy: pulumi.String("192.0.2.1"),
				AgreementKeys: pulumi.StringArray{
					pulumi.String("agreementKey1"),
				},
			},
			ContactAdmin: &domainregistration.ContactArgs{
				AddressMailing: &domainregistration.AddressArgs{
					Address1:   pulumi.String("3400 State St"),
					City:       pulumi.String("Chicago"),
					Country:    pulumi.String("United States"),
					PostalCode: pulumi.String("67098"),
					State:      pulumi.String("IL"),
				},
				Email:        pulumi.String("admin@email.com"),
				Fax:          pulumi.String("1-245-534-2242"),
				JobTitle:     pulumi.String("Admin"),
				NameFirst:    pulumi.String("John"),
				NameLast:     pulumi.String("Doe"),
				NameMiddle:   pulumi.String(""),
				Organization: pulumi.String("Microsoft Inc."),
				Phone:        pulumi.String("1-245-534-2242"),
			},
			ContactBilling: &domainregistration.ContactArgs{
				AddressMailing: &domainregistration.AddressArgs{
					Address1:   pulumi.String("3400 State St"),
					City:       pulumi.String("Chicago"),
					Country:    pulumi.String("United States"),
					PostalCode: pulumi.String("67098"),
					State:      pulumi.String("IL"),
				},
				Email:        pulumi.String("billing@email.com"),
				Fax:          pulumi.String("1-245-534-2242"),
				JobTitle:     pulumi.String("Billing"),
				NameFirst:    pulumi.String("John"),
				NameLast:     pulumi.String("Doe"),
				NameMiddle:   pulumi.String(""),
				Organization: pulumi.String("Microsoft Inc."),
				Phone:        pulumi.String("1-245-534-2242"),
			},
			ContactRegistrant: &domainregistration.ContactArgs{
				AddressMailing: &domainregistration.AddressArgs{
					Address1:   pulumi.String("3400 State St"),
					City:       pulumi.String("Chicago"),
					Country:    pulumi.String("United States"),
					PostalCode: pulumi.String("67098"),
					State:      pulumi.String("IL"),
				},
				Email:        pulumi.String("registrant@email.com"),
				Fax:          pulumi.String("1-245-534-2242"),
				JobTitle:     pulumi.String("Registrant"),
				NameFirst:    pulumi.String("John"),
				NameLast:     pulumi.String("Doe"),
				NameMiddle:   pulumi.String(""),
				Organization: pulumi.String("Microsoft Inc."),
				Phone:        pulumi.String("1-245-534-2242"),
			},
			ContactTech: &domainregistration.ContactArgs{
				AddressMailing: &domainregistration.AddressArgs{
					Address1:   pulumi.String("3400 State St"),
					City:       pulumi.String("Chicago"),
					Country:    pulumi.String("United States"),
					PostalCode: pulumi.String("67098"),
					State:      pulumi.String("IL"),
				},
				Email:        pulumi.String("tech@email.com"),
				Fax:          pulumi.String("1-245-534-2242"),
				JobTitle:     pulumi.String("Tech"),
				NameFirst:    pulumi.String("John"),
				NameLast:     pulumi.String("Doe"),
				NameMiddle:   pulumi.String(""),
				Organization: pulumi.String("Microsoft Inc."),
				Phone:        pulumi.String("1-245-534-2242"),
			},
			DnsType:           domainregistration.DnsTypeDefaultDomainRegistrarDns,
			DomainName:        pulumi.String("example.com"),
			Location:          pulumi.String("global"),
			Privacy:           pulumi.Bool(false),
			ResourceGroupName: pulumi.String("testrg123"),
			Tags:              pulumi.StringMap{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.domainregistration.Domain;
import com.pulumi.azurenative.domainregistration.DomainArgs;
import com.pulumi.azurenative.domainregistration.inputs.DomainPurchaseConsentArgs;
import com.pulumi.azurenative.domainregistration.inputs.ContactArgs;
import com.pulumi.azurenative.domainregistration.inputs.AddressArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var domain = new Domain("domain", DomainArgs.builder()
            .authCode("exampleAuthCode")
            .autoRenew(true)
            .consent(DomainPurchaseConsentArgs.builder()
                .agreedAt("2021-09-10T19:30:53Z")
                .agreedBy("192.0.2.1")
                .agreementKeys("agreementKey1")
                .build())
            .contactAdmin(ContactArgs.builder()
                .addressMailing(AddressArgs.builder()
                    .address1("3400 State St")
                    .city("Chicago")
                    .country("United States")
                    .postalCode("67098")
                    .state("IL")
                    .build())
                .email("admin@email.com")
                .fax("1-245-534-2242")
                .jobTitle("Admin")
                .nameFirst("John")
                .nameLast("Doe")
                .nameMiddle("")
                .organization("Microsoft Inc.")
                .phone("1-245-534-2242")
                .build())
            .contactBilling(ContactArgs.builder()
                .addressMailing(AddressArgs.builder()
                    .address1("3400 State St")
                    .city("Chicago")
                    .country("United States")
                    .postalCode("67098")
                    .state("IL")
                    .build())
                .email("billing@email.com")
                .fax("1-245-534-2242")
                .jobTitle("Billing")
                .nameFirst("John")
                .nameLast("Doe")
                .nameMiddle("")
                .organization("Microsoft Inc.")
                .phone("1-245-534-2242")
                .build())
            .contactRegistrant(ContactArgs.builder()
                .addressMailing(AddressArgs.builder()
                    .address1("3400 State St")
                    .city("Chicago")
                    .country("United States")
                    .postalCode("67098")
                    .state("IL")
                    .build())
                .email("registrant@email.com")
                .fax("1-245-534-2242")
                .jobTitle("Registrant")
                .nameFirst("John")
                .nameLast("Doe")
                .nameMiddle("")
                .organization("Microsoft Inc.")
                .phone("1-245-534-2242")
                .build())
            .contactTech(ContactArgs.builder()
                .addressMailing(AddressArgs.builder()
                    .address1("3400 State St")
                    .city("Chicago")
                    .country("United States")
                    .postalCode("67098")
                    .state("IL")
                    .build())
                .email("tech@email.com")
                .fax("1-245-534-2242")
                .jobTitle("Tech")
                .nameFirst("John")
                .nameLast("Doe")
                .nameMiddle("")
                .organization("Microsoft Inc.")
                .phone("1-245-534-2242")
                .build())
            .dnsType("DefaultDomainRegistrarDns")
            .domainName("example.com")
            .location("global")
            .privacy(false)
            .resourceGroupName("testrg123")
            .tags(Map.ofEntries(
            ))
            .build());
    }
}
Content copied to clipboard

Import

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

$ pulumi import azure-native:domainregistration:Domain example.com /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
Content copied to clipboard

Properties

Link copied to clipboard
val authCode: Output<String>?
Link copied to clipboard
val autoRenew: Output<Boolean>?

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

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val createdTime: Output<String>

Domain creation timestamp.

Link copied to clipboard
val dnsType: Output<String>?

Current DNS type

Link copied to clipboard
val dnsZoneId: Output<String>?

Azure DNS Zone to use

Link copied to clipboard
val domainNotRenewableReasons: Output<List<String>>

Reasons why domain is not renewable.

Link copied to clipboard
val expirationTime: Output<String>

Domain expiration timestamp.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val kind: Output<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.

Link copied to clipboard
val lastRenewedTime: Output<String>

Timestamp when the domain was renewed last time.

Link copied to clipboard
val location: Output<String>

Resource Location.

Link copied to clipboard
val managedHostNames: Output<List<HostNameResponse>>

All hostnames derived from the domain and assigned to Azure resources.

Link copied to clipboard
val name: Output<String>

Resource Name.

Link copied to clipboard
val nameServers: Output<List<String>>

Name servers.

Link copied to clipboard
val privacy: Output<Boolean>?

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

Link copied to clipboard
val provisioningState: Output<String>

Domain provisioning state.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val readyForDnsRecordManagement: Output<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.

Link copied to clipboard
val registrationStatus: Output<String>

Domain registration status.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Resource tags.

Link copied to clipboard
val targetDnsType: Output<String>?

Target DNS type (would be used for migration)

Link copied to clipboard
val type: Output<String>

Resource type.

Link copied to clipboard
val urn: Output<String>