AFD Origins - Update

Service:

Front Door Service

API Version:

2025-04-15

Updates an existing origin within an origin group.

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

URI Parameters

Name	In	Required	Type	Description
originGroupName	path	True	string	Name of the origin group which is unique within the profile.
originName	path	True	string	Name of the origin which is unique within the profile.
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$	Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
properties.azureOrigin	ResourceReference	Resource reference to the Azure origin resource.
properties.enabledState	EnabledState	Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
properties.enforceCertificateNameCheck	boolean	Whether to enable certificate name check at origin level
properties.hostName	string	The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
properties.httpPort	integer (int32) minimum: 1 maximum: 65535 exclusiveMinimum: False exclusiveMaximum: False	The value of the HTTP port. Must be between 1 and 65535.
properties.httpsPort	integer (int32) minimum: 1 maximum: 65535 exclusiveMinimum: False exclusiveMaximum: False	The value of the HTTPS port. Must be between 1 and 65535.
properties.originHostHeader	string	The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
properties.priority	integer (int32) minimum: 1 maximum: 5	Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
properties.sharedPrivateLinkResource	SharedPrivateLinkResourceProperties	The properties of the private link resource for private origin.
properties.weight	integer (int32) minimum: 1 maximum: 1000	Weight of the origin in given origin group for load balancing. Must be between 1 and 1000

Responses

Name	Type	Description
200 OK	AFDOrigin	OK
202 Accepted	AFDOrigin	Accepted. The request has been accepted for processing and the operation will complete asynchronously. Headers location: string
Other Status Codes	ErrorResponse	Azure Front Door error response describing why the operation failed.

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

AFDOrigins_Update

Sample request

HTTP

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

{
  "properties": {
    "hostName": "host1.blob.core.windows.net",
    "httpPort": 80,
    "httpsPort": 443,
    "enabledState": "Enabled"
  }
}

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/AFDOrigins_Update.json
// this example is just showing the usage of "FrontDoorOrigins_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 FrontDoorOriginResource created on azure
// for more information of creating FrontDoorOriginResource, please refer to the document of FrontDoorOriginResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
string originGroupName = "origingroup1";
string originName = "origin1";
ResourceIdentifier frontDoorOriginResourceId = FrontDoorOriginResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, originGroupName, originName);
FrontDoorOriginResource frontDoorOrigin = client.GetFrontDoorOriginResource(frontDoorOriginResourceId);

// invoke the operation
FrontDoorOriginPatch patch = new FrontDoorOriginPatch
{
    HostName = "host1.blob.core.windows.net",
    HttpPort = 80,
    HttpsPort = 443,
    EnabledState = EnabledState.Enabled,
};
ArmOperation<FrontDoorOriginResource> lro = await frontDoorOrigin.UpdateAsync(WaitUntil.Completed, patch);
FrontDoorOriginResource 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
FrontDoorOriginData 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

Sample response

Status code:

200

{
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1",
  "type": "Microsoft.Cdn/profiles/origingroups/origins",
  "name": "origin1",
  "properties": {
    "hostName": "host1.blob.core.windows.net",
    "httpPort": 80,
    "httpsPort": 443,
    "originHostHeader": "host1.foo.com",
    "priority": null,
    "weight": null,
    "enabledState": "Enabled",
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted",
    "originGroupName": "origingroup1",
    "sharedPrivateLinkResource": null,
    "enforceCertificateNameCheck": true
  }
}

Status code:

202

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

{
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1",
  "type": "Microsoft.Cdn/profiles/origingroups/origins",
  "name": "origin1",
  "properties": {
    "hostName": "host1.blob.core.windows.net",
    "httpPort": 80,
    "httpsPort": 443,
    "originHostHeader": "host1.foo.com",
    "priority": null,
    "weight": null,
    "enabledState": "Enabled",
    "provisioningState": "Updating",
    "deploymentStatus": "NotStarted",
    "originGroupName": "origingroup1",
    "sharedPrivateLinkResource": null,
    "enforceCertificateNameCheck": true
  }
}

Definitions

Name	Description
AFDOrigin	Azure Front Door origin is the source of the content being delivered via Azure Front Door. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.
AFDOriginUpdateParameters	AFDOrigin properties needed for origin update.
AfdProvisioningState	Provisioning status
createdByType	The type of identity that created the resource.
DeploymentStatus
EnabledState	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ResourceReference	Reference to another resource.
SharedPrivateLinkResourceProperties	Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin.
SharedPrivateLinkResourceStatus	Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.
systemData	Metadata pertaining to creation and last modification of the resource.

AFDOrigin

Object

Azure Front Door origin is the source of the content being delivered via Azure Front Door. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.

Name	Type	Default value	Description
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		The name of the resource
properties.azureOrigin	ResourceReference		Resource reference to the Azure origin resource.
properties.deploymentStatus	DeploymentStatus
properties.enabledState	EnabledState		Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
properties.enforceCertificateNameCheck	boolean	True	Whether to enable certificate name check at origin level
properties.hostName	string		The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
properties.httpPort	integer (int32) minimum: 1 maximum: 65535 exclusiveMinimum: False exclusiveMaximum: False	80	The value of the HTTP port. Must be between 1 and 65535.
properties.httpsPort	integer (int32) minimum: 1 maximum: 65535 exclusiveMinimum: False exclusiveMaximum: False	443	The value of the HTTPS port. Must be between 1 and 65535.
properties.originGroupName	string		The name of the origin group which contains this origin.
properties.originHostHeader	string		The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
properties.priority	integer (int32) minimum: 1 maximum: 5		Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
properties.provisioningState	AfdProvisioningState		Provisioning status
properties.sharedPrivateLinkResource	SharedPrivateLinkResourceProperties		The properties of the private link resource for private origin.
properties.weight	integer (int32) minimum: 1 maximum: 1000		Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
systemData	systemData		Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

AFDOriginUpdateParameters

Object

AFDOrigin properties needed for origin update.

Name	Type	Default value	Description
properties.azureOrigin	ResourceReference		Resource reference to the Azure origin resource.
properties.enabledState	EnabledState		Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
properties.enforceCertificateNameCheck	boolean	True	Whether to enable certificate name check at origin level
properties.hostName	string		The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
properties.httpPort	integer (int32) minimum: 1 maximum: 65535 exclusiveMinimum: False exclusiveMaximum: False	80	The value of the HTTP port. Must be between 1 and 65535.
properties.httpsPort	integer (int32) minimum: 1 maximum: 65535 exclusiveMinimum: False exclusiveMaximum: False	443	The value of the HTTPS port. Must be between 1 and 65535.
properties.originGroupName	string		The name of the origin group which contains this origin.
properties.originHostHeader	string		The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
properties.priority	integer (int32) minimum: 1 maximum: 5		Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
properties.sharedPrivateLinkResource	SharedPrivateLinkResourceProperties		The properties of the private link resource for private origin.
properties.weight	integer (int32) minimum: 1 maximum: 1000		Weight of the origin in given origin group for load balancing. Must be between 1 and 1000

AfdProvisioningState

Enumeration

Provisioning status

Value	Description
Succeeded
Failed
Updating
Deleting
Creating

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DeploymentStatus

Enumeration

Value	Description
NotStarted
InProgress
Succeeded
Failed

EnabledState

Enumeration

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'

Value	Description
Enabled
Disabled

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ResourceReference

Object

Reference to another resource.

Name	Type	Description
id	string	Resource ID.

SharedPrivateLinkResourceProperties

Object

Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin.

Name	Type	Description
groupId	string	The group id from the provider of resource the shared private link resource is for.
privateLink	ResourceReference	The resource id of the resource the shared private link resource is for.
privateLinkLocation	string	The location of the shared private link resource
requestMessage	string	The request message for requesting approval of the shared private link resource.
status	SharedPrivateLinkResourceStatus	Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.

SharedPrivateLinkResourceStatus

Enumeration

Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.

Value	Description
Pending
Approved
Rejected
Disconnected
Timeout

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.