Domains - List

リファレンス

サービス:: App Service

API バージョン:: 2023-12-01

サブスクリプション内のすべてのドメインを取得する方法の説明。

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

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Azure サブスクリプション ID。これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-000000000000)。
api-version	query	True	string	API バージョン

応答

名前	型	説明
200 OK	DomainCollection	わかりました
Other Status Codes	DefaultErrorResponse	App Service エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

List domains by subscription

要求のサンプル

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


/**
 * Samples for Domains List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-12-01/examples/
     * ListDomainsBySubscription.json
     */
    /**
     * Sample code: List domains by subscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listDomainsBySubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getDomains().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_domains_by_subscription.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()
    for item in response:
        print(item)


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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/21c2852d62ccc3abe9cc3800c989c6826f8363dc/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-12-01/examples/ListDomainsBySubscription.json
func ExampleDomainsClient_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.NewDomainsClient().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.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

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

/**
 * This sample demonstrates how to Description for Get all domains in a subscription.
 *
 * @summary Description for Get all domains in a subscription.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-12-01/examples/ListDomainsBySubscription.json
 */
async function listDomainsBySubscription() {
  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.domains.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

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/2023-12-01/examples/ListDomainsBySubscription.json
// this example is just showing the usage of "Domains_List" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (AppServiceDomainResource item in subscriptionResource.GetAppServiceDomainsAsync())
{
    // 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	ドメイン登録の連絡先情報。 [ドメインプライバシー] オプションが選択されていない場合、連絡先情報は ICANN 要件に従って Whois ディレクトリを通じて一般公開されます。
CustomHostNameDnsRecordType	DNS レコードの種類。
DefaultErrorResponse	App Service エラー応答。
Details
DnsType	現在の DNS の種類
Domain	ドメインに関する情報。
DomainCollection	ドメインのコレクション。
DomainPurchaseConsent	該当する法的契約への同意を表すドメイン購入の同意オブジェクト。
DomainStatus	ドメイン登録の状態。
Error	エラーモデル。
HostName	ドメインから派生したホスト名の詳細。
HostNameType	ホスト名の種類。
ProvisioningState	ドメインプロビジョニングの状態。
ResourceNotRenewableReason	ドメインが更新できない理由。

Address

Object

ドメイン登録のアドレス情報。

名前	型	説明
address1	string	アドレスの最初の行。
address2	string	アドレスの 2 行目。随意。
city	string	住所の市区町村。
country	string	住所の国。
postalCode	string	住所の郵便番号。
state	string	住所の都道府県。

AzureResourceType

列挙

ホスト名が割り当てられている Azure リソースの種類。

値	説明
TrafficManager
Website

Contact

Object

ドメイン登録の連絡先情報。 [ドメインプライバシー] オプションが選択されていない場合、連絡先情報は ICANN 要件に従って Whois ディレクトリを通じて一般公開されます。

名前	型	説明
addressMailing	Address	住所。
email	string	アドレス。
fax	string	FAX 番号。
jobTitle	string	役職。
nameFirst	string	名前。
nameLast	string	名字。
nameMiddle	string	ミドルネーム。
organization	string	組織の連絡先が属しています。
phone	string	電話番号。

CustomHostNameDnsRecordType

列挙

DNS レコードの種類。

値	説明
A
CName

DefaultErrorResponse

Object

App Service エラー応答。

名前	型	説明
error	Error	エラーモデル。

Details

Object

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

DnsType

列挙

現在の DNS の種類

値	説明
AzureDns
DefaultDomainRegistrarDns

Domain

Object

ドメインに関する情報。

名前	型	規定値	説明
id	string		リソース ID。
kind	string		リソースの種類。
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		Azure がこのドメインを App Service アプリに割り当てることができるかどうかを `true` します。それ以外の場合は、`false`します。この値は、ドメイン登録の状態がアクティブで、Azure がプログラムでアクセスできるネームサーバーでホストされている場合に `true` されます。
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[]	適用される法的契約キーの一覧。このリストは、リソースの下の ListLegalAgreements API `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 リソースの名前。 Traffic Manager に割り当てられている場合は、Traffic Manager 名になります。それ以外の場合はアプリ名になります。
azureResourceType	AzureResourceType	ホスト名が割り当てられている Azure リソースの種類。
customHostNameDnsRecordType	CustomHostNameDnsRecordType	DNS レコードの種類。
hostNameType	HostNameType	ホスト名の種類。
name	string	ホスト名の名前。
siteNames	string[]	ホスト名が割り当てられているアプリの一覧。この一覧には、ホスト名が Traffic Manager を指している場合にのみ、複数のアプリが含まれます。

HostNameType

列挙

ホスト名の種類。

値	説明
Managed
Verified

ProvisioningState

列挙

ドメインプロビジョニングの状態。

値	説明
Canceled
Deleting
Failed
InProgress
Succeeded

ResourceNotRenewableReason

列挙

ドメインが更新できない理由。

値	説明
ExpirationNotInRenewalTimeRange
RegistrationStatusNotSupportedForRenewal
SubscriptionNotActive