virtual_appliance_connections

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

Overview

Name	virtual_appliance_connections
Type	Resource
Id	azure.network.virtual_appliance_connections

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the details of the NVA connection

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource.
properties	object	Properties of the express route connection.

list

Request successful. Lists all the NVA connections under an NVA.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource.
properties	object	Properties of the express route connection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, networkVirtualApplianceName, connectionName		Retrieves the details of specified NVA connection.
list	select	subscriptionId, resourceGroupName, networkVirtualApplianceName		Lists NetworkVirtualApplianceConnections under the NVA.
create_or_update	insert	subscriptionId, resourceGroupName, networkVirtualApplianceName, connectionName		Creates a connection to Network Virtual Appliance, if it doesn't exist else updates the existing NVA connection'
delete	delete	subscriptionId, resourceGroupName, networkVirtualApplianceName, connectionName		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
connectionName	string	The name of the NVA connection.
networkVirtualApplianceName	string	The name of the Network Virtual Appliance.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Retrieves the details of specified NVA connection.

SELECT
id,
name,
properties
FROM azure.network.virtual_appliance_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkVirtualApplianceName = '{{ networkVirtualApplianceName }}' -- required
AND connectionName = '{{ connectionName }}' -- required
;

list

Lists NetworkVirtualApplianceConnections under the NVA.

SELECT
id,
name,
properties
FROM azure.network.virtual_appliance_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkVirtualApplianceName = '{{ networkVirtualApplianceName }}' -- 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.virtual_appliance_connections (
data__properties,
data__name,
data__id,
subscriptionId,
resourceGroupName,
networkVirtualApplianceName,
connectionName
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ networkVirtualApplianceName }}',
'{{ connectionName }}'
RETURNING
id,
name,
properties
;

Manifest

# Description fields are for documentation purposes
- name: virtual_appliance_connections
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_appliance_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_appliance_connections resource.
    - name: networkVirtualApplianceName
      value: string
      description: Required parameter for the virtual_appliance_connections resource.
    - name: connectionName
      value: string
      description: Required parameter for the virtual_appliance_connections resource.
    - name: properties
      value: object
      description: |
        Properties of the express route connection.
    - name: name
      value: string
      description: |
        The name of the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes a NVA connection.

DELETE FROM azure.network.virtual_appliance_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND networkVirtualApplianceName = '{{ networkVirtualApplianceName }}' --required
AND connectionName = '{{ connectionName }}' --required
;