Top Level Domains - List

Reference

Service:: App Service

API Version:: 2024-04-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains?api-version=2024-04-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

HTTP

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

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.

Share via