virtual_network_appliances

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

Overview

Name	virtual_network_appliances
Type	Resource
Id	azure.network.virtual_network_appliances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
bandwidthInGbps	number	Bandwidth of the VirtualNetworkAppliance resource in Gbps.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipConfigurations	array	A list of IPConfigurations of the virtual network appliance.
location	string	Resource location.
privateIPAddressVersion	string	Whether the specific virtual network appliance is IPv4 or Dual Stack. Default is IPv4. Known values are: "IPv4" and "DualStack". (IPv4, DualStack)
provisioningState	string	The provisioning state of the virtual network appliance resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the virtual network appliance resource.
subnet	object	Subnet in a virtual network resource.
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
bandwidthInGbps	number	Bandwidth of the VirtualNetworkAppliance resource in Gbps.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipConfigurations	array	A list of IPConfigurations of the virtual network appliance.
location	string	Resource location.
privateIPAddressVersion	string	Whether the specific virtual network appliance is IPv4 or Dual Stack. Default is IPv4. Known values are: "IPv4" and "DualStack". (IPv4, DualStack)
provisioningState	string	The provisioning state of the virtual network appliance resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the virtual network appliance resource.
subnet	object	Subnet in a virtual network resource.
tags	object	Resource tags.
type	string	Resource type.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
bandwidthInGbps	number	Bandwidth of the VirtualNetworkAppliance resource in Gbps.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipConfigurations	array	A list of IPConfigurations of the virtual network appliance.
location	string	Resource location.
privateIPAddressVersion	string	Whether the specific virtual network appliance is IPv4 or Dual Stack. Default is IPv4. Known values are: "IPv4" and "DualStack". (IPv4, DualStack)
provisioningState	string	The provisioning state of the virtual network appliance resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the virtual network appliance resource.
subnet	object	Subnet in a virtual network resource.
tags	object	Resource tags.
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_network_appliance_name, subscription_id		Gets information about the specified virtual network appliance.
list	select	resource_group_name, subscription_id		Gets all virtual network appliances in a resource group.
list_all	select	subscription_id		Gets all virtual network appliances in a subscription.
create_or_update	insert	resource_group_name, virtual_network_appliance_name, subscription_id		Creates or updates a virtual network appliance.
update_tags	update	resource_group_name, virtual_network_appliance_name, subscription_id		Updates a virtual network appliance tags.
create_or_update	replace	resource_group_name, virtual_network_appliance_name, subscription_id		Creates or updates a virtual network appliance.
delete	delete	resource_group_name, virtual_network_appliance_name, subscription_id		Deletes the specified virtual network appliance.

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
virtual_network_appliance_name	string	The name of the virtual network appliance. Required.

SELECT examples

get

Gets information about the specified virtual network appliance.

SELECT
id,
name,
bandwidthInGbps,
etag,
ipConfigurations,
location,
privateIPAddressVersion,
provisioningState,
resourceGuid,
subnet,
tags,
type
FROM azure.network.virtual_network_appliances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_network_appliance_name = '{{ virtual_network_appliance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all virtual network appliances in a resource group.

SELECT
id,
name,
bandwidthInGbps,
etag,
ipConfigurations,
location,
privateIPAddressVersion,
provisioningState,
resourceGuid,
subnet,
tags,
type
FROM azure.network.virtual_network_appliances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all virtual network appliances in a subscription.

SELECT
id,
name,
bandwidthInGbps,
etag,
ipConfigurations,
location,
privateIPAddressVersion,
provisioningState,
resourceGuid,
subnet,
tags,
type
FROM azure.network.virtual_network_appliances
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a virtual network appliance.

INSERT INTO azure.network.virtual_network_appliances (
id,
location,
tags,
properties,
resource_group_name,
virtual_network_appliance_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ virtual_network_appliance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_appliances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_network_appliances resource.
  - name: virtual_network_appliance_name
    value: "{{ virtual_network_appliance_name }}"
    description: Required parameter for the virtual_network_appliances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_network_appliances resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the virtual network appliance.
    value:
      bandwidthInGbps: {{ bandwidthInGbps }}
      ipConfigurations:
        - id: "{{ id }}"
          properties:
            privateIPAddress: "{{ privateIPAddress }}"
            privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
            primary: {{ primary }}
            provisioningState: "{{ provisioningState }}"
            privateIPAddressVersion: "{{ privateIPAddressVersion }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      privateIPAddressVersion: "{{ privateIPAddressVersion }}"
      provisioningState: "{{ provisioningState }}"
      resourceGuid: "{{ resourceGuid }}"
      subnet:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        properties:
          addressPrefix: "{{ addressPrefix }}"
          addressPrefixes:
            - "{{ addressPrefixes }}"
          networkSecurityGroup:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            location: "{{ location }}"
            tags: "{{ tags }}"
            properties:
              flushConnection: {{ flushConnection }}
              securityRules: "{{ securityRules }}"
              defaultSecurityRules: "{{ defaultSecurityRules }}"
              networkInterfaces: "{{ networkInterfaces }}"
              subnets: "{{ subnets }}"
              flowLogs: "{{ flowLogs }}"
              resourceGuid: "{{ resourceGuid }}"
              provisioningState: "{{ provisioningState }}"
            etag: "{{ etag }}"
          routeTable:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            location: "{{ location }}"
            tags: "{{ tags }}"
            properties:
              routes: "{{ routes }}"
              subnets: "{{ subnets }}"
              disableBgpRoutePropagation: {{ disableBgpRoutePropagation }}
              disablePeeringRoute: "{{ disablePeeringRoute }}"
              provisioningState: "{{ provisioningState }}"
              resourceGuid: "{{ resourceGuid }}"
            etag: "{{ etag }}"
          natGateway:
            id: "{{ id }}"
          serviceEndpoints:
            - service: "{{ service }}"
              networkIdentifier:
                id: "{{ id }}"
              locations: "{{ locations }}"
              provisioningState: "{{ provisioningState }}"
          serviceEndpointPolicies:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                serviceEndpointPolicyDefinitions: "{{ serviceEndpointPolicyDefinitions }}"
                subnets: "{{ subnets }}"
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
                serviceAlias: "{{ serviceAlias }}"
                contextualServiceEndpointPolicies: "{{ contextualServiceEndpointPolicies }}"
              etag: "{{ etag }}"
              kind: "{{ kind }}"
          privateEndpoints:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                subnet: "{{ subnet }}"
                networkInterfaces: "{{ networkInterfaces }}"
                provisioningState: "{{ provisioningState }}"
                ipVersionType: "{{ ipVersionType }}"
                privateLinkServiceConnections: "{{ privateLinkServiceConnections }}"
                manualPrivateLinkServiceConnections: "{{ manualPrivateLinkServiceConnections }}"
                customDnsConfigs: "{{ customDnsConfigs }}"
                applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                ipConfigurations: "{{ ipConfigurations }}"
                customNetworkInterfaceName: "{{ customNetworkInterfaceName }}"
                billingSku: "{{ billingSku }}"
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              etag: "{{ etag }}"
          ipConfigurations:
            - id: "{{ id }}"
              properties:
                privateIPAddress: "{{ privateIPAddress }}"
                privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                subnet: "{{ subnet }}"
                publicIPAddress: "{{ publicIPAddress }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
          ipConfigurationProfiles:
            - id: "{{ id }}"
              properties:
                subnet: "{{ subnet }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              type: "{{ type }}"
              etag: "{{ etag }}"
          ipAllocations:
            - id: "{{ id }}"
          resourceNavigationLinks:
            - id: "{{ id }}"
              properties:
                linkedResourceType: "{{ linkedResourceType }}"
                link: "{{ link }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
              type: "{{ type }}"
          serviceAssociationLinks:
            - id: "{{ id }}"
              properties:
                linkedResourceType: "{{ linkedResourceType }}"
                link: "{{ link }}"
                provisioningState: "{{ provisioningState }}"
                allowDelete: {{ allowDelete }}
                locations: "{{ locations }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
              type: "{{ type }}"
          delegations:
            - id: "{{ id }}"
              properties:
                serviceName: "{{ serviceName }}"
                actions: "{{ actions }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
              type: "{{ type }}"
          purpose: "{{ purpose }}"
          provisioningState: "{{ provisioningState }}"
          privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
          privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
          applicationGatewayIPConfigurations:
            - id: "{{ id }}"
              properties:
                subnet: "{{ subnet }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
              type: "{{ type }}"
          sharingScope: "{{ sharingScope }}"
          defaultOutboundAccess: {{ defaultOutboundAccess }}
          ipamPoolPrefixAllocations:
            - pool:
                id: "{{ id }}"
              numberOfIpAddresses: "{{ numberOfIpAddresses }}"
              allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
          serviceGateway:
            id: "{{ id }}"
        etag: "{{ etag }}"

UPDATE examples

update_tags

Updates a virtual network appliance tags.

UPDATE azure.network.virtual_network_appliances
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_appliance_name = '{{ virtual_network_appliance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a virtual network appliance.

REPLACE azure.network.virtual_network_appliances
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_appliance_name = '{{ virtual_network_appliance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified virtual network appliance.

DELETE FROM azure.network.virtual_network_appliances
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_appliance_name = '{{ virtual_network_appliance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;