endpoints

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

Overview

Name	`endpoints`
Type	Resource
Id	`azure.traffic_manager.endpoints`

Fields

The following fields are returned by SELECT queries:

Name	Datatype	Description
`id`	`string`	Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}.
`name`	`string`	The name of the resource.
`alwaysServe`	`string`	If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`customHeaders`	`array`	List of custom headers.
`endpointLocation`	`string`	Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
`endpointMonitorStatus`	`string`	The monitoring status of the endpoint. Known values are: "CheckingEndpoint", "Online", "Degraded", "Disabled", "Inactive", "Stopped", and "Unmonitored". (CheckingEndpoint, Online, Degraded, Disabled, Inactive, Stopped, Unmonitored)
`endpointStatus`	`string`	The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`geoMapping`	`array`	The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values.
`minChildEndpoints`	`integer`	The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
`minChildEndpointsIPv4`	`integer`	The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
`minChildEndpointsIPv6`	`integer`	The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
`priority`	`integer`	The priority of this endpoint when using the 'Priority' traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value.
`subnets`	`array`	The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method. An empty list will match all ranges not covered by other endpoints.
`target`	`string`	The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.
`targetResourceId`	`string`	The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
`type`	`string`	The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
`weight`	`integer`	The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`get`	`select`	`resource_group_name`, `profile_name`, `endpoint_type`, `endpoint_name`, `subscription_id`	Gets a Traffic Manager endpoint.
`create_or_update`	`insert`	`resource_group_name`, `profile_name`, `endpoint_type`, `endpoint_name`, `subscription_id`	Create or update a Traffic Manager endpoint.
`update`	`update`	`resource_group_name`, `profile_name`, `endpoint_type`, `endpoint_name`, `subscription_id`	Update a Traffic Manager endpoint.
`create_or_update`	`replace`	`resource_group_name`, `profile_name`, `endpoint_type`, `endpoint_name`, `subscription_id`	Create or update a Traffic Manager endpoint.
`delete`	`delete`	`resource_group_name`, `profile_name`, `endpoint_type`, `endpoint_name`, `subscription_id`	Deletes a Traffic Manager 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`	The name of the Traffic Manager endpoint. Required.
`endpoint_type`	`string`	The type of the Traffic Manager endpoint. Known values are: "AzureEndpoints", "ExternalEndpoints", and "NestedEndpoints". Required.
`profile_name`	`string`	The name of the Traffic Manager profile. Required.
`resource_group_name`	`string`	The name of the resource group. The name is case insensitive. Required.
`subscription_id`	`string`

`SELECT` examples

Gets a Traffic Manager endpoint.

SELECT
id,
name,
alwaysServe,
customHeaders,
endpointLocation,
endpointMonitorStatus,
endpointStatus,
geoMapping,
minChildEndpoints,
minChildEndpointsIPv4,
minChildEndpointsIPv6,
priority,
subnets,
target,
targetResourceId,
type,
weight
FROM azure.traffic_manager.endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND endpoint_type = '{{ endpoint_type }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

`INSERT` examples

create_or_update
Manifest

Create or update a Traffic Manager endpoint.

INSERT INTO azure.traffic_manager.endpoints (
id,
name,
type,
properties,
resource_group_name,
profile_name,
endpoint_type,
endpoint_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ type }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ profile_name }}',
'{{ endpoint_type }}',
'{{ endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

# Description fields are for documentation purposes
- name: endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the endpoints resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the endpoints resource.
  - name: endpoint_type
    value: "{{ endpoint_type }}"
    description: Required parameter for the endpoints resource.
  - name: endpoint_name
    value: "{{ endpoint_name }}"
    description: Required parameter for the endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the endpoints resource.
  - name: id
    value: "{{ id }}"
    description: |
      Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the resource.
  - name: type
    value: "{{ type }}"
    description: |
      The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
  - name: properties
    description: |
      The properties of the Traffic Manager endpoint.
    value:
      targetResourceId: "{{ targetResourceId }}"
      target: "{{ target }}"
      endpointStatus: "{{ endpointStatus }}"
      weight: {{ weight }}
      priority: {{ priority }}
      endpointLocation: "{{ endpointLocation }}"
      endpointMonitorStatus: "{{ endpointMonitorStatus }}"
      minChildEndpoints: {{ minChildEndpoints }}
      minChildEndpointsIPv4: {{ minChildEndpointsIPv4 }}
      minChildEndpointsIPv6: {{ minChildEndpointsIPv6 }}
      geoMapping:
        - "{{ geoMapping }}"
      subnets:
        - first: "{{ first }}"
          last: "{{ last }}"
          scope: {{ scope }}
      customHeaders:
        - name: "{{ name }}"
          value: "{{ value }}"
      alwaysServe: "{{ alwaysServe }}"

`UPDATE` examples

update

Update a Traffic Manager endpoint.

UPDATE azure.traffic_manager.endpoints
SET 
id = '{{ id }}',
name = '{{ name }}',
type = '{{ type }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND endpoint_type = '{{ endpoint_type }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

`REPLACE` examples

create_or_update

Create or update a Traffic Manager endpoint.

REPLACE azure.traffic_manager.endpoints
SET 
id = '{{ id }}',
name = '{{ name }}',
type = '{{ type }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND endpoint_type = '{{ endpoint_type }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

`DELETE` examples

delete

Deletes a Traffic Manager endpoint.

DELETE FROM azure.traffic_manager.endpoints
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND endpoint_type = '{{ endpoint_type }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

REPLACE examples​

DELETE examples​