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
properties	object	The JSON object that contains the properties of the origin group.

list_by_profile

Name	Datatype	Description
properties	object	The JSON object that contains the properties of the origin group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, profileName, originGroupName, subscriptionId		Gets an existing origin group within a profile.
list_by_profile	select	resourceGroupName, profileName, subscriptionId		Lists all of the existing origin groups within a profile.
create	insert	resourceGroupName, profileName, originGroupName, subscriptionId		Creates a new origin group within the specified profile.
update	update	resourceGroupName, profileName, originGroupName, subscriptionId		Updates an existing origin group within a profile.
delete	delete	resourceGroupName, profileName, originGroupName, subscriptionId		Deletes an existing origin group within a 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
originGroupName	string	Name of the origin group which is unique within the profile.
profileName	string	Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName	string	Name of the Resource group within the Azure subscription.
subscriptionId	string	Azure Subscription ID.

SELECT examples

get

Gets an existing origin group within a profile.

SELECT
properties
FROM azure.cdn.afd_origin_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND originGroupName = '{{ originGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_profile

Lists all of the existing origin groups within a profile.

SELECT
properties
FROM azure.cdn.afd_origin_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a new origin group within the specified profile.

INSERT INTO azure.cdn.afd_origin_groups (
data__properties,
resourceGroupName,
profileName,
originGroupName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ profileName }}',
'{{ originGroupName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: afd_origin_groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the afd_origin_groups resource.
    - name: profileName
      value: string
      description: Required parameter for the afd_origin_groups resource.
    - name: originGroupName
      value: string
      description: Required parameter for the afd_origin_groups resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the afd_origin_groups resource.
    - name: properties
      value: object
      description: |
        The JSON object that contains the properties of the origin group.

UPDATE examples

update

Updates an existing origin group within a profile.

UPDATE azure.cdn.afd_origin_groups
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND originGroupName = '{{ originGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes an existing origin group within a profile.

DELETE FROM azure.cdn.afd_origin_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND originGroupName = '{{ originGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;