AFD Origin Groups - List By Profile
Lists all of the existing origin groups within a profile.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups?api-version=2023-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
profile
|
path | True |
string |
Name of the Azure Front Door Standard or Azure Front Door Premium 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 2023-05-01. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
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
AFDOriginGroups_ListByProfile
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups?api-version=2023-05-01
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1",
"type": "Microsoft.Cdn/profiles/origingroups",
"name": "origingroup1",
"properties": {
"loadBalancingSettings": {
"sampleSize": 3,
"successfulSamplesRequired": 3,
"additionalLatencyInMilliseconds": 1000
},
"healthProbeSettings": {
"probePath": "/path1",
"probeRequestType": "HEAD",
"probeProtocol": "Http",
"probeIntervalInSeconds": 10
},
"trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5,
"provisioningState": "Succeeded",
"deploymentStatus": "NotStarted"
}
}
]
}
Definitions
Name | Description |
---|---|
Afd |
Error response |
AFDOrigin |
AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door. |
AFDOrigin |
Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results. |
Afd |
Provisioning status |
Deployment |
|
Enabled |
Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' |
Error |
The resource management error additional info. |
Error |
The error detail. |
Health |
The JSON object that contains the properties to send health probes to origin. |
Health |
The type of health probe request that is made. |
Identity |
The type of identity that creates/modifies resources |
Load |
Round-Robin load balancing settings for a backend pool |
Probe |
Protocol to use for health probe. |
System |
Read only system data |
AfdErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
AFDOriginGroup
AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |
name |
string |
Resource name. |
properties.deploymentStatus | ||
properties.healthProbeSettings |
Health probe settings to the origin that is used to determine the health of the origin. |
|
properties.loadBalancingSettings |
Load balancing settings for a backend pool |
|
properties.profileName |
string |
The name of the profile which holds the origin group. |
properties.provisioningState |
Provisioning status |
|
properties.sessionAffinityState |
Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled' |
|
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. |
AFDOriginGroupListResult
Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.
Name | Type | Description |
---|---|---|
nextLink |
string |
URL to get the next set of origin objects if there are any. |
value |
List of Azure Front Door origin groups within an Azure Front Door endpoint |
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 |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
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 |
IdentityType
The type of identity that creates/modifies resources
Name | Type | Description |
---|---|---|
application |
string |
|
key |
string |
|
managedIdentity |
string |
|
user |
string |
LoadBalancingSettingsParameters
Round-Robin load balancing settings for a backend pool
Name | Type | Description |
---|---|---|
additionalLatencyInMilliseconds |
integer |
The additional latency in milliseconds for probes to fall into the lowest latency bucket |
sampleSize |
integer |
The number of samples to consider for load balancing decisions |
successfulSamplesRequired |
integer |
The number of samples within the sample period that must succeed |
ProbeProtocol
Protocol to use for health probe.
Name | Type | Description |
---|---|---|
Http |
string |
|
Https |
string |
|
NotSet |
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 |
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 |