afd_origins
Creates, updates, deletes, gets or lists an afd_origins
resource.
Overview
Name | afd_origins |
Type | Resource |
Id | azure.cdn.afd_origins |
Fields
The following fields are returned by SELECT
queries:
- get
- list_by_origin_group
Name | Datatype | Description |
---|---|---|
properties | object | The JSON object that contains the properties of the origin. |
Name | Datatype | Description |
---|---|---|
properties | object | The JSON object that contains the properties of the origin. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | resourceGroupName , profileName , originGroupName , originName , subscriptionId | Gets an existing origin within an origin group. | |
list_by_origin_group | select | resourceGroupName , profileName , originGroupName , subscriptionId | Lists all of the existing origins within an origin group. | |
create | insert | resourceGroupName , profileName , originGroupName , originName , subscriptionId | Creates a new origin within the specified origin group. | |
update | update | resourceGroupName , profileName , originGroupName , originName , subscriptionId | Updates an existing origin within an origin group. | |
delete | delete | resourceGroupName , profileName , originGroupName , originName , subscriptionId | Deletes an existing origin within an origin group. |
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. |
originName | string | Name of the origin 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
- list_by_origin_group
Gets an existing origin within an origin group.
SELECT
properties
FROM azure.cdn.afd_origins
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND originGroupName = '{{ originGroupName }}' -- required
AND originName = '{{ originName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Lists all of the existing origins within an origin group.
SELECT
properties
FROM azure.cdn.afd_origins
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND originGroupName = '{{ originGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
INSERT
examples
- create
- Manifest
Creates a new origin within the specified origin group.
INSERT INTO azure.cdn.afd_origins (
data__properties,
resourceGroupName,
profileName,
originGroupName,
originName,
subscriptionId
)
SELECT
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ profileName }}',
'{{ originGroupName }}',
'{{ originName }}',
'{{ subscriptionId }}'
RETURNING
properties
;
# Description fields are for documentation purposes
- name: afd_origins
props:
- name: resourceGroupName
value: string
description: Required parameter for the afd_origins resource.
- name: profileName
value: string
description: Required parameter for the afd_origins resource.
- name: originGroupName
value: string
description: Required parameter for the afd_origins resource.
- name: originName
value: string
description: Required parameter for the afd_origins resource.
- name: subscriptionId
value: string
description: Required parameter for the afd_origins resource.
- name: properties
value: object
description: |
The JSON object that contains the properties of the origin.
UPDATE
examples
- update
Updates an existing origin within an origin group.
UPDATE azure.cdn.afd_origins
SET
data__properties = '{{ properties }}'
WHERE
resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND originGroupName = '{{ originGroupName }}' --required
AND originName = '{{ originName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;
DELETE
examples
- delete
Deletes an existing origin within an origin group.
DELETE FROM azure.cdn.afd_origins
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND originGroupName = '{{ originGroupName }}' --required
AND originName = '{{ originName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;