AFD Origins - Update

Reference

Service:: Front Door Service

API Version:: 2023-05-01

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=2023-05-01

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	Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName	path	True	string	Name of the Resource group within the Azure subscription. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure Subscription ID.
api-version	query	True	string	Version of the API to be used with the client request. Current version is 2023-05-01.

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	The value of the HTTP port. Must be between 1 and 65535.
properties.httpsPort	integer	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	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	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	AfdErrorResponse	Azure Front Door error response describing why the operation failed.

Name

Type

Description

200 OK

AFDOrigin

202 Accepted

AFDOrigin

Accepted. The request has been accepted for processing and the operation will complete asynchronously.

Headers

location: string

Other Status Codes

AfdErrorResponse

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/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/origingroup1/origins/origin1?api-version=2023-05-01

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

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=2023-05-01

Response Body

{
  "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
AfdErrorResponse	Error response
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
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.
IdentityType	The type of identity that creates/modifies resources
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	Read only system data

AfdErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

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.

Name	Type	Default Value	Description
id	string		Resource ID.
name	string		Resource name.
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	80	The value of the HTTP port. Must be between 1 and 65535.
properties.httpsPort	integer	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		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		Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
systemData	SystemData		Read only system data
type	string		Resource type.

AFDOriginUpdateParameters

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	80	The value of the HTTP port. Must be between 1 and 65535.
properties.httpsPort	integer	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		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		Weight of the origin in given origin group for load balancing. Must be between 1 and 1000

AfdProvisioningState

Provisioning status

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

DeploymentStatus

Name	Type	Description
Failed	string
InProgress	string
NotStarted	string
Succeeded	string

EnabledState

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

Name	Type	Description
Disabled	string
Enabled	string

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorDetail

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.

IdentityType

The type of identity that creates/modifies resources

Name	Type	Description
application	string
key	string
managedIdentity	string
user	string

ResourceReference

Reference to another resource.

Name	Type	Description
id	string	Resource ID.

SharedPrivateLinkResourceProperties

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

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

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

SystemData

Read only system data

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC)
createdBy	string	An identifier for the identity that created the resource
createdByType	IdentityType	The type of identity that created the resource
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	An identifier for the identity that last modified the resource
lastModifiedByType	IdentityType	The type of identity that last modified the resource

Share via

AFD Origins - Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

AFDOrigins_Update

Sample Request

Sample Response

Definitions

AfdErrorResponse

AFDOrigin

AFDOriginUpdateParameters

AfdProvisioningState

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

IdentityType

ResourceReference

SharedPrivateLinkResourceProperties

SharedPrivateLinkResourceStatus

SystemData

Additional resources