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:

get

The Traffic Manager endpoint.

Name	Datatype	Description
properties	object	The properties of the Traffic Manager endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, profileName, endpointType, endpointName, subscriptionId		Gets a Traffic Manager endpoint.
create_or_update	insert	resourceGroupName, profileName, endpointType, endpointName, subscriptionId		Create or update a Traffic Manager endpoint.
update	update	resourceGroupName, profileName, endpointType, endpointName, subscriptionId		Update a Traffic Manager endpoint.
delete	delete	resourceGroupName, profileName, endpointType, endpointName, subscriptionId		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
endpointName	string	The name of the Traffic Manager endpoint to be deleted.
endpointType	string	The type of the Traffic Manager endpoint to be deleted.
profileName	string	The name of the Traffic Manager profile.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets a Traffic Manager endpoint.

SELECT
properties
FROM azure.traffic_manager.endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND endpointType = '{{ endpointType }}' -- required
AND endpointName = '{{ endpointName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update a Traffic Manager endpoint.

INSERT INTO azure.traffic_manager.endpoints (
data__properties,
resourceGroupName,
profileName,
endpointType,
endpointName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ profileName }}',
'{{ endpointType }}',
'{{ endpointName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the endpoints resource.
    - name: profileName
      value: string
      description: Required parameter for the endpoints resource.
    - name: endpointType
      value: string
      description: Required parameter for the endpoints resource.
    - name: endpointName
      value: string
      description: Required parameter for the endpoints resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the endpoints resource.
    - name: properties
      value: object
      description: |
        The properties of the Traffic Manager endpoint.

UPDATE examples

update

Update a Traffic Manager endpoint.

UPDATE azure.traffic_manager.endpoints
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND endpointType = '{{ endpointType }}' --required
AND endpointName = '{{ endpointName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes a Traffic Manager endpoint.

DELETE FROM azure.traffic_manager.endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND endpointType = '{{ endpointType }}' --required
AND endpointName = '{{ endpointName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;