connection_policies

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

Overview

Name	connection_policies
Type	Resource
Id	azure.network.connection_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
associatedConnections	array	List of connection names (e.g. VpnConnection, HubVirtualNetworkConnection) associated with this ConnectionPolicy. These are resource names, not Azure resource IDs, consistent with the established VirtualWAN pattern used by HubRouteTable.associatedConnections.
enableInternetSecurity	boolean	Enable internet security.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the ConnectionPolicy resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routingConfiguration	object	The Routing Configuration indicating the associated and propagated route tables on this connection.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
associatedConnections	array	List of connection names (e.g. VpnConnection, HubVirtualNetworkConnection) associated with this ConnectionPolicy. These are resource names, not Azure resource IDs, consistent with the established VirtualWAN pattern used by HubRouteTable.associatedConnections.
enableInternetSecurity	boolean	Enable internet security.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the ConnectionPolicy resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routingConfiguration	object	The Routing Configuration indicating the associated and propagated route tables on this connection.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, virtual_hub_name, connection_policy_name, subscription_id		Retrieves the details of a ConnectionPolicy.
list	select	resource_group_name, virtual_hub_name, subscription_id		Retrieves the details of all ConnectionPolicies.
create_or_update	insert	resource_group_name, virtual_hub_name, connection_policy_name, subscription_id		Creates a ConnectionPolicy if it doesn't exist else updates the existing one.
create_or_update	replace	resource_group_name, virtual_hub_name, connection_policy_name, subscription_id		Creates a ConnectionPolicy if it doesn't exist else updates the existing one.
delete	delete	resource_group_name, virtual_hub_name, connection_policy_name, subscription_id		Deletes a ConnectionPolicy.

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
connection_policy_name	string	The name of the ConnectionPolicy that is unique within a VirtualHub. This name can be used to access the resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_hub_name	string	The name of the VirtualHub. Required.

SELECT examples

get

Retrieves the details of a ConnectionPolicy.

SELECT
id,
name,
associatedConnections,
enableInternetSecurity,
etag,
provisioningState,
routingConfiguration,
type
FROM azure.network.connection_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_hub_name = '{{ virtual_hub_name }}' -- required
AND connection_policy_name = '{{ connection_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Retrieves the details of all ConnectionPolicies.

SELECT
id,
name,
associatedConnections,
enableInternetSecurity,
etag,
provisioningState,
routingConfiguration,
type
FROM azure.network.connection_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_hub_name = '{{ virtual_hub_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a ConnectionPolicy if it doesn't exist else updates the existing one.

INSERT INTO azure.network.connection_policies (
id,
properties,
resource_group_name,
virtual_hub_name,
connection_policy_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ virtual_hub_name }}',
'{{ connection_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: connection_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the connection_policies resource.
  - name: virtual_hub_name
    value: "{{ virtual_hub_name }}"
    description: Required parameter for the connection_policies resource.
  - name: connection_policy_name
    value: "{{ connection_policy_name }}"
    description: Required parameter for the connection_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the connection_policies resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: properties
    description: |
      Properties of the ConnectionPolicy resource.
    value:
      enableInternetSecurity: {{ enableInternetSecurity }}
      routingConfiguration:
        associatedRouteTable:
          id: "{{ id }}"
        propagatedRouteTables:
          labels:
            - "{{ labels }}"
          ids:
            - id: "{{ id }}"
        vnetRoutes:
          staticRoutesConfig:
            propagateStaticRoutes: {{ propagateStaticRoutes }}
            vnetLocalRouteOverrideCriteria: "{{ vnetLocalRouteOverrideCriteria }}"
          staticRoutes:
            - name: "{{ name }}"
              addressPrefixes: "{{ addressPrefixes }}"
              nextHopIpAddress: "{{ nextHopIpAddress }}"
          bgpConnections:
            - id: "{{ id }}"
        inboundRouteMap:
          id: "{{ id }}"
        outboundRouteMap:
          id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"
      associatedConnections:
        - "{{ associatedConnections }}"

REPLACE examples

create_or_update

Creates a ConnectionPolicy if it doesn't exist else updates the existing one.

REPLACE azure.network.connection_policies
SET 
id = '{{ id }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hub_name = '{{ virtual_hub_name }}' --required
AND connection_policy_name = '{{ connection_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes a ConnectionPolicy.

DELETE FROM azure.network.connection_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hub_name = '{{ virtual_hub_name }}' --required
AND connection_policy_name = '{{ connection_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;