associations_interface

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

Overview

Name	associations_interface
Type	Resource
Id	azure.service_networking.associations_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.
associationType	string	Association Type. Required. "subnets" (subnets)
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning State of Traffic Controller Association Resource. Known values are: "Provisioning", "Updating", "Deleting", "Accepted", "Succeeded", "Failed", and "Canceled". (Provisioning, Updating, Deleting, Accepted, Succeeded, Failed, Canceled)
subnet	object	Association Subnet.
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_traffic_controller

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.
associationType	string	Association Type. Required. "subnets" (subnets)
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning State of Traffic Controller Association Resource. Known values are: "Provisioning", "Updating", "Deleting", "Accepted", "Succeeded", "Failed", and "Canceled". (Provisioning, Updating, Deleting, Accepted, Succeeded, Failed, Canceled)
subnet	object	Association Subnet.
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, association_name, subscription_id		Get a Association.
list_by_traffic_controller	select	resource_group_name, traffic_controller_name, subscription_id		List Association resources by TrafficController.
create_or_update	insert	resource_group_name, traffic_controller_name, association_name, subscription_id, location		Create a Association.
update	update	resource_group_name, traffic_controller_name, association_name, subscription_id		Update a Association.
create_or_update	replace	resource_group_name, traffic_controller_name, association_name, subscription_id, location		Create a Association.
delete	delete	resource_group_name, traffic_controller_name, association_name, subscription_id		Delete a Association.

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
association_name	string	Name of Association. Required.
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 Association.

SELECT
id,
name,
associationType,
location,
provisioningState,
subnet,
systemData,
tags,
type
FROM azure.service_networking.associations_interface
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND traffic_controller_name = '{{ traffic_controller_name }}' -- required
AND association_name = '{{ association_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_traffic_controller

List Association resources by TrafficController.

SELECT
id,
name,
associationType,
location,
provisioningState,
subnet,
systemData,
tags,
type
FROM azure.service_networking.associations_interface
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND traffic_controller_name = '{{ traffic_controller_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Association.

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

Manifest

# Description fields are for documentation purposes
- name: associations_interface
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the associations_interface resource.
  - name: traffic_controller_name
    value: "{{ traffic_controller_name }}"
    description: Required parameter for the associations_interface resource.
  - name: association_name
    value: "{{ association_name }}"
    description: Required parameter for the associations_interface resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the associations_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:
      associationType: "{{ associationType }}"
      subnet:
        id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a Association.

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

REPLACE examples

create_or_update

Create a Association.

REPLACE azure.service_networking.associations_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 association_name = '{{ association_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 Association.

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