afd_origin_groups

Creates, updates, deletes, gets or lists an afd_origin_groups resource.

Overview

Name	afd_origin_groups
Type	Resource
Id	azure.cdn.afd_origin_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
authentication	object	Authentication settings for origin in origin group.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
healthProbeSettings	object	Health probe settings to the origin that is used to determine the health of the origin.
loadBalancingSettings	object	Load balancing settings for a backend pool.
profileName	string	The name of the profile which holds the origin group.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
sessionAffinityState	string	Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_profile

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
authentication	object	Authentication settings for origin in origin group.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
healthProbeSettings	object	Health probe settings to the origin that is used to determine the health of the origin.
loadBalancingSettings	object	Load balancing settings for a backend pool.
profileName	string	The name of the profile which holds the origin group.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
sessionAffinityState	string	Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, profile_name, origin_group_name, subscription_id		Gets an existing origin group within a profile.
list_by_profile	select	resource_group_name, profile_name, subscription_id		Lists all of the existing origin groups within a profile.
create	insert	resource_group_name, profile_name, origin_group_name, subscription_id		Creates a new origin group within the specified profile.
update	update	resource_group_name, profile_name, origin_group_name, subscription_id		Updates an existing origin group within a profile.
delete	delete	resource_group_name, profile_name, origin_group_name, subscription_id		Deletes an existing origin group within a profile.
list_resource_usage	exec	resource_group_name, profile_name, origin_group_name, subscription_id		Checks the quota and actual usage of endpoints under the given Azure Front Door profile.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
origin_group_name	string	Name of the origin group which is unique within the endpoint. Required.
profile_name	string	Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets an existing origin group within a profile.

SELECT
id,
name,
authentication,
deploymentStatus,
healthProbeSettings,
loadBalancingSettings,
profileName,
provisioningState,
sessionAffinityState,
systemData,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes,
type
FROM azure.cdn.afd_origin_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND origin_group_name = '{{ origin_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_profile

Lists all of the existing origin groups within a profile.

SELECT
id,
name,
authentication,
deploymentStatus,
healthProbeSettings,
loadBalancingSettings,
profileName,
provisioningState,
sessionAffinityState,
systemData,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes,
type
FROM azure.cdn.afd_origin_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a new origin group within the specified profile.

INSERT INTO azure.cdn.afd_origin_groups (
properties,
resource_group_name,
profile_name,
origin_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ profile_name }}',
'{{ origin_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: afd_origin_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the afd_origin_groups resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the afd_origin_groups resource.
  - name: origin_group_name
    value: "{{ origin_group_name }}"
    description: Required parameter for the afd_origin_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the afd_origin_groups resource.
  - name: properties
    description: |
      The JSON object that contains the properties of the origin group.
    value:
      profileName: "{{ profileName }}"
      loadBalancingSettings:
        sampleSize: {{ sampleSize }}
        successfulSamplesRequired: {{ successfulSamplesRequired }}
        additionalLatencyInMilliseconds: {{ additionalLatencyInMilliseconds }}
      healthProbeSettings:
        probePath: "{{ probePath }}"
        probeRequestType: "{{ probeRequestType }}"
        probeProtocol: "{{ probeProtocol }}"
        probeIntervalInSeconds: {{ probeIntervalInSeconds }}
      trafficRestorationTimeToHealedOrNewEndpointsInMinutes: {{ trafficRestorationTimeToHealedOrNewEndpointsInMinutes }}
      sessionAffinityState: "{{ sessionAffinityState }}"
      authentication:
        type: "{{ type }}"
        userAssignedIdentity:
          id: "{{ id }}"
        scope: "{{ scope }}"
      provisioningState: "{{ provisioningState }}"
      deploymentStatus: "{{ deploymentStatus }}"

UPDATE examples

update

Updates an existing origin group within a profile.

UPDATE azure.cdn.afd_origin_groups
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND origin_group_name = '{{ origin_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes an existing origin group within a profile.

DELETE FROM azure.cdn.afd_origin_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND origin_group_name = '{{ origin_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_resource_usage

Checks the quota and actual usage of endpoints under the given Azure Front Door profile.

EXEC azure.cdn.afd_origin_groups.list_resource_usage 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@origin_group_name='{{ origin_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;