endpoints

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

Overview

Name	endpoints
Type	Resource
Id	azure.traffic_manager.endpoints

Fields

vw_endpoints

Name	Datatype	Description
always_serve	text	field from the properties object
custom_headers	text	field from the properties object
endpointName	text	field from the properties object
endpointType	text	field from the properties object
endpoint_location	text	field from the properties object
endpoint_monitor_status	text	field from the properties object
endpoint_status	text	field from the properties object
geo_mapping	text	field from the properties object
min_child_endpoints	text	field from the properties object
min_child_endpoints_ipv4	text	field from the properties object
min_child_endpoints_ipv6	text	field from the properties object
priority	text	field from the properties object
profileName	text	field from the properties object
resourceGroupName	text	field from the properties object
subnets	text	field from the properties object
subscriptionId	text	field from the properties object
target	text	field from the properties object
target_resource_id	text	field from the properties object
weight	text	field from the properties object

endpoints

Name	Datatype	Description
properties	object	Class representing a Traffic Manager endpoint properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	endpointName, endpointType, profileName, resourceGroupName, subscriptionId	Gets a Traffic Manager endpoint.
create_or_update	INSERT	endpointName, endpointType, profileName, resourceGroupName, subscriptionId	Create or update a Traffic Manager endpoint.
delete	DELETE	endpointName, endpointType, profileName, resourceGroupName, subscriptionId	Deletes a Traffic Manager endpoint.
update	UPDATE	endpointName, endpointType, profileName, resourceGroupName, subscriptionId	Update a Traffic Manager endpoint.

SELECT examples

Gets a Traffic Manager endpoint.

vw_endpoints

SELECT
always_serve,
custom_headers,
endpointName,
endpointType,
endpoint_location,
endpoint_monitor_status,
endpoint_status,
geo_mapping,
min_child_endpoints,
min_child_endpoints_ipv4,
min_child_endpoints_ipv6,
priority,
profileName,
resourceGroupName,
subnets,
subscriptionId,
target,
target_resource_id,
weight
FROM azure.traffic_manager.vw_endpoints
WHERE endpointName = '{{ endpointName }}'
AND endpointType = '{{ endpointType }}'
AND profileName = '{{ profileName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

endpoints

SELECT
properties
FROM azure.traffic_manager.endpoints
WHERE endpointName = '{{ endpointName }}'
AND endpointType = '{{ endpointType }}'
AND 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.traffic_manager.endpoints (
endpointName,
endpointType,
profileName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ endpointName }}',
'{{ endpointType }}',
'{{ profileName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: targetResourceId
          value: string
        - name: target
          value: string
        - name: endpointStatus
          value: string
        - name: weight
          value: integer
        - name: priority
          value: integer
        - name: endpointLocation
          value: string
        - name: endpointMonitorStatus
          value: string
        - name: minChildEndpoints
          value: integer
        - name: minChildEndpointsIPv4
          value: integer
        - name: minChildEndpointsIPv6
          value: integer
        - name: geoMapping
          value:
            - string
        - name: subnets
          value:
            - - name: first
                value: string
              - name: last
                value: string
              - name: scope
                value: integer
        - name: customHeaders
          value:
            - - name: name
                value: string
              - name: value
                value: string
        - name: alwaysServe
          value: string

UPDATE example

Updates a endpoints resource.

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

DELETE example

Deletes the specified endpoints resource.

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