Top Level Domains - List

Reference

Service:: App Service

API Version:: 2023-01-01

Description for Get all top-level domains supported for registration.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains?api-version=2023-01-01

URI Parameters

Name	In	Required	Type	Description
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

Responses

Name	Type	Description
200 OK	TopLevelDomainCollection	OK
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

List Top Level Domains

Sample Request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains?api-version=2023-01-01


/**
 * Samples for TopLevelDomains List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/examples/ListTopLevelDomains.
     * json
     */
    /**
     * Sample code: List Top Level Domains.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listTopLevelDomains(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getTopLevelDomains().list(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

from azure.identity import DefaultAzureCredential
from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_top_level_domains.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.top_level_domains.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/examples/ListTopLevelDomains.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

package armappservice_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/738ab25fe76324897f273645906d4a0415068a6c/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/examples/ListTopLevelDomains.json
func ExampleTopLevelDomainsClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewTopLevelDomainsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.TopLevelDomainCollection = armappservice.TopLevelDomainCollection{
		// 	Value: []*armappservice.TopLevelDomain{
		// 		{
		// 			Name: to.Ptr("com"),
		// 			Type: to.Ptr("Microsoft.DomainRegistration/topLevelDomains"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/com"),
		// 			Properties: &armappservice.TopLevelDomainProperties{
		// 				Privacy: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("net"),
		// 			Type: to.Ptr("Microsoft.DomainRegistration/topLevelDomains"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/net"),
		// 			Properties: &armappservice.TopLevelDomainProperties{
		// 				Privacy: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("co.uk"),
		// 			Type: to.Ptr("Microsoft.DomainRegistration/topLevelDomains"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/co.uk"),
		// 			Properties: &armappservice.TopLevelDomainProperties{
		// 				Privacy: to.Ptr(false),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("org"),
		// 			Type: to.Ptr("Microsoft.DomainRegistration/topLevelDomains"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/org"),
		// 			Properties: &armappservice.TopLevelDomainProperties{
		// 				Privacy: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("nl"),
		// 			Type: to.Ptr("Microsoft.DomainRegistration/topLevelDomains"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/nl"),
		// 			Properties: &armappservice.TopLevelDomainProperties{
		// 				Privacy: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("in"),
		// 			Type: to.Ptr("Microsoft.DomainRegistration/topLevelDomains"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/in"),
		// 			Properties: &armappservice.TopLevelDomainProperties{
		// 				Privacy: to.Ptr(false),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("biz"),
		// 			Type: to.Ptr("Microsoft.DomainRegistration/topLevelDomains"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/biz"),
		// 			Properties: &armappservice.TopLevelDomainProperties{
		// 				Privacy: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("org.uk"),
		// 			Type: to.Ptr("Microsoft.DomainRegistration/topLevelDomains"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/org.uk"),
		// 			Properties: &armappservice.TopLevelDomainProperties{
		// 				Privacy: to.Ptr(false),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("co.in"),
		// 			Type: to.Ptr("Microsoft.DomainRegistration/topLevelDomains"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/co.in"),
		// 			Properties: &armappservice.TopLevelDomainProperties{
		// 				Privacy: to.Ptr(false),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Description for Get all top-level domains supported for registration.
 *
 * @summary Description for Get all top-level domains supported for registration.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/examples/ListTopLevelDomains.json
 */
async function listTopLevelDomains() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.topLevelDomains.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/com",
      "name": "com",
      "type": "Microsoft.DomainRegistration/topLevelDomains",
      "properties": {
        "privacy": true
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/net",
      "name": "net",
      "type": "Microsoft.DomainRegistration/topLevelDomains",
      "properties": {
        "privacy": true
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/co.uk",
      "name": "co.uk",
      "type": "Microsoft.DomainRegistration/topLevelDomains",
      "properties": {
        "privacy": false
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/org",
      "name": "org",
      "type": "Microsoft.DomainRegistration/topLevelDomains",
      "properties": {
        "privacy": true
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/nl",
      "name": "nl",
      "type": "Microsoft.DomainRegistration/topLevelDomains",
      "properties": {
        "privacy": true
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/in",
      "name": "in",
      "type": "Microsoft.DomainRegistration/topLevelDomains",
      "properties": {
        "privacy": false
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/biz",
      "name": "biz",
      "type": "Microsoft.DomainRegistration/topLevelDomains",
      "properties": {
        "privacy": true
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/org.uk",
      "name": "org.uk",
      "type": "Microsoft.DomainRegistration/topLevelDomains",
      "properties": {
        "privacy": false
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/co.in",
      "name": "co.in",
      "type": "Microsoft.DomainRegistration/topLevelDomains",
      "properties": {
        "privacy": false
      }
    }
  ]
}

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
TopLevelDomain	A top level domain object.
TopLevelDomainCollection	Collection of Top-level domains.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

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.

Error

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.

TopLevelDomain

A top level domain object.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.privacy	boolean	If `true`, then the top level domain supports domain privacy; otherwise, `false`.
type	string	Resource type.

TopLevelDomainCollection

Collection of Top-level domains.

Name	Type	Description
nextLink	string	Link to next page of resources.
value	TopLevelDomain[]	Collection of resources.

Top Level Domains - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List Top Level Domains

Sample Request

Sample Response

Definitions

DefaultErrorResponse

Details

Error

TopLevelDomain

TopLevelDomainCollection

Additional resources