routes

Creates, updates, deletes, gets or lists a routes resource.

Overview

Name	routes
Type	Resource
Id	azure.cdn.routes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The JSON object that contains the properties of the Routes to create.

list_by_endpoint

Name	Datatype	Description
properties	object	The JSON object that contains the properties of the Routes to create.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, profileName, endpointName, routeName, subscriptionId		Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
list_by_endpoint	select	resourceGroupName, profileName, endpointName, subscriptionId		Lists all of the existing origins within a profile.
create	insert	resourceGroupName, profileName, endpointName, routeName, subscriptionId		Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
update	update	resourceGroupName, profileName, endpointName, routeName, subscriptionId		Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
delete	delete	resourceGroupName, profileName, endpointName, routeName, subscriptionId		Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor 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.
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.
routeName	string	Name of the routing rule.
subscriptionId	string	Azure Subscription ID.

SELECT examples

get

Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.

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

list_by_endpoint

Lists all of the existing origins within a profile.

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

INSERT examples

create

Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.

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

Manifest

# Description fields are for documentation purposes
- name: routes
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the routes resource.
    - name: profileName
      value: string
      description: Required parameter for the routes resource.
    - name: endpointName
      value: string
      description: Required parameter for the routes resource.
    - name: routeName
      value: string
      description: Required parameter for the routes resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the routes resource.
    - name: properties
      value: object
      description: |
        The JSON object that contains the properties of the Routes to create.

UPDATE examples

update

Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.

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

DELETE examples

delete

Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.

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