Domains - List By Resource Group

Служба:

App Service

Версия API:

2024-11-01

Описание получения всех доменов в группе ресурсов.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Имя группы ресурсов, к которой принадлежит ресурс.
subscriptionId	path	True	string	Идентификатор вашей подписки Azure. Это строка с форматом GUID (например, 0000000000-0000-0000-0000-00000000000000000000000000000).
api-version	query	True	string	Версия API

Ответы

Имя	Тип	Описание
200 OK	DomainCollection	ХОРОШО
Other Status Codes	DefaultErrorResponse	Ответ об ошибке службы приложений.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List domains by resource group

Образец запроса

HTTP

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

Java

/**
 * Samples for Domains ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/
     * ListDomainsByResourceGroup.json
     */
    /**
     * Sample code: List domains by resource group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listDomainsByResourceGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getDomains().listByResourceGroup("testrg123",
            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 list_domains_by_resource_group.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.list_by_resource_group(
        resource_group_name="testrg123",
    )
    for item in response:
        print(item)


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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/ListDomainsByResourceGroup.json
func ExampleDomainsClient_NewListByResourceGroupPager() {
	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.NewDomainsClient().NewListByResourceGroupPager("testrg123", 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.DomainCollection = armappservice.DomainCollection{
		// 	Value: []*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 Get all domains in a resource group.
 *
 * @summary Description for Get all domains in a resource group.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/ListDomainsByResourceGroup.json
 */
async function listDomainsByResourceGroup() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.domains.listByResourceGroup(resourceGroupName)) {
    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

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-11-01/examples/ListDomainsByResourceGroup.json
// this example is just showing the usage of "Domains_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this AppServiceDomainResource
AppServiceDomainCollection collection = resourceGroupResource.GetAppServiceDomains();

// invoke the operation and iterate over the result
await foreach (AppServiceDomainResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Пример ответа

Код состояния:

200

{
  "value": [
    {
      "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"
          }
        }
      }
    }
  ]
}

Определения

Имя	Описание
Address	Сведения об адресе регистрации домена.
AzureResourceType	Тип ресурса Azure, которому назначено имя узла.
Contact	Контактные данные для регистрации домена. Если параметр "Конфиденциальность домена" не выбран, контактные данные предоставляются в общедоступных каталогах Whois в соответствии с требованиями к СИСТЕМЕ УПРАВЛЕНИЯ.
CustomHostNameDnsRecordType	Тип записи DNS.
DefaultErrorResponse	Ответ об ошибке службы приложений.
Details
DnsType	Текущий тип DNS
Domain	Сведения о домене.
DomainCollection	Коллекция доменов.
DomainPurchaseConsent	Объект согласия на покупку домена, представляющий принятие применимых юридических соглашений.
DomainStatus	Состояние регистрации домена.
Error	Модель ошибок.
HostName	Сведения об имени узла, производном от домена.
HostNameType	Тип имени узла.
ProvisioningState	Состояние подготовки домена.
ResourceNotRenewableReason	Причины, по которым домен не является возобновляемым.

Address

Object

Сведения об адресе регистрации домена.

Имя	Тип	Описание
address1	string	Первая строка адреса.
address2	string	Вторая строка адреса. Необязательно.
city	string	Город для адреса.
country	string	Страна для адреса.
postalCode	string	Почтовый индекс адреса.
state	string	Штат или провинция для адреса.

AzureResourceType

Перечисление

Тип ресурса Azure, которому назначено имя узла.

Значение	Описание
TrafficManager
Website

Contact

Object

Контактные данные для регистрации домена. Если параметр "Конфиденциальность домена" не выбран, контактные данные предоставляются в общедоступных каталогах Whois в соответствии с требованиями к СИСТЕМЕ УПРАВЛЕНИЯ.

Имя	Тип	Описание
addressMailing	Address	Почтовый адрес.
email	string	Адрес электронной почты.
fax	string	Номер факса.
jobTitle	string	Название задания.
nameFirst	string	Имя.
nameLast	string	Фамилия.
nameMiddle	string	По промежуточному имени.
organization	string	Контакт организации принадлежит.
phone	string	Номер телефона.

CustomHostNameDnsRecordType

Перечисление

Тип записи DNS.

Значение	Описание
A
CName

DefaultErrorResponse

Object

Ответ об ошибке службы приложений.

Имя	Тип	Описание
error	Error	Модель ошибок.

Details

Object

Имя	Тип	Описание
code	string	Стандартизованная строка для программной идентификации ошибки.
message	string	Подробные сведения об ошибке и сведения об отладке.
target	string	Подробные сведения об ошибке и сведения об отладке.

DnsType

Перечисление

Текущий тип DNS

Значение	Описание
AzureDns
DefaultDomainRegistrarDns

Domain

Object

Сведения о домене.

Имя	Тип	Default value	Описание
id	string		Идентификатор ресурса.
kind	string		Тип ресурса. Если ресурс является приложением, можно обратиться к https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference подробные поддерживаемые значения для типа.
location	string		Расположение ресурса.
name	string		Имя ресурса.
properties.authCode	string
properties.autoRenew	boolean	True	true, если домен должен быть автоматически продлен; в противном случае false.
properties.consent	DomainPurchaseConsent		Согласие на юридическое соглашение.
properties.contactAdmin	Contact		Административный контакт.
properties.contactBilling	Contact		Контакт с выставлением счетов.
properties.contactRegistrant	Contact		Контакт с реестром.
properties.contactTech	Contact		Контакт для связи по техническим вопросам.
properties.createdTime	string (date-time)		Метка времени создания домена.
properties.dnsType	DnsType		Текущий тип DNS
properties.dnsZoneId	string		Зона Azure DNS для использования
properties.domainNotRenewableReasons	ResourceNotRenewableReason[]		Причины, по которым домен не является возобновляемым.
properties.expirationTime	string (date-time)		Метка времени окончания срока действия домена.
properties.lastRenewedTime	string (date-time)		Метка времени последнего обновления домена.
properties.managedHostNames	HostName[]		Все имена узлов, производные от домена и назначенные ресурсам Azure.
properties.nameServers	string[]		Серверы имен.
properties.privacy	boolean		true, если для этого домена включена конфиденциальность домена; в противном случае false.
properties.provisioningState	ProvisioningState		Состояние подготовки домена.
properties.readyForDnsRecordManagement	boolean		true, если Azure может назначить этот домен приложениям службы приложений; в противном случае false. Это значение будет true, если состояние регистрации домена активно и размещено на серверах имен Azure с программным доступом.
properties.registrationStatus	DomainStatus		Состояние регистрации домена.
properties.targetDnsType	DnsType		Целевой тип DNS (будет использоваться для миграции)
tags	object		Теги ресурсов.
type	string		Тип ресурса.

DomainCollection

Object

Коллекция доменов.

Имя	Тип	Описание
nextLink	string	Ссылка на следующую страницу ресурсов.
value	Domain[]	Коллекция ресурсов.

DomainPurchaseConsent

Object

Объект согласия на покупку домена, представляющий принятие применимых юридических соглашений.

Имя	Тип	Описание
agreedAt	string (date-time)	Метка времени при принятии соглашений.
agreedBy	string	IP-адрес клиента.
agreementKeys	string[]	Список применимых ключей юридического соглашения. Этот список можно получить с помощью API ListLegalAgreements в TopLevelDomain ресурсе.

DomainStatus

Перечисление

Состояние регистрации домена.

Значение	Описание
Active
Awaiting
Cancelled
Confiscated
Disabled
Excluded
Expired
Failed
Held
JsonConverterFailed
Locked
Parked
Pending
Reserved
Reverted
Suspended
Transferred
Unknown
Unlocked
Unparked
Updated

Error

Object

Модель ошибок.

Имя	Тип	Описание
code	string	Стандартизованная строка для программной идентификации ошибки.
details	Details[]	Подробные ошибки.
innererror	string	Дополнительные сведения об ошибке отладки.
message	string	Подробные сведения об ошибке и сведения об отладке.
target	string	Подробные сведения об ошибке и сведения об отладке.

HostName

Object

Сведения об имени узла, производном от домена.

Имя	Тип	Описание
azureResourceName	string	Имя ресурса Azure, которому назначено имя узла. Если оно назначено диспетчеру трафика, оно будет именем диспетчера трафика в противном случае оно будет именем приложения.
azureResourceType	AzureResourceType	Тип ресурса Azure, которому назначено имя узла.
customHostNameDnsRecordType	CustomHostNameDnsRecordType	Тип записи DNS.
hostNameType	HostNameType	Тип имени узла.
name	string	Имя имени узла.
siteNames	string[]	Список приложений, которым назначено имя узла. В этом списке будет несколько приложений, только если имя узла указывает на диспетчер трафика.

HostNameType

Перечисление

Тип имени узла.

Значение	Описание
Managed
Verified

ProvisioningState

Перечисление

Состояние подготовки домена.

Значение	Описание
Canceled
Deleting
Failed
InProgress
Succeeded

ResourceNotRenewableReason

Перечисление

Причины, по которым домен не является возобновляемым.

Значение	Описание
ExpirationNotInRenewalTimeRange
RegistrationStatusNotSupportedForRenewal
SubscriptionNotActive