Domains - Update

Service:

App Service

API Version:

2024-04-01

Description for Creates or updates a domain.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
domainName	path	True	string pattern: [a-zA-Z0-9][a-zA-Z0-9\.-]+	Name of the domain.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Name of the resource group to which the resource belongs.
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Request Body

Name	Required	Type	Description
properties.consent	True	DomainPurchaseConsent	Legal agreement consent.
properties.contactAdmin	True	Contact	Administrative contact.
properties.contactBilling	True	Contact	Billing contact.
properties.contactRegistrant	True	Contact	Registrant contact.
properties.contactTech	True	Contact	Technical contact.
kind		string	Kind of resource.
properties.authCode		string
properties.autoRenew		boolean	true if the domain should be automatically renewed; otherwise, false.
properties.dnsType		DnsType	Current DNS type
properties.dnsZoneId		string	Azure DNS Zone to use
properties.privacy		boolean	true if domain privacy is enabled for this domain; otherwise, false.
properties.targetDnsType		DnsType	Target DNS type (would be used for migration)

Responses

Name	Type	Description
200 OK	Domain	Domain purchase was successful.
202 Accepted	Domain	Domain purchase is in progress.
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Update App Service Domain

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com?api-version=2024-04-01

{
  "properties": {
    "authCode": "exampleAuthCode",
    "privacy": false,
    "autoRenew": true,
    "dnsType": "DefaultDomainRegistrarDns",
    "consent": {
      "agreementKeys": [
        "agreementKey1"
      ],
      "agreedBy": "192.0.2.1",
      "agreedAt": "2021-09-10T19:30:53Z"
    },
    "contactTech": {
      "email": "tech@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Tech",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactBilling": {
      "email": "billing@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Billing",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactAdmin": {
      "email": "admin@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Admin",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactRegistrant": {
      "email": "registrant@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Registrant",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    }
  }
}

Java

import com.azure.resourcemanager.appservice.models.Address;
import com.azure.resourcemanager.appservice.models.Contact;
import com.azure.resourcemanager.appservice.models.DnsType;
import com.azure.resourcemanager.appservice.models.DomainPatchResource;
import com.azure.resourcemanager.appservice.models.DomainPurchaseConsent;
import java.time.OffsetDateTime;
import java.util.Arrays;

/**
 * Samples for Domains Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomain
     * .json
     */
    /**
     * Sample code: Update App Service Domain.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAppServiceDomain(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getDomains().updateWithResponse("testrg123", "example.com",
            new DomainPatchResource()
                .withContactAdmin(new Contact()
                    .withAddressMailing(new Address().withAddress1("3400 State St").withCity("Chicago")
                        .withCountry("United States").withPostalCode("fakeTokenPlaceholder").withState("IL"))
                    .withEmail("admin@email.com").withFax("1-245-534-2242").withJobTitle("Admin").withNameFirst("John")
                    .withNameLast("Doe").withNameMiddle("").withOrganization("Microsoft Inc.")
                    .withPhone("1-245-534-2242"))
                .withContactBilling(new Contact()
                    .withAddressMailing(new Address().withAddress1("3400 State St").withCity("Chicago")
                        .withCountry("United States").withPostalCode("fakeTokenPlaceholder").withState("IL"))
                    .withEmail("billing@email.com").withFax("1-245-534-2242").withJobTitle("Billing")
                    .withNameFirst("John").withNameLast("Doe").withNameMiddle("").withOrganization("Microsoft Inc.")
                    .withPhone("1-245-534-2242"))
                .withContactRegistrant(new Contact()
                    .withAddressMailing(new Address().withAddress1("3400 State St").withCity("Chicago")
                        .withCountry("United States").withPostalCode("fakeTokenPlaceholder").withState("IL"))
                    .withEmail("registrant@email.com").withFax("1-245-534-2242").withJobTitle("Registrant")
                    .withNameFirst("John").withNameLast("Doe").withNameMiddle("").withOrganization("Microsoft Inc.")
                    .withPhone("1-245-534-2242"))
                .withContactTech(new Contact()
                    .withAddressMailing(new Address().withAddress1("3400 State St").withCity("Chicago")
                        .withCountry("United States").withPostalCode("fakeTokenPlaceholder").withState("IL"))
                    .withEmail("tech@email.com").withFax("1-245-534-2242").withJobTitle("Tech").withNameFirst("John")
                    .withNameLast("Doe").withNameMiddle("").withOrganization("Microsoft Inc.")
                    .withPhone("1-245-534-2242"))
                .withPrivacy(false).withAutoRenew(true)
                .withConsent(new DomainPurchaseConsent().withAgreementKeys(Arrays.asList("agreementKey1"))
                    .withAgreedBy("192.0.2.1").withAgreedAt(OffsetDateTime.parse("2021-09-10T19:30:53Z")))
                .withDnsType(DnsType.DEFAULT_DOMAIN_REGISTRAR_DNS).withAuthCode("fakeTokenPlaceholder"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python update_app_service_domain.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.domains.update(
        resource_group_name="testrg123",
        domain_name="example.com",
        domain={
            "properties": {
                "authCode": "exampleAuthCode",
                "autoRenew": True,
                "consent": {
                    "agreedAt": "2021-09-10T19:30:53Z",
                    "agreedBy": "192.0.2.1",
                    "agreementKeys": ["agreementKey1"],
                },
                "contactAdmin": {
                    "addressMailing": {
                        "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": {
                    "addressMailing": {
                        "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": {
                    "addressMailing": {
                        "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": {
                    "addressMailing": {
                        "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": "DefaultDomainRegistrarDns",
                "privacy": False,
            }
        },
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomain.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomain.json
func ExampleDomainsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDomainsClient().Update(ctx, "testrg123", "example.com", armappservice.DomainPatchResource{
		Properties: &armappservice.DomainPatchResourceProperties{
			AuthCode:  to.Ptr("exampleAuthCode"),
			AutoRenew: to.Ptr(true),
			Consent: &armappservice.DomainPurchaseConsent{
				AgreedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-09-10T19:30:53.000Z"); return t }()),
				AgreedBy: to.Ptr("192.0.2.1"),
				AgreementKeys: []*string{
					to.Ptr("agreementKey1")},
			},
			ContactAdmin: &armappservice.Contact{
				AddressMailing: &armappservice.Address{
					Address1:   to.Ptr("3400 State St"),
					City:       to.Ptr("Chicago"),
					Country:    to.Ptr("United States"),
					PostalCode: to.Ptr("67098"),
					State:      to.Ptr("IL"),
				},
				Email:        to.Ptr("admin@email.com"),
				Fax:          to.Ptr("1-245-534-2242"),
				JobTitle:     to.Ptr("Admin"),
				NameFirst:    to.Ptr("John"),
				NameLast:     to.Ptr("Doe"),
				NameMiddle:   to.Ptr(""),
				Organization: to.Ptr("Microsoft Inc."),
				Phone:        to.Ptr("1-245-534-2242"),
			},
			ContactBilling: &armappservice.Contact{
				AddressMailing: &armappservice.Address{
					Address1:   to.Ptr("3400 State St"),
					City:       to.Ptr("Chicago"),
					Country:    to.Ptr("United States"),
					PostalCode: to.Ptr("67098"),
					State:      to.Ptr("IL"),
				},
				Email:        to.Ptr("billing@email.com"),
				Fax:          to.Ptr("1-245-534-2242"),
				JobTitle:     to.Ptr("Billing"),
				NameFirst:    to.Ptr("John"),
				NameLast:     to.Ptr("Doe"),
				NameMiddle:   to.Ptr(""),
				Organization: to.Ptr("Microsoft Inc."),
				Phone:        to.Ptr("1-245-534-2242"),
			},
			ContactRegistrant: &armappservice.Contact{
				AddressMailing: &armappservice.Address{
					Address1:   to.Ptr("3400 State St"),
					City:       to.Ptr("Chicago"),
					Country:    to.Ptr("United States"),
					PostalCode: to.Ptr("67098"),
					State:      to.Ptr("IL"),
				},
				Email:        to.Ptr("registrant@email.com"),
				Fax:          to.Ptr("1-245-534-2242"),
				JobTitle:     to.Ptr("Registrant"),
				NameFirst:    to.Ptr("John"),
				NameLast:     to.Ptr("Doe"),
				NameMiddle:   to.Ptr(""),
				Organization: to.Ptr("Microsoft Inc."),
				Phone:        to.Ptr("1-245-534-2242"),
			},
			ContactTech: &armappservice.Contact{
				AddressMailing: &armappservice.Address{
					Address1:   to.Ptr("3400 State St"),
					City:       to.Ptr("Chicago"),
					Country:    to.Ptr("United States"),
					PostalCode: to.Ptr("67098"),
					State:      to.Ptr("IL"),
				},
				Email:        to.Ptr("tech@email.com"),
				Fax:          to.Ptr("1-245-534-2242"),
				JobTitle:     to.Ptr("Tech"),
				NameFirst:    to.Ptr("John"),
				NameLast:     to.Ptr("Doe"),
				NameMiddle:   to.Ptr(""),
				Organization: to.Ptr("Microsoft Inc."),
				Phone:        to.Ptr("1-245-534-2242"),
			},
			DNSType: to.Ptr(armappservice.DNSTypeDefaultDomainRegistrarDNS),
			Privacy: to.Ptr(false),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Domain = armappservice.Domain{
	// 	Name: to.Ptr("example.com"),
	// 	Type: to.Ptr("Microsoft.DomainRegistration/domains"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com"),
	// 	Location: to.Ptr("global"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armappservice.DomainProperties{
	// 		AuthCode: to.Ptr("exampleAuthCode"),
	// 		AutoRenew: to.Ptr(true),
	// 		Consent: &armappservice.DomainPurchaseConsent{
	// 			AgreedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-09-10T19:30:53.000Z"); return t}()),
	// 			AgreedBy: to.Ptr("192.0.2.1"),
	// 			AgreementKeys: []*string{
	// 				to.Ptr("agreementKey1")},
	// 			},
	// 			ContactAdmin: &armappservice.Contact{
	// 				AddressMailing: &armappservice.Address{
	// 					Address1: to.Ptr("3400 State St"),
	// 					City: to.Ptr("Chicago"),
	// 					Country: to.Ptr("United States"),
	// 					PostalCode: to.Ptr("67098"),
	// 					State: to.Ptr("IL"),
	// 				},
	// 				Email: to.Ptr("admin@email.com"),
	// 				Fax: to.Ptr("1-245-534-2242"),
	// 				JobTitle: to.Ptr("Admin"),
	// 				NameFirst: to.Ptr("John"),
	// 				NameLast: to.Ptr("Doe"),
	// 				NameMiddle: to.Ptr(""),
	// 				Organization: to.Ptr("Microsoft Inc."),
	// 				Phone: to.Ptr("1-245-534-2242"),
	// 			},
	// 			ContactBilling: &armappservice.Contact{
	// 				AddressMailing: &armappservice.Address{
	// 					Address1: to.Ptr("3400 State St"),
	// 					City: to.Ptr("Chicago"),
	// 					Country: to.Ptr("United States"),
	// 					PostalCode: to.Ptr("67098"),
	// 					State: to.Ptr("IL"),
	// 				},
	// 				Email: to.Ptr("billing@email.com"),
	// 				Fax: to.Ptr("1-245-534-2242"),
	// 				JobTitle: to.Ptr("Billing"),
	// 				NameFirst: to.Ptr("John"),
	// 				NameLast: to.Ptr("Doe"),
	// 				NameMiddle: to.Ptr(""),
	// 				Organization: to.Ptr("Microsoft Inc."),
	// 				Phone: to.Ptr("1-245-534-2242"),
	// 			},
	// 			ContactRegistrant: &armappservice.Contact{
	// 				AddressMailing: &armappservice.Address{
	// 					Address1: to.Ptr("3400 State St"),
	// 					City: to.Ptr("Chicago"),
	// 					Country: to.Ptr("United States"),
	// 					PostalCode: to.Ptr("67098"),
	// 					State: to.Ptr("IL"),
	// 				},
	// 				Email: to.Ptr("registrant@email.com"),
	// 				Fax: to.Ptr("1-245-534-2242"),
	// 				JobTitle: to.Ptr("Registrant"),
	// 				NameFirst: to.Ptr("John"),
	// 				NameLast: to.Ptr("Doe"),
	// 				NameMiddle: to.Ptr(""),
	// 				Organization: to.Ptr("Microsoft Inc."),
	// 				Phone: to.Ptr("1-245-534-2242"),
	// 			},
	// 			ContactTech: &armappservice.Contact{
	// 				AddressMailing: &armappservice.Address{
	// 					Address1: to.Ptr("3400 State St"),
	// 					City: to.Ptr("Chicago"),
	// 					Country: to.Ptr("United States"),
	// 					PostalCode: to.Ptr("67098"),
	// 					State: to.Ptr("IL"),
	// 				},
	// 				Email: to.Ptr("tech@email.com"),
	// 				Fax: to.Ptr("1-245-534-2242"),
	// 				JobTitle: to.Ptr("Tech"),
	// 				NameFirst: to.Ptr("John"),
	// 				NameLast: to.Ptr("Doe"),
	// 				NameMiddle: to.Ptr(""),
	// 				Organization: to.Ptr("Microsoft Inc."),
	// 				Phone: to.Ptr("1-245-534-2242"),
	// 			},
	// 			CreatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-09-10T19:30:53.000Z"); return t}()),
	// 			DNSType: to.Ptr(armappservice.DNSTypeDefaultDomainRegistrarDNS),
	// 			DomainNotRenewableReasons: []*armappservice.ResourceNotRenewableReason{
	// 				to.Ptr(armappservice.ResourceNotRenewableReasonExpirationNotInRenewalTimeRange)},
	// 				ExpirationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-10T19:30:53.000Z"); return t}()),
	// 				ManagedHostNames: []*armappservice.HostName{
	// 				},
	// 				NameServers: []*string{
	// 					to.Ptr("ns01.ote.domaincontrol.com"),
	// 					to.Ptr("ns02.ote.domaincontrol.com")},
	// 					Privacy: to.Ptr(false),
	// 					ProvisioningState: to.Ptr(armappservice.ProvisioningStateSucceeded),
	// 					ReadyForDNSRecordManagement: to.Ptr(true),
	// 					RegistrationStatus: to.Ptr(armappservice.DomainStatusActive),
	// 				},
	// 			}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Creates or updates a domain.
 *
 * @summary Description for Creates or updates a domain.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomain.json
 */
async function updateAppServiceDomain() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const domainName = "example.com";
  const domain = {
    authCode: "exampleAuthCode",
    autoRenew: true,
    consent: {
      agreedAt: new Date("2021-09-10T19:30:53Z"),
      agreedBy: "192.0.2.1",
      agreementKeys: ["agreementKey1"],
    },
    contactAdmin: {
      addressMailing: {
        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: {
      addressMailing: {
        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: {
      addressMailing: {
        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: {
      addressMailing: {
        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: "DefaultDomainRegistrarDns",
    privacy: false,
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.domains.update(resourceGroupName, domainName, domain);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-04-01/examples/UpdateAppServiceDomain.json
// this example is just showing the usage of "Domains_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AppServiceDomainResource created on azure
// for more information of creating AppServiceDomainResource, please refer to the document of AppServiceDomainResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string domainName = "example.com";
ResourceIdentifier appServiceDomainResourceId = AppServiceDomainResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, domainName);
AppServiceDomainResource appServiceDomain = client.GetAppServiceDomainResource(appServiceDomainResourceId);

// invoke the operation
AppServiceDomainPatch patch = new AppServiceDomainPatch()
{
    ContactAdmin = new RegistrationContactInfo("admin@email.com", "John", "Doe", "1-245-534-2242")
    {
        AddressMailing = new RegistrationAddressInfo("3400 State St", "Chicago", "United States", "67098", "IL"),
        Fax = "1-245-534-2242",
        JobTitle = "Admin",
        NameMiddle = "",
        Organization = "Microsoft Inc.",
    },
    ContactBilling = new RegistrationContactInfo("billing@email.com", "John", "Doe", "1-245-534-2242")
    {
        AddressMailing = new RegistrationAddressInfo("3400 State St", "Chicago", "United States", "67098", "IL"),
        Fax = "1-245-534-2242",
        JobTitle = "Billing",
        NameMiddle = "",
        Organization = "Microsoft Inc.",
    },
    ContactRegistrant = new RegistrationContactInfo("registrant@email.com", "John", "Doe", "1-245-534-2242")
    {
        AddressMailing = new RegistrationAddressInfo("3400 State St", "Chicago", "United States", "67098", "IL"),
        Fax = "1-245-534-2242",
        JobTitle = "Registrant",
        NameMiddle = "",
        Organization = "Microsoft Inc.",
    },
    ContactTech = new RegistrationContactInfo("tech@email.com", "John", "Doe", "1-245-534-2242")
    {
        AddressMailing = new RegistrationAddressInfo("3400 State St", "Chicago", "United States", "67098", "IL"),
        Fax = "1-245-534-2242",
        JobTitle = "Tech",
        NameMiddle = "",
        Organization = "Microsoft Inc.",
    },
    IsDomainPrivacyEnabled = false,
    IsAutoRenew = true,
    Consent = new DomainPurchaseConsent()
    {
        AgreementKeys =
        {
        "agreementKey1"
        },
        AgreedBy = "192.0.2.1",
        AgreedOn = DateTimeOffset.Parse("2021-09-10T19:30:53Z"),
    },
    DnsType = AppServiceDnsType.DefaultDomainRegistrarDns,
    AuthCode = "exampleAuthCode",
};
AppServiceDomainResource result = await appServiceDomain.UpdateAsync(patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AppServiceDomainData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com",
  "name": "example.com",
  "type": "Microsoft.DomainRegistration/domains",
  "location": "global",
  "tags": {},
  "properties": {
    "authCode": "exampleAuthCode",
    "registrationStatus": "Active",
    "provisioningState": "Succeeded",
    "nameServers": [
      "ns01.ote.domaincontrol.com",
      "ns02.ote.domaincontrol.com"
    ],
    "privacy": false,
    "createdTime": "2021-09-10T19:30:53Z",
    "expirationTime": "2022-09-10T19:30:53Z",
    "autoRenew": true,
    "readyForDnsRecordManagement": true,
    "managedHostNames": [],
    "domainNotRenewableReasons": [
      "ExpirationNotInRenewalTimeRange"
    ],
    "dnsType": "DefaultDomainRegistrarDns",
    "consent": {
      "agreementKeys": [
        "agreementKey1"
      ],
      "agreedBy": "192.0.2.1",
      "agreedAt": "2021-09-10T19:30:53Z"
    },
    "contactTech": {
      "email": "tech@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Tech",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactBilling": {
      "email": "billing@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Billing",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactAdmin": {
      "email": "admin@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Admin",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactRegistrant": {
      "email": "registrant@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Registrant",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    }
  }
}

Status code:

202

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com",
  "name": "example.com",
  "type": "Microsoft.DomainRegistration/domains",
  "location": "global",
  "tags": {},
  "properties": {
    "authCode": "exampleAuthCode",
    "registrationStatus": "Active",
    "provisioningState": "Succeeded",
    "nameServers": [
      "ns01.ote.domaincontrol.com",
      "ns02.ote.domaincontrol.com"
    ],
    "privacy": false,
    "createdTime": "2021-09-10T19:30:53Z",
    "expirationTime": "2022-09-10T19:30:53Z",
    "autoRenew": true,
    "readyForDnsRecordManagement": true,
    "managedHostNames": [],
    "domainNotRenewableReasons": [
      "ExpirationNotInRenewalTimeRange"
    ],
    "dnsType": "DefaultDomainRegistrarDns",
    "consent": {
      "agreementKeys": [
        "agreementKey1"
      ],
      "agreedBy": "192.0.2.1",
      "agreedAt": "2021-09-10T19:30:53Z"
    },
    "contactTech": {
      "email": "tech@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Tech",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactBilling": {
      "email": "billing@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Billing",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactAdmin": {
      "email": "admin@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Admin",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactRegistrant": {
      "email": "registrant@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Registrant",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    }
  }
}

Definitions

Name	Description
Address	Address information for domain registration.
AzureResourceType	Type of the Azure resource the hostname is assigned to.
Contact	Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois directories as per ICANN requirements.
CustomHostNameDnsRecordType	Type of the DNS record.
DefaultErrorResponse	App Service error response.
Details
DnsType	Current DNS type
Domain	Information about a domain.
DomainPatchResource	ARM resource for a domain.
DomainPurchaseConsent	Domain purchase consent object, representing acceptance of applicable legal agreements.
DomainStatus	Domain registration status.
Error	Error model.
HostName	Details of a hostname derived from a domain.
HostNameType	Type of the hostname.
ProvisioningState	Domain provisioning state.
ResourceNotRenewableReason	Reasons why domain is not renewable.

Address

Object

Address information for domain registration.

Name	Type	Description
address1	string	First line of an Address.
address2	string	The second line of the Address. Optional.
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.

AzureResourceType

Enumeration

Type of the Azure resource the hostname is assigned to.

Value	Description
Website
TrafficManager

Contact

Object

Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois directories as per ICANN requirements.

Name	Type	Description
addressMailing	Address	Mailing address.
email	string	Email address.
fax	string	Fax number.
jobTitle	string	Job title.
nameFirst	string	First name.
nameLast	string	Last name.
nameMiddle	string	Middle name.
organization	string	Organization contact belongs to.
phone	string	Phone number.

CustomHostNameDnsRecordType

Enumeration

Type of the DNS record.

Value	Description
CName
A

DefaultErrorResponse

Object

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Object

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

DnsType

Enumeration

Current DNS type

Value	Description
AzureDns
DefaultDomainRegistrarDns

Domain

Object

Information about a domain.

Name	Type	Default value	Description
id	string		Resource Id.
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.
location	string		Resource Location.
name	string		Resource Name.
properties.authCode	string
properties.autoRenew	boolean	True	true if the domain should be automatically renewed; otherwise, false.
properties.consent	DomainPurchaseConsent		Legal agreement consent.
properties.contactAdmin	Contact		Administrative contact.
properties.contactBilling	Contact		Billing contact.
properties.contactRegistrant	Contact		Registrant contact.
properties.contactTech	Contact		Technical contact.
properties.createdTime	string (date-time)		Domain creation timestamp.
properties.dnsType	DnsType		Current DNS type
properties.dnsZoneId	string		Azure DNS Zone to use
properties.domainNotRenewableReasons	ResourceNotRenewableReason[]		Reasons why domain is not renewable.
properties.expirationTime	string (date-time)		Domain expiration timestamp.
properties.lastRenewedTime	string (date-time)		Timestamp when the domain was renewed last time.
properties.managedHostNames	HostName[]		All hostnames derived from the domain and assigned to Azure resources.
properties.nameServers	string[]		Name servers.
properties.privacy	boolean		true if domain privacy is enabled for this domain; otherwise, false.
properties.provisioningState	ProvisioningState		Domain provisioning state.
properties.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.
properties.registrationStatus	DomainStatus		Domain registration status.
properties.targetDnsType	DnsType		Target DNS type (would be used for migration)
tags	object		Resource tags.
type	string		Resource type.

DomainPatchResource

Object

ARM resource for a domain.

Name	Type	Default value	Description
id	string		Resource Id.
kind	string		Kind of resource.
name	string		Resource Name.
properties.authCode	string
properties.autoRenew	boolean	True	true if the domain should be automatically renewed; otherwise, false.
properties.consent	DomainPurchaseConsent		Legal agreement consent.
properties.contactAdmin	Contact		Administrative contact.
properties.contactBilling	Contact		Billing contact.
properties.contactRegistrant	Contact		Registrant contact.
properties.contactTech	Contact		Technical contact.
properties.createdTime	string (date-time)		Domain creation timestamp.
properties.dnsType	DnsType		Current DNS type
properties.dnsZoneId	string		Azure DNS Zone to use
properties.domainNotRenewableReasons	ResourceNotRenewableReason[]		Reasons why domain is not renewable.
properties.expirationTime	string (date-time)		Domain expiration timestamp.
properties.lastRenewedTime	string (date-time)		Timestamp when the domain was renewed last time.
properties.managedHostNames	HostName[]		All hostnames derived from the domain and assigned to Azure resources.
properties.nameServers	string[]		Name servers.
properties.privacy	boolean		true if domain privacy is enabled for this domain; otherwise, false.
properties.provisioningState	ProvisioningState		Domain provisioning state.
properties.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.
properties.registrationStatus	DomainStatus		Domain registration status.
properties.targetDnsType	DnsType		Target DNS type (would be used for migration)
type	string		Resource type.

DomainPurchaseConsent

Object

Domain purchase consent object, representing acceptance of applicable legal agreements.

Name	Type	Description
agreedAt	string (date-time)	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.

DomainStatus

Enumeration

Domain registration status.

Value	Description
Active
Awaiting
Cancelled
Confiscated
Disabled
Excluded
Expired
Failed
Held
Locked
Parked
Pending
Reserved
Reverted
Suspended
Transferred
Unknown
Unlocked
Unparked
Updated
JsonConverterFailed

Error

Object

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

HostName

Object

Details of a hostname derived from a domain.

Name	Type	Description
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	AzureResourceType	Type of the Azure resource the hostname is assigned to.
customHostNameDnsRecordType	CustomHostNameDnsRecordType	Type of the DNS record.
hostNameType	HostNameType	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.

HostNameType

Enumeration

Type of the hostname.

Value	Description
Verified
Managed

ProvisioningState

Enumeration

Domain provisioning state.

Value	Description
Succeeded
Failed
Canceled
InProgress
Deleting

ResourceNotRenewableReason

Enumeration

Reasons why domain is not renewable.

Value	Description
RegistrationStatusNotSupportedForRenewal
ExpirationNotInRenewalTimeRange
SubscriptionNotActive