origin_groups

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

Overview

Name	origin_groups
Type	Resource
Id	azure.cdn.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.
healthProbeSettings	object	Health probe settings to the origin that is used to determine the health of the origin.
origins	array	The source of the content being delivered via CDN within given origin group.
provisioningState	string	Provisioning status of the origin group. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
resourceState	string	Resource status of the origin group. Known values are: "Creating", "Active", and "Deleting". (Creating, Active, Deleting)
responseBasedOriginErrorDetectionSettings	object	The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
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_endpoint

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.
healthProbeSettings	object	Health probe settings to the origin that is used to determine the health of the origin.
origins	array	The source of the content being delivered via CDN within given origin group.
provisioningState	string	Provisioning status of the origin group. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
resourceState	string	Resource status of the origin group. Known values are: "Creating", "Active", and "Deleting". (Creating, Active, Deleting)
responseBasedOriginErrorDetectionSettings	object	The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
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, endpoint_name, origin_group_name, subscription_id		Gets an existing origin group within an endpoint.
list_by_endpoint	select	resource_group_name, profile_name, endpoint_name, subscription_id		Lists all of the existing origin groups within an endpoint.
create	insert	resource_group_name, profile_name, endpoint_name, origin_group_name, subscription_id		Creates a new origin group within the specified endpoint.
update	update	resource_group_name, profile_name, endpoint_name, origin_group_name, subscription_id		Updates an existing origin group within an endpoint.
delete	delete	resource_group_name, profile_name, endpoint_name, origin_group_name, subscription_id		Deletes an existing origin group within an endpoint.

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
endpoint_name	string	Name of the endpoint under the profile which is unique globally. Required.
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 an endpoint.

SELECT
id,
name,
healthProbeSettings,
origins,
provisioningState,
resourceState,
responseBasedOriginErrorDetectionSettings,
systemData,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes,
type
FROM azure.cdn.origin_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
AND origin_group_name = '{{ origin_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_endpoint

Lists all of the existing origin groups within an endpoint.

SELECT
id,
name,
healthProbeSettings,
origins,
provisioningState,
resourceState,
responseBasedOriginErrorDetectionSettings,
systemData,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes,
type
FROM azure.cdn.origin_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a new origin group within the specified endpoint.

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

Manifest

# Description fields are for documentation purposes
- name: origin_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the origin_groups resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the origin_groups resource.
  - name: endpoint_name
    value: "{{ endpoint_name }}"
    description: Required parameter for the origin_groups resource.
  - name: origin_group_name
    value: "{{ origin_group_name }}"
    description: Required parameter for the origin_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the origin_groups resource.
  - name: properties
    description: |
      The JSON object that contains the properties of the origin group.
    value:
      healthProbeSettings:
        probePath: "{{ probePath }}"
        probeRequestType: "{{ probeRequestType }}"
        probeProtocol: "{{ probeProtocol }}"
        probeIntervalInSeconds: {{ probeIntervalInSeconds }}
      origins:
        - id: "{{ id }}"
      trafficRestorationTimeToHealedOrNewEndpointsInMinutes: {{ trafficRestorationTimeToHealedOrNewEndpointsInMinutes }}
      responseBasedOriginErrorDetectionSettings:
        responseBasedDetectedErrorTypes: "{{ responseBasedDetectedErrorTypes }}"
        responseBasedFailoverThresholdPercentage: {{ responseBasedFailoverThresholdPercentage }}
        httpErrorRanges:
          - begin: {{ begin }}
            end: {{ end }}
      resourceState: "{{ resourceState }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates an existing origin group within an endpoint.

UPDATE azure.cdn.origin_groups
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND endpoint_name = '{{ endpoint_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 an endpoint.

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