AFD Endpoints - Update

サービス:: Front Door Service

API バージョン:: 2025-04-15

既存の AzureFrontDoor エンドポイントを、指定したサブスクリプション、リソースグループ、およびプロファイルの下の指定されたエンドポイント名で更新します。エンドポイントの作成後に更新できるのはタグのみです。配信元を更新するには、配信元の更新操作を使用します。配信元グループを更新するには、配信元グループの更新操作を使用します。ドメインを更新するには、カスタムドメインの更新操作を使用します。

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

URI パラメーター

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

要求本文

名前	型	説明
properties.enabledState	EnabledState	この規則の使用を有効にするかどうかを指定します。許可される値は 'Enabled' または 'Disabled' です
tags	object	エンドポイントタグ。

応答

名前	型	説明
200 OK	AFDEndpoint	[OK]
202 Accepted	AFDEndpoint	承認された。要求は処理のために受け入れられ、操作は非同期的に完了します。ヘッダー location: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する Azure Front Door エラー応答

名前

型

説明

200 OK

AFDEndpoint

[OK]

202 Accepted

AFDEndpoint

承認された。要求は処理のために受け入れられ、操作は非同期的に完了します。

ヘッダー

location: string

Other Status Codes

ErrorResponse

操作が失敗した理由を説明する Azure Front Door エラー応答

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

AFDEndpoints_Update

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

{
  "tags": {},
  "properties": {
    "enabledState": "Enabled"
  }
}

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/AFDEndpoints_Update.json
// this example is just showing the usage of "FrontDoorEndpoints_Update" 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 FrontDoorEndpointResource created on azure
// for more information of creating FrontDoorEndpointResource, please refer to the document of FrontDoorEndpointResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
string endpointName = "endpoint1";
ResourceIdentifier frontDoorEndpointResourceId = FrontDoorEndpointResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, endpointName);
FrontDoorEndpointResource frontDoorEndpoint = client.GetFrontDoorEndpointResource(frontDoorEndpointResourceId);

// invoke the operation
FrontDoorEndpointPatch patch = new FrontDoorEndpointPatch
{
    Tags = { },
    EnabledState = EnabledState.Enabled,
};
ArmOperation<FrontDoorEndpointResource> lro = await frontDoorEndpoint.UpdateAsync(WaitUntil.Completed, patch);
FrontDoorEndpointResource result = lro.Value;

// the variable result 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
FrontDoorEndpointData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:: 200

{
  "name": "endpoint1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1",
  "type": "Microsoft.Cdn/profiles/afdendpoints",
  "tags": {},
  "location": "global",
  "properties": {
    "hostName": "endpoint1-ezh7ddcmguaeajfu.z01.azureedge.net",
    "enabledState": "Enabled",
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted",
    "autoGeneratedDomainNameLabelScope": "TenantReuse"
  }
}

状態コード:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-04-15

{
  "name": "endpoint1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1",
  "type": "Microsoft.Cdn/profiles/afdendpoints",
  "tags": {},
  "location": "global",
  "properties": {
    "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net",
    "enabledState": "Enabled",
    "provisioningState": "Updating",
    "deploymentStatus": "NotStarted",
    "autoGeneratedDomainNameLabelScope": "TenantReuse"
  }
}

定義

名前	説明
AFDEndpoint	Azure Front Door エンドポイントは、配信元、プロトコル、コンテンツキャッシュ、配信動作などの構成情報を含む Azure Front Door プロファイル内のエンティティです。 AzureFrontDoor エンドポイントでは、URL 形式の .azureedge.net が使用されます。
AFDEndpointUpdateParameters	エンドポイントを作成または更新するために必要なプロパティ。
AfdProvisioningState	プロビジョニング状態
AutoGeneratedDomainNameLabelScope	エンドポイント名の再利用スコープを示します。既定値は TenantReuse です。
createdByType	リソースを作成した ID の種類。
DeploymentStatus
EnabledState	この規則の使用を有効にするかどうかを指定します。許可される値は 'Enabled' または 'Disabled' です
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
systemData	リソースの作成と最後の変更に関連するメタデータ。

AFDEndpoint

Object

Azure Front Door エンドポイントは、配信元、プロトコル、コンテンツキャッシュ、配信動作などの構成情報を含む Azure Front Door プロファイル内のエンティティです。 AzureFrontDoor エンドポイントでは、URL 形式の .azureedge.net が使用されます。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	リソースが存在する地理的な場所
name	string	リソースの名前
properties.autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope	エンドポイント名の再利用スコープを示します。既定値は TenantReuse です。
properties.deploymentStatus	DeploymentStatus
properties.enabledState	EnabledState	この規則の使用を有効にするかどうかを指定します。許可される値は 'Enabled' または 'Disabled' です
properties.hostName	string	{endpointName} として構造化されたエンドポイントのホスト名。{DNSZone} (例: contoso.azureedge.net)
properties.profileName	string	エンドポイントを保持するプロファイルの名前。
properties.provisioningState	AfdProvisioningState	プロビジョニング状態
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

AFDEndpointUpdateParameters

Object

エンドポイントを作成または更新するために必要なプロパティ。

名前	型	説明
properties.enabledState	EnabledState	この規則の使用を有効にするかどうかを指定します。許可される値は 'Enabled' または 'Disabled' です
properties.profileName	string	エンドポイントを保持するプロファイルの名前。
tags	object	エンドポイントタグ。

AfdProvisioningState

列挙

プロビジョニング状態

値	説明
Creating
Deleting
Failed
Succeeded
Updating

AutoGeneratedDomainNameLabelScope

列挙

エンドポイント名の再利用スコープを示します。既定値は TenantReuse です。

値	説明
NoReuse
ResourceGroupReuse
SubscriptionReuse
TenantReuse

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

DeploymentStatus

列挙

値	説明
Failed
InProgress
NotStarted
Succeeded

EnabledState

列挙

この規則の使用を有効にするかどうかを指定します。許可される値は 'Enabled' または 'Disabled' です

値	説明
Disabled
Enabled

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

AFD Endpoints - Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

AFDEndpoints_Update

要求のサンプル

応答のサンプル

定義

AFDEndpoint

AFDEndpointUpdateParameters

AfdProvisioningState

AutoGeneratedDomainNameLabelScope

createdByType

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

systemData