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
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.
cacheConfiguration	object	The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
customDomains	array	Domains referenced by this endpoint.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
enabledState	string	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
endpointName	string	The name of the endpoint which holds the route.
forwardingProtocol	string	Protocol this rule will use when forwarding traffic to backends. Known values are: "HttpOnly", "HttpsOnly", and "MatchRequest". (HttpOnly, HttpsOnly, MatchRequest)
httpsRedirect	string	Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
linkToDefaultDomain	string	whether this route will be linked to the default endpoint domain. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
originGroup	object	Reference to another resource.
originPath	string	A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
patternsToMatch	array	The route patterns of the rule.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
ruleSets	array	rule sets referenced by this endpoint.
supportedProtocols	array	List of supported protocols for this route.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
cacheConfiguration	object	The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
customDomains	array	Domains referenced by this endpoint.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
enabledState	string	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
endpointName	string	The name of the endpoint which holds the route.
forwardingProtocol	string	Protocol this rule will use when forwarding traffic to backends. Known values are: "HttpOnly", "HttpsOnly", and "MatchRequest". (HttpOnly, HttpsOnly, MatchRequest)
httpsRedirect	string	Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
linkToDefaultDomain	string	whether this route will be linked to the default endpoint domain. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
originGroup	object	Reference to another resource.
originPath	string	A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
patternsToMatch	array	The route patterns of the rule.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
ruleSets	array	rule sets referenced by this endpoint.
supportedProtocols	array	List of supported protocols for this route.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, route_name, subscription_id		Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
list_by_endpoint	select	resource_group_name, profile_name, endpoint_name, subscription_id		Lists all of the existing origins within a profile.
create	insert	resource_group_name, profile_name, endpoint_name, route_name, subscription_id		Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
update	update	resource_group_name, profile_name, endpoint_name, route_name, subscription_id		Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
delete	delete	resource_group_name, profile_name, endpoint_name, route_name, subscription_id		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
endpoint_name	string	Name of the endpoint under the profile which is unique globally. 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.
route_name	string	Name of the routing rule. Required.
subscription_id	string

SELECT examples

get

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

SELECT
id,
name,
cacheConfiguration,
customDomains,
deploymentStatus,
enabledState,
endpointName,
forwardingProtocol,
httpsRedirect,
linkToDefaultDomain,
originGroup,
originPath,
patternsToMatch,
provisioningState,
ruleSets,
supportedProtocols,
systemData,
type
FROM azure.cdn.routes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
AND route_name = '{{ route_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_endpoint

Lists all of the existing origins within a profile.

SELECT
id,
name,
cacheConfiguration,
customDomains,
deploymentStatus,
enabledState,
endpointName,
forwardingProtocol,
httpsRedirect,
linkToDefaultDomain,
originGroup,
originPath,
patternsToMatch,
provisioningState,
ruleSets,
supportedProtocols,
systemData,
type
FROM azure.cdn.routes
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 route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.

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

Manifest

# Description fields are for documentation purposes
- name: routes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the routes resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the routes resource.
  - name: endpoint_name
    value: "{{ endpoint_name }}"
    description: Required parameter for the routes resource.
  - name: route_name
    value: "{{ route_name }}"
    description: Required parameter for the routes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the routes resource.
  - name: properties
    description: |
      The JSON object that contains the properties of the Routes to create.
    value:
      endpointName: "{{ endpointName }}"
      customDomains:
        - id: "{{ id }}"
          isActive: {{ isActive }}
      originGroup:
        id: "{{ id }}"
      originPath: "{{ originPath }}"
      ruleSets:
        - id: "{{ id }}"
      supportedProtocols:
        - "{{ supportedProtocols }}"
      patternsToMatch:
        - "{{ patternsToMatch }}"
      cacheConfiguration:
        queryStringCachingBehavior: "{{ queryStringCachingBehavior }}"
        queryParameters: "{{ queryParameters }}"
        compressionSettings:
          contentTypesToCompress:
            - "{{ contentTypesToCompress }}"
          isCompressionEnabled: {{ isCompressionEnabled }}
      forwardingProtocol: "{{ forwardingProtocol }}"
      linkToDefaultDomain: "{{ linkToDefaultDomain }}"
      httpsRedirect: "{{ httpsRedirect }}"
      enabledState: "{{ enabledState }}"
      provisioningState: "{{ provisioningState }}"
      deploymentStatus: "{{ deploymentStatus }}"

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 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND route_name = '{{ route_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

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 resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND route_name = '{{ route_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;