Endpoints - Validate Custom Domain

サービス:

CDN

API バージョン:

2025-04-15

カスタム ドメイン マッピングを検証して、DNS の正しい CDN エンドポイントにマップされていることを確認します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain?api-version=2025-04-15

URI パラメーター

名前	/	必須	型	説明
endpointName	path	True	string	グローバルに一意であるプロファイルの下のエンドポイントの名前。
profileName	path	True	string	リソース グループ内で一意である CDN プロファイルの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前は大文字と小文字が区別されます。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
hostName	True	string	カスタム ドメインのホスト名。 ドメイン名である必要があります。

応答

名前	型	説明
200 OK	ValidateCustomDomainOutput	わかりました。 要求は成功しました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する CDN エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

Endpoints_ValidateCustomDomain

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/validateCustomDomain?api-version=2025-04-15

{
  "hostName": "www.someDomain.com"
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2025-04-15/examples/Endpoints_ValidateCustomDomain.json
// this example is just showing the usage of "CdnEndpoints_ValidateCustomDomain" 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 CdnEndpointResource created on azure
// for more information of creating CdnEndpointResource, please refer to the document of CdnEndpointResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
string endpointName = "endpoint1";
ResourceIdentifier cdnEndpointResourceId = CdnEndpointResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, endpointName);
CdnEndpointResource cdnEndpoint = client.GetCdnEndpointResource(cdnEndpointResourceId);

// invoke the operation
ValidateCustomDomainContent content = new ValidateCustomDomainContent("www.someDomain.com");
ValidateCustomDomainResult result = await cdnEndpoint.ValidateCustomDomainAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

応答のサンプル

状態コード:

200

{
  "customDomainValidated": true,
  "message": null,
  "reason": null
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ValidateCustomDomainInput	DNS マッピング用に検証するカスタム ドメインの入力。
ValidateCustomDomainOutput	カスタム ドメイン検証の出力。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

ValidateCustomDomainInput

Object

DNS マッピング用に検証するカスタム ドメインの入力。

名前	型	説明
hostName	string	カスタム ドメインのホスト名。 ドメイン名である必要があります。

ValidateCustomDomainOutput

Object

カスタム ドメイン検証の出力。

名前	型	説明
customDomainValidated	boolean	カスタム ドメインが有効かどうかを示します。
message	string	カスタム ドメインが無効な理由を説明するエラー メッセージ。
reason	string	カスタム ドメインが無効な理由。