traffic_controller_interface

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

Overview

Name	traffic_controller_interface
Type	Resource
Id	azure.service_networking.traffic_controller_interface

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/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
associations	array	Associations References List.
configurationEndpoints	array	Configuration Endpoints.
frontends	array	Frontends References List.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Provisioning", "Updating", "Deleting", "Accepted", "Succeeded", "Failed", and "Canceled". (Provisioning, Updating, Deleting, Accepted, Succeeded, Failed, Canceled)
securityPolicies	array	Security Policies References List.
securityPolicyConfigurations	object	Security Policy Configuration.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
associations	array	Associations References List.
configurationEndpoints	array	Configuration Endpoints.
frontends	array	Frontends References List.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Provisioning", "Updating", "Deleting", "Accepted", "Succeeded", "Failed", and "Canceled". (Provisioning, Updating, Deleting, Accepted, Succeeded, Failed, Canceled)
securityPolicies	array	Security Policies References List.
securityPolicyConfigurations	object	Security Policy Configuration.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
associations	array	Associations References List.
configurationEndpoints	array	Configuration Endpoints.
frontends	array	Frontends References List.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Provisioning", "Updating", "Deleting", "Accepted", "Succeeded", "Failed", and "Canceled". (Provisioning, Updating, Deleting, Accepted, Succeeded, Failed, Canceled)
securityPolicies	array	Security Policies References List.
securityPolicyConfigurations	object	Security Policy Configuration.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, traffic_controller_name, subscription_id		Get a TrafficController.
list_by_resource_group	select	resource_group_name, subscription_id		List TrafficController resources by resource group.
list_by_subscription	select	subscription_id		List TrafficController resources by subscription ID.
create_or_update	insert	resource_group_name, traffic_controller_name, subscription_id, location		Create a TrafficController.
update	update	resource_group_name, traffic_controller_name, subscription_id		Update a TrafficController.
create_or_update	replace	resource_group_name, traffic_controller_name, subscription_id, location		Create a TrafficController.
delete	delete	resource_group_name, traffic_controller_name, subscription_id		Delete a TrafficController.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
traffic_controller_name	string	traffic controller name for path. Required.

SELECT examples

get

Get a TrafficController.

SELECT
id,
name,
associations,
configurationEndpoints,
frontends,
location,
provisioningState,
securityPolicies,
securityPolicyConfigurations,
systemData,
tags,
type
FROM azure.service_networking.traffic_controller_interface
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND traffic_controller_name = '{{ traffic_controller_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List TrafficController resources by resource group.

SELECT
id,
name,
associations,
configurationEndpoints,
frontends,
location,
provisioningState,
securityPolicies,
securityPolicyConfigurations,
systemData,
tags,
type
FROM azure.service_networking.traffic_controller_interface
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List TrafficController resources by subscription ID.

SELECT
id,
name,
associations,
configurationEndpoints,
frontends,
location,
provisioningState,
securityPolicies,
securityPolicyConfigurations,
systemData,
tags,
type
FROM azure.service_networking.traffic_controller_interface
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a TrafficController.

INSERT INTO azure.service_networking.traffic_controller_interface (
tags,
location,
properties,
resource_group_name,
traffic_controller_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ traffic_controller_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: traffic_controller_interface
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the traffic_controller_interface resource.
  - name: traffic_controller_name
    value: "{{ traffic_controller_name }}"
    description: Required parameter for the traffic_controller_interface resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the traffic_controller_interface resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      configurationEndpoints:
        - "{{ configurationEndpoints }}"
      frontends:
        - id: "{{ id }}"
      associations:
        - id: "{{ id }}"
      securityPolicies:
        - id: "{{ id }}"
      securityPolicyConfigurations:
        wafSecurityPolicy:
          id: "{{ id }}"
        ipAccessRulesSecurityPolicy:
          id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a TrafficController.

UPDATE azure.service_networking.traffic_controller_interface
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND traffic_controller_name = '{{ traffic_controller_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a TrafficController.

REPLACE azure.service_networking.traffic_controller_interface
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND traffic_controller_name = '{{ traffic_controller_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a TrafficController.

DELETE FROM azure.service_networking.traffic_controller_interface
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND traffic_controller_name = '{{ traffic_controller_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;