routes

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

Overview

Name	routes
Type	Resource
Id	azure.cdn.routes

Fields

vw_routes

Name	Datatype	Description
cache_configuration	text	field from the properties object
custom_domains	text	field from the properties object
deployment_status	text	field from the properties object
enabled_state	text	field from the properties object
endpointName	text	field from the properties object
endpoint_name	text	field from the properties object
forwarding_protocol	text	field from the properties object
https_redirect	text	field from the properties object
link_to_default_domain	text	field from the properties object
origin_group	text	field from the properties object
origin_path	text	field from the properties object
patterns_to_match	text	field from the properties object
profileName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
routeName	text	field from the properties object
rule_sets	text	field from the properties object
subscriptionId	text	field from the properties object
supported_protocols	text	field from the properties object

routes

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	endpointName, profileName, resourceGroupName, 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	endpointName, profileName, resourceGroupName, subscriptionId	Lists all of the existing origins within a profile.
create	INSERT	endpointName, profileName, resourceGroupName, routeName, subscriptionId	Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
delete	DELETE	endpointName, profileName, resourceGroupName, routeName, subscriptionId	Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
update	UPDATE	endpointName, profileName, resourceGroupName, routeName, subscriptionId	Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.

SELECT examples

Lists all of the existing origins within a profile.

vw_routes

SELECT
cache_configuration,
custom_domains,
deployment_status,
enabled_state,
endpointName,
endpoint_name,
forwarding_protocol,
https_redirect,
link_to_default_domain,
origin_group,
origin_path,
patterns_to_match,
profileName,
provisioning_state,
resourceGroupName,
routeName,
rule_sets,
subscriptionId,
supported_protocols
FROM azure.cdn.vw_routes
WHERE endpointName = '{{ endpointName }}'
AND profileName = '{{ profileName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

routes

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

INSERT example

Use the following StackQL query and manifest file to create a new routes resource.

All Properties

/*+ create */
INSERT INTO azure.cdn.routes (
endpointName,
profileName,
resourceGroupName,
routeName,
subscriptionId,
properties
)
SELECT 
'{{ endpointName }}',
'{{ profileName }}',
'{{ resourceGroupName }}',
'{{ routeName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: endpointName
          value: string
        - name: customDomains
          value:
            - - name: id
                value: string
              - name: isActive
                value: boolean
        - name: originGroup
          value:
            - name: id
              value: string
        - name: originPath
          value: string
        - name: ruleSets
          value:
            - - name: id
                value: string
        - name: supportedProtocols
          value:
            - []
        - name: patternsToMatch
          value:
            - string
        - name: cacheConfiguration
          value:
            - name: queryStringCachingBehavior
              value: string
            - name: queryParameters
              value: string
            - name: compressionSettings
              value:
                - name: contentTypesToCompress
                  value:
                    - string
                - name: isCompressionEnabled
                  value: boolean
        - name: forwardingProtocol
          value: string
        - name: linkToDefaultDomain
          value: string
        - name: httpsRedirect
          value: string
        - name: enabledState
          value: string
        - name: provisioningState
          value: string
        - name: deploymentStatus
          value: string

UPDATE example

Updates a routes resource.

/*+ update */
UPDATE azure.cdn.routes
SET 
properties = '{{ properties }}'
WHERE 
endpointName = '{{ endpointName }}'
AND profileName = '{{ profileName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND routeName = '{{ routeName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified routes resource.

/*+ delete */
DELETE FROM azure.cdn.routes
WHERE endpointName = '{{ endpointName }}'
AND profileName = '{{ profileName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND routeName = '{{ routeName }}'
AND subscriptionId = '{{ subscriptionId }}';