endpoints

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

Overview

Name	endpoints
Type	Resource
Id	azure.cdn.endpoints

Fields

vw_endpoints

Name	Datatype	Description
content_types_to_compress	text	field from the properties object
custom_domains	text	field from the properties object
default_origin_group	text	field from the properties object
delivery_policy	text	field from the properties object
endpointName	text	field from the properties object
geo_filters	text	field from the properties object
host_name	text	field from the properties object
is_compression_enabled	text	field from the properties object
is_http_allowed	text	field from the properties object
is_https_allowed	text	field from the properties object
location	text	Resource location.
optimization_type	text	field from the properties object
origin_groups	text	field from the properties object
origin_host_header	text	field from the properties object
origin_path	text	field from the properties object
origins	text	field from the properties object
probe_path	text	field from the properties object
profileName	text	field from the properties object
provisioning_state	text	field from the properties object
query_string_caching_behavior	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_state	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
url_signing_keys	text	field from the properties object
web_application_firewall_policy_link	text	field from the properties object

endpoints

Name	Datatype	Description
location	string	Resource location.
properties	object	The JSON object that contains the properties required to create an endpoint.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	endpointName, profileName, resourceGroupName, subscriptionId	Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
list_by_profile	SELECT	profileName, resourceGroupName, subscriptionId	Lists existing CDN endpoints.
create	INSERT	endpointName, profileName, resourceGroupName, subscriptionId	Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
delete	DELETE	endpointName, profileName, resourceGroupName, subscriptionId	Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
update	UPDATE	endpointName, profileName, resourceGroupName, subscriptionId	Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.
load_content	EXEC	endpointName, profileName, resourceGroupName, subscriptionId, data__contentPaths	Pre-loads a content to CDN. Available for Verizon Profiles.
purge_content	EXEC	endpointName, profileName, resourceGroupName, subscriptionId, data__contentPaths	Removes a content from CDN.
start	EXEC	endpointName, profileName, resourceGroupName, subscriptionId	Starts an existing CDN endpoint that is on a stopped state.
stop	EXEC	endpointName, profileName, resourceGroupName, subscriptionId	Stops an existing running CDN endpoint.
validate_custom_domain	EXEC	endpointName, profileName, resourceGroupName, subscriptionId, data__hostName	Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

SELECT examples

Lists existing CDN endpoints.

vw_endpoints

SELECT
content_types_to_compress,
custom_domains,
default_origin_group,
delivery_policy,
endpointName,
geo_filters,
host_name,
is_compression_enabled,
is_http_allowed,
is_https_allowed,
location,
optimization_type,
origin_groups,
origin_host_header,
origin_path,
origins,
probe_path,
profileName,
provisioning_state,
query_string_caching_behavior,
resourceGroupName,
resource_state,
subscriptionId,
tags,
url_signing_keys,
web_application_firewall_policy_link
FROM azure.cdn.vw_endpoints
WHERE profileName = '{{ profileName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

endpoints

SELECT
location,
properties,
tags
FROM azure.cdn.endpoints
WHERE profileName = '{{ profileName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: originPath
          value: string
        - name: contentTypesToCompress
          value:
            - string
        - name: originHostHeader
          value: string
        - name: isCompressionEnabled
          value: boolean
        - name: isHttpAllowed
          value: boolean
        - name: isHttpsAllowed
          value: boolean
        - name: queryStringCachingBehavior
          value: []
        - name: optimizationType
          value: []
        - name: probePath
          value: string
        - name: geoFilters
          value:
            - - name: relativePath
                value: string
              - name: action
                value: string
              - name: countryCodes
                value:
                  - string
        - name: defaultOriginGroup
          value:
            - name: id
              value: string
        - name: urlSigningKeys
          value:
            - - name: keyId
                value: string
              - name: keySourceParameters
                value:
                  - name: typeName
                    value: string
                  - name: subscriptionId
                    value: string
                  - name: resourceGroupName
                    value: string
                  - name: vaultName
                    value: string
                  - name: secretName
                    value: string
                  - name: secretVersion
                    value: string
        - name: deliveryPolicy
          value:
            - name: description
              value: string
            - name: rules
              value:
                - - name: name
                    value: string
                  - name: order
                    value: integer
                  - name: conditions
                    value:
                      - - name: name
                          value: string
                  - name: actions
                    value:
                      - - name: name
                          value: string
        - name: webApplicationFirewallPolicyLink
          value:
            - name: id
              value: string
        - name: hostName
          value: string
        - name: origins
          value:
            - - name: name
                value: string
              - name: properties
                value:
                  - name: hostName
                    value: string
                  - name: httpPort
                    value: integer
                  - name: httpsPort
                    value: integer
                  - name: originHostHeader
                    value: string
                  - name: priority
                    value: integer
                  - name: weight
                    value: integer
                  - name: enabled
                    value: boolean
                  - name: privateLinkAlias
                    value: string
                  - name: privateLinkResourceId
                    value: string
                  - name: privateLinkLocation
                    value: string
                  - name: privateLinkApprovalMessage
                    value: string
                  - name: privateEndpointStatus
                    value: []
        - name: originGroups
          value:
            - - name: name
                value: string
              - name: properties
                value:
                  - name: healthProbeSettings
                    value:
                      - name: probePath
                        value: string
                      - name: probeRequestType
                        value: string
                      - name: probeProtocol
                        value: string
                      - name: probeIntervalInSeconds
                        value: integer
                  - name: origins
                    value:
                      - - name: id
                          value: string
                  - name: trafficRestorationTimeToHealedOrNewEndpointsInMinutes
                    value: integer
                  - name: responseBasedOriginErrorDetectionSettings
                    value:
                      - name: responseBasedDetectedErrorTypes
                        value: string
                      - name: responseBasedFailoverThresholdPercentage
                        value: integer
                      - name: httpErrorRanges
                        value:
                          - - name: begin
                              value: integer
                            - name: end
                              value: integer
        - name: customDomains
          value:
            - - name: name
                value: string
              - name: properties
                value:
                  - name: hostName
                    value: string
                  - name: validationData
                    value: string
        - name: resourceState
          value: string
        - name: provisioningState
          value: string

UPDATE example

Updates a endpoints resource.

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

DELETE example

Deletes the specified endpoints resource.

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