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

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.
allowedEndpointRecordTypes	array	The list of allowed endpoint record types.
dnsConfig	object	The DNS settings of the Traffic Manager profile.
endpoints	array	The list of endpoints in the Traffic Manager profile.
location	string	The Azure Region where the resource lives.
maxReturn	integer	Maximum number of endpoints to be returned for MultiValue routing type.
monitorConfig	object	The endpoint monitoring settings of the Traffic Manager profile.
profileStatus	string	The status of the Traffic Manager profile. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
recordType	string	When record type is set, a traffic manager profile will allow only endpoints that match this type. Known values are: "A", "AAAA", and "CNAME". (A, AAAA, CNAME)
tags	object	Resource tags.
trafficRoutingMethod	string	The traffic routing method of the Traffic Manager profile. Known values are: "Performance", "Priority", "Weighted", "Geographic", "MultiValue", and "Subnet". (Performance, Priority, Weighted, Geographic, MultiValue, Subnet)
trafficViewEnrollmentStatus	string	Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
type	string	The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

list_by_resource_group

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.
allowedEndpointRecordTypes	array	The list of allowed endpoint record types.
dnsConfig	object	The DNS settings of the Traffic Manager profile.
endpoints	array	The list of endpoints in the Traffic Manager profile.
location	string	The Azure Region where the resource lives.
maxReturn	integer	Maximum number of endpoints to be returned for MultiValue routing type.
monitorConfig	object	The endpoint monitoring settings of the Traffic Manager profile.
profileStatus	string	The status of the Traffic Manager profile. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
recordType	string	When record type is set, a traffic manager profile will allow only endpoints that match this type. Known values are: "A", "AAAA", and "CNAME". (A, AAAA, CNAME)
tags	object	Resource tags.
trafficRoutingMethod	string	The traffic routing method of the Traffic Manager profile. Known values are: "Performance", "Priority", "Weighted", "Geographic", "MultiValue", and "Subnet". (Performance, Priority, Weighted, Geographic, MultiValue, Subnet)
trafficViewEnrollmentStatus	string	Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
type	string	The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

list_by_subscription

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.
allowedEndpointRecordTypes	array	The list of allowed endpoint record types.
dnsConfig	object	The DNS settings of the Traffic Manager profile.
endpoints	array	The list of endpoints in the Traffic Manager profile.
location	string	The Azure Region where the resource lives.
maxReturn	integer	Maximum number of endpoints to be returned for MultiValue routing type.
monitorConfig	object	The endpoint monitoring settings of the Traffic Manager profile.
profileStatus	string	The status of the Traffic Manager profile. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
recordType	string	When record type is set, a traffic manager profile will allow only endpoints that match this type. Known values are: "A", "AAAA", and "CNAME". (A, AAAA, CNAME)
tags	object	Resource tags.
trafficRoutingMethod	string	The traffic routing method of the Traffic Manager profile. Known values are: "Performance", "Priority", "Weighted", "Geographic", "MultiValue", and "Subnet". (Performance, Priority, Weighted, Geographic, MultiValue, Subnet)
trafficViewEnrollmentStatus	string	Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
type	string	The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

check_traffic_manager_relative_dns_name_availability

Name	Datatype	Description
name	string	The relative name.
message	string	Descriptive message that explains why the name is not available, when applicable.
nameAvailable	boolean	Describes whether the relative name is available or not.
reason	string	The reason why the name is not available, when applicable.
type	string	Traffic Manager profile resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, profile_name, subscription_id		Gets a Traffic Manager profile.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all Traffic Manager profiles within a resource group.
list_by_subscription	select	subscription_id		Lists all Traffic Manager profiles within a subscription.
check_traffic_manager_relative_dns_name_availability	select			Checks the availability of a Traffic Manager Relative DNS name.
create_or_update	insert	resource_group_name, profile_name, subscription_id		Create or update a Traffic Manager profile.
update	update	resource_group_name, profile_name, subscription_id		Update a Traffic Manager profile.
create_or_update	replace	resource_group_name, profile_name, subscription_id		Create or update a Traffic Manager profile.
delete	delete	resource_group_name, profile_name, subscription_id		Deletes a Traffic Manager profile.
check_traffic_manager_name_availability_v2	exec	subscription_id		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
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

get

Gets a Traffic Manager profile.

SELECT
id,
name,
allowedEndpointRecordTypes,
dnsConfig,
endpoints,
location,
maxReturn,
monitorConfig,
profileStatus,
recordType,
tags,
trafficRoutingMethod,
trafficViewEnrollmentStatus,
type
FROM azure.traffic_manager.profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all Traffic Manager profiles within a resource group.

SELECT
id,
name,
allowedEndpointRecordTypes,
dnsConfig,
endpoints,
location,
maxReturn,
monitorConfig,
profileStatus,
recordType,
tags,
trafficRoutingMethod,
trafficViewEnrollmentStatus,
type
FROM azure.traffic_manager.profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all Traffic Manager profiles within a subscription.

SELECT
id,
name,
allowedEndpointRecordTypes,
dnsConfig,
endpoints,
location,
maxReturn,
monitorConfig,
profileStatus,
recordType,
tags,
trafficRoutingMethod,
trafficViewEnrollmentStatus,
type
FROM azure.traffic_manager.profiles
WHERE subscription_id = '{{ subscription_id }}' -- required
;

check_traffic_manager_relative_dns_name_availability

Checks the availability of a Traffic Manager Relative DNS name.

SELECT
name,
message,
nameAvailable,
reason,
type
FROM azure.traffic_manager.profiles
;

INSERT examples

create_or_update

Create or update a Traffic Manager profile.

INSERT INTO azure.traffic_manager.profiles (
id,
name,
type,
tags,
location,
properties,
resource_group_name,
profile_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ type }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ profile_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: profiles
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the profiles resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the profiles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the profiles 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: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The Azure Region where the resource lives.
  - name: properties
    description: |
      The properties of the Traffic Manager profile.
    value:
      profileStatus: "{{ profileStatus }}"
      trafficRoutingMethod: "{{ trafficRoutingMethod }}"
      dnsConfig:
        relativeName: "{{ relativeName }}"
        fqdn: "{{ fqdn }}"
        ttl: {{ ttl }}
      monitorConfig:
        profileMonitorStatus: "{{ profileMonitorStatus }}"
        protocol: "{{ protocol }}"
        port: {{ port }}
        path: "{{ path }}"
        intervalInSeconds: {{ intervalInSeconds }}
        timeoutInSeconds: {{ timeoutInSeconds }}
        toleratedNumberOfFailures: {{ toleratedNumberOfFailures }}
        customHeaders:
          - name: "{{ name }}"
            value: "{{ value }}"
        expectedStatusCodeRanges:
          - min: {{ min }}
            max: {{ max }}
      endpoints:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            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 }}"
      trafficViewEnrollmentStatus: "{{ trafficViewEnrollmentStatus }}"
      allowedEndpointRecordTypes:
        - "{{ allowedEndpointRecordTypes }}"
      maxReturn: {{ maxReturn }}
      recordType: "{{ recordType }}"

UPDATE examples

update

Update a Traffic Manager profile.

UPDATE azure.traffic_manager.profiles
SET 
id = '{{ id }}',
name = '{{ name }}',
type = '{{ type }}',
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Create or update a Traffic Manager profile.

REPLACE azure.traffic_manager.profiles
SET 
id = '{{ id }}',
name = '{{ name }}',
type = '{{ type }}',
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a Traffic Manager profile.

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

Lifecycle Methods

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 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;