profiles

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

Overview

Name	profiles
Type	Resource
Id	azure.traffic_manager.profiles

Fields

The following fields are returned by SELECT queries:

get

The Traffic Manager profile.

Name	Datatype	Description
location	string	The Azure Region where the resource lives
properties	object	The properties of the Traffic Manager profile.
tags	object	Resource tags.

list_by_resource_group

The list of Traffic Manager profiles.

Name	Datatype	Description
location	string	The Azure Region where the resource lives
properties	object	The properties of the Traffic Manager profile.
tags	object	Resource tags.

list_by_subscription

The list of Traffic Manager profiles.

Name	Datatype	Description
location	string	The Azure Region where the resource lives
properties	object	The properties of the Traffic Manager profile.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, profileName, subscriptionId		Gets a Traffic Manager profile.
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all Traffic Manager profiles within a resource group.
list_by_subscription	select	subscriptionId		Lists all Traffic Manager profiles within a subscription.
create_or_update	insert	resourceGroupName, profileName, subscriptionId		Create or update a Traffic Manager profile.
update	update	resourceGroupName, profileName, subscriptionId		Update a Traffic Manager profile.
delete	delete	resourceGroupName, profileName, subscriptionId		Deletes a Traffic Manager profile.
check_traffic_manager_relative_dns_name_availability	exec			Checks the availability of a Traffic Manager Relative DNS name.
check_traffic_manager_name_availability_v2	exec	subscriptionId		Checks the availability of a Traffic Manager Relative DNS name.

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
profileName	string	The name of the Traffic Manager profile to be deleted.
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 profile.

SELECT
location,
properties,
tags
FROM azure.traffic_manager.profiles
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists all Traffic Manager profiles within a resource group.

SELECT
location,
properties,
tags
FROM azure.traffic_manager.profiles
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Lists all Traffic Manager profiles within a subscription.

SELECT
location,
properties,
tags
FROM azure.traffic_manager.profiles
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update a Traffic Manager profile.

INSERT INTO azure.traffic_manager.profiles (
data__properties,
data__tags,
data__location,
resourceGroupName,
profileName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ profileName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: profiles
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the profiles resource.
    - name: profileName
      value: string
      description: Required parameter for the profiles resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the profiles resource.
    - name: properties
      value: object
      description: |
        The properties of the Traffic Manager profile.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The Azure Region where the resource lives

UPDATE examples

update

Update a Traffic Manager profile.

UPDATE azure.traffic_manager.profiles
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}',
data__location = '{{ location }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a Traffic Manager profile.

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

Lifecycle Methods

check_traffic_manager_relative_dns_name_availability

Checks the availability of a Traffic Manager Relative DNS name.

EXEC azure.traffic_manager.profiles.check_traffic_manager_relative_dns_name_availability 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

check_traffic_manager_name_availability_v2

Checks the availability of a Traffic Manager Relative DNS name.

EXEC azure.traffic_manager.profiles.check_traffic_manager_name_availability_v2 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;