network_virtual_appliance_connections

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

Overview

Name	network_virtual_appliance_connections
Type	Resource
Id	azure.network.network_virtual_appliance_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource.
asn	integer	Network Virtual Appliance ASN.
bgpPeerAddress	array	List of bgpPeerAddresses for the NVA instances.
enableInternetSecurity	boolean	Enable internet security.
provisioningState	string	The provisioning state of the NetworkVirtualApplianceConnection 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.
tunnelIdentifier	integer	Unique identifier for the connection.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource.
asn	integer	Network Virtual Appliance ASN.
bgpPeerAddress	array	List of bgpPeerAddresses for the NVA instances.
enableInternetSecurity	boolean	Enable internet security.
provisioningState	string	The provisioning state of the NetworkVirtualApplianceConnection 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.
tunnelIdentifier	integer	Unique identifier for the connection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_virtual_appliance_name, connection_name, subscription_id		Retrieves the details of specified NVA connection.
list	select	resource_group_name, network_virtual_appliance_name, subscription_id		Lists NetworkVirtualApplianceConnections under the NVA.
create_or_update	insert	resource_group_name, network_virtual_appliance_name, connection_name, subscription_id		Creates a connection to Network Virtual Appliance, if it doesn't exist else updates the existing NVA connection'.
create_or_update	replace	resource_group_name, network_virtual_appliance_name, connection_name, subscription_id		Creates a connection to Network Virtual Appliance, if it doesn't exist else updates the existing NVA connection'.
delete	delete	resource_group_name, network_virtual_appliance_name, connection_name, subscription_id		Deletes a NVA connection.

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_name	string	Required.
network_virtual_appliance_name	string	The name of the Network Virtual Appliance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieves the details of specified NVA connection.

SELECT
id,
name,
asn,
bgpPeerAddress,
enableInternetSecurity,
provisioningState,
routingConfiguration,
tunnelIdentifier
FROM azure.network.network_virtual_appliance_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_virtual_appliance_name = '{{ network_virtual_appliance_name }}' -- required
AND connection_name = '{{ connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists NetworkVirtualApplianceConnections under the NVA.

SELECT
id,
name,
asn,
bgpPeerAddress,
enableInternetSecurity,
provisioningState,
routingConfiguration,
tunnelIdentifier
FROM azure.network.network_virtual_appliance_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_virtual_appliance_name = '{{ network_virtual_appliance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a connection to Network Virtual Appliance, if it doesn't exist else updates the existing NVA connection'.

INSERT INTO azure.network.network_virtual_appliance_connections (
id,
properties,
name,
resource_group_name,
network_virtual_appliance_name,
connection_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ properties }}',
'{{ name }}',
'{{ resource_group_name }}',
'{{ network_virtual_appliance_name }}',
'{{ connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties
;

Manifest

# Description fields are for documentation purposes
- name: network_virtual_appliance_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_virtual_appliance_connections resource.
  - name: network_virtual_appliance_name
    value: "{{ network_virtual_appliance_name }}"
    description: Required parameter for the network_virtual_appliance_connections resource.
  - name: connection_name
    value: "{{ connection_name }}"
    description: Required parameter for the network_virtual_appliance_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_virtual_appliance_connections resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: properties
    description: |
      Properties of the express route connection.
    value:
      name: "{{ name }}"
      provisioningState: "{{ provisioningState }}"
      asn: {{ asn }}
      tunnelIdentifier: {{ tunnelIdentifier }}
      bgpPeerAddress:
        - "{{ bgpPeerAddress }}"
      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 }}"
  - name: name
    value: "{{ name }}"
    description: |
      The name of the resource.

REPLACE examples

create_or_update

Creates a connection to Network Virtual Appliance, if it doesn't exist else updates the existing NVA connection'.

REPLACE azure.network.network_virtual_appliance_connections
SET 
id = '{{ id }}',
properties = '{{ properties }}',
name = '{{ name }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_virtual_appliance_name = '{{ network_virtual_appliance_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties;

DELETE examples

delete

Deletes a NVA connection.

DELETE FROM azure.network.network_virtual_appliance_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_virtual_appliance_name = '{{ network_virtual_appliance_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;