origins

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

Overview

Name	origins
Type	Resource
Id	azure.cdn.origins

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

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

list_by_endpoint

OK. The request has succeeded.

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, endpointName, originName, subscriptionId		Gets an existing origin within an endpoint.
list_by_endpoint	select	resourceGroupName, profileName, endpointName, subscriptionId		Lists all of the existing origins within an endpoint.
create	insert	resourceGroupName, profileName, endpointName, originName, subscriptionId		Creates a new origin within the specified endpoint.
update	update	resourceGroupName, profileName, endpointName, originName, subscriptionId		Updates an existing origin within an endpoint.
delete	delete	resourceGroupName, profileName, endpointName, originName, subscriptionId		Deletes an existing origin 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
endpointName	string	Name of the endpoint under the profile which is unique globally.
originName	string	Name of the origin which is unique within the endpoint.
profileName	string	Name of the CDN 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 within an endpoint.

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

list_by_endpoint

Lists all of the existing origins within an endpoint.

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

INSERT examples

create

Creates a new origin within the specified endpoint.

INSERT INTO azure.cdn.origins (
data__properties,
resourceGroupName,
profileName,
endpointName,
originName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ profileName }}',
'{{ endpointName }}',
'{{ originName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: origins
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the origins resource.
    - name: profileName
      value: string
      description: Required parameter for the origins resource.
    - name: endpointName
      value: string
      description: Required parameter for the origins resource.
    - name: originName
      value: string
      description: Required parameter for the origins resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the 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 endpoint.

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

DELETE examples

delete

Deletes an existing origin within an endpoint.

DELETE FROM azure.cdn.origins
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND endpointName = '{{ endpointName }}' --required
AND originName = '{{ originName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;