Origin Groups - Create
Creates a new origin group within the specified endpoint.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}?api-version=2024-02-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Name of the endpoint under the profile which is unique globally. |
origin
|
path | True |
string |
Name of the origin group which is unique within the endpoint. |
profile
|
path | True |
string |
Name of the CDN profile which is unique within the resource group. |
resource
|
path | True |
string |
Name of the Resource group within the Azure subscription. Regex pattern: |
subscription
|
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 2024-02-01. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
properties.origins | True |
The source of the content being delivered via CDN within given origin group. |
|
properties.healthProbeSettings |
Health probe settings to the origin that is used to determine the health of the origin. |
||
properties.responseBasedOriginErrorDetectionSettings |
The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. |
||
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes |
integer |
Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. The request has succeeded. |
|
201 Created |
Created. The request has been fulfilled and a new origin group has been created. |
|
202 Accepted |
Accepted and the operation will complete asynchronously. Headers location: string |
|
Other Status Codes |
CDN 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
OriginGroups_Create
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/origingroup1?api-version=2024-02-01
{
"properties": {
"healthProbeSettings": {
"probePath": "/health.aspx",
"probeRequestType": "GET",
"probeProtocol": "Http",
"probeIntervalInSeconds": 120
},
"origins": [
{
"id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
}
],
"responseBasedOriginErrorDetectionSettings": {
"responseBasedDetectedErrorTypes": "TcpErrorsOnly",
"responseBasedFailoverThresholdPercentage": 10
}
}
}
Sample Response
{
"name": "origingroup1",
"id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1",
"type": "Microsoft.Cdn/profiles/endpoints/origingroups",
"properties": {
"provisioningState": "Succeeded",
"resourceState": "Active",
"healthProbeSettings": {
"probePath": "/health.aspx",
"probeRequestType": "GET",
"probeProtocol": "Http",
"probeIntervalInSeconds": 120
},
"origins": [
{
"id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
}
],
"responseBasedOriginErrorDetectionSettings": {
"responseBasedDetectedErrorTypes": "TcpErrorsOnly",
"responseBasedFailoverThresholdPercentage": 10
}
}
}
{
"name": "origingroup1",
"id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1",
"type": "Microsoft.Cdn/profiles/endpoints/origingroups",
"properties": {
"provisioningState": "Succeeded",
"resourceState": "Active",
"healthProbeSettings": {
"probePath": "/health.aspx",
"probeRequestType": "GET",
"probeProtocol": "Http",
"probeIntervalInSeconds": 120
},
"origins": [
{
"id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
}
],
"responseBasedOriginErrorDetectionSettings": {
"responseBasedDetectedErrorTypes": "TcpErrorsOnly",
"responseBasedFailoverThresholdPercentage": 10
}
}
}
azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-02-01
{
"name": "originGroup1",
"id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1",
"type": "Microsoft.Cdn/profiles/endpoints/origingroups",
"properties": {
"provisioningState": "Succeeded",
"resourceState": "Active",
"healthProbeSettings": {
"probePath": "/health.aspx",
"probeRequestType": "GET",
"probeProtocol": "Http",
"probeIntervalInSeconds": 120
},
"origins": [
{
"id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
}
],
"responseBasedOriginErrorDetectionSettings": {
"responseBasedDetectedErrorTypes": "TcpErrorsOnly",
"responseBasedFailoverThresholdPercentage": 10
}
}
}
Definitions
Name | Description |
---|---|
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Health |
The JSON object that contains the properties to send health probes to origin. |
Health |
The type of health probe request that is made. |
Http |
The JSON object that represents the range for http status codes |
Identity |
The type of identity that creates/modifies resources |
Origin |
Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN. |
Origin |
Provisioning status of the origin group. |
Origin |
Resource status of the origin group. |
Probe |
Protocol to use for health probe. |
Resource |
Reference to another resource. |
Response |
Type of response errors for real user requests for which origin will be deemed unhealthy |
Response |
The JSON object that contains the properties to determine origin health using real requests/responses. |
System |
Read only system data |
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 |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
HealthProbeParameters
The JSON object that contains the properties to send health probes to origin.
Name | Type | Description |
---|---|---|
probeIntervalInSeconds |
integer |
The number of seconds between health probes.Default is 240sec. |
probePath |
string |
The path relative to the origin that is used to determine the health of the origin. |
probeProtocol |
Protocol to use for health probe. |
|
probeRequestType |
The type of health probe request that is made. |
HealthProbeRequestType
The type of health probe request that is made.
Name | Type | Description |
---|---|---|
GET |
string |
|
HEAD |
string |
|
NotSet |
string |
HttpErrorRangeParameters
The JSON object that represents the range for http status codes
Name | Type | Description |
---|---|---|
begin |
integer |
The inclusive start of the http status code range. |
end |
integer |
The inclusive end of the http status code range. |
IdentityType
The type of identity that creates/modifies resources
Name | Type | Description |
---|---|---|
application |
string |
|
key |
string |
|
managedIdentity |
string |
|
user |
string |
OriginGroup
Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |
name |
string |
Resource name. |
properties.healthProbeSettings |
Health probe settings to the origin that is used to determine the health of the origin. |
|
properties.origins |
The source of the content being delivered via CDN within given origin group. |
|
properties.provisioningState |
Provisioning status of the origin group. |
|
properties.resourceState |
Resource status of the origin group. |
|
properties.responseBasedOriginErrorDetectionSettings |
The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. |
|
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes |
integer |
Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. |
systemData |
Read only system data |
|
type |
string |
Resource type. |
OriginGroupProvisioningState
Provisioning status of the origin group.
Name | Type | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
OriginGroupResourceState
Resource status of the origin group.
Name | Type | Description |
---|---|---|
Active |
string |
|
Creating |
string |
|
Deleting |
string |
ProbeProtocol
Protocol to use for health probe.
Name | Type | Description |
---|---|---|
Http |
string |
|
Https |
string |
|
NotSet |
string |
ResourceReference
Reference to another resource.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |
ResponseBasedDetectedErrorTypes
Type of response errors for real user requests for which origin will be deemed unhealthy
Name | Type | Description |
---|---|---|
None |
string |
|
TcpAndHttpErrors |
string |
|
TcpErrorsOnly |
string |
ResponseBasedOriginErrorDetectionParameters
The JSON object that contains the properties to determine origin health using real requests/responses.
Name | Type | Description |
---|---|---|
httpErrorRanges |
The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. |
|
responseBasedDetectedErrorTypes |
Type of response errors for real user requests for which origin will be deemed unhealthy |
|
responseBasedFailoverThresholdPercentage |
integer |
The percentage of failed requests in the sample where failover should trigger. |
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 |
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 |
The type of identity that last modified the resource |