virtual_appliance_sites

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

Overview

Name	virtual_appliance_sites
Type	Resource
Id	azure.network.virtual_appliance_sites

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns a Network Virtual Appliance Site resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the virtual appliance site.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The properties of the Virtual Appliance Sites.
type	string	Site type.

list

Success. The operation returns a list of Network Virtual Appliance site resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the virtual appliance site.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The properties of the Virtual Appliance Sites.
type	string	Site type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, networkVirtualApplianceName, siteName, subscriptionId		Gets the specified Virtual Appliance Site.
list	select	resourceGroupName, networkVirtualApplianceName, subscriptionId		Lists all Network Virtual Appliance Sites in a Network Virtual Appliance resource.
create_or_update	insert	resourceGroupName, networkVirtualApplianceName, siteName, subscriptionId		Creates or updates the specified Network Virtual Appliance Site.
delete	delete	resourceGroupName, networkVirtualApplianceName, siteName, subscriptionId		Deletes the specified site from a Virtual 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
networkVirtualApplianceName	string	The name of the Network Virtual Appliance.
resourceGroupName	string	The name of the resource group.
siteName	string	The name of the site.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the specified Virtual Appliance Site.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.virtual_appliance_sites
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkVirtualApplianceName = '{{ networkVirtualApplianceName }}' -- required
AND siteName = '{{ siteName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all Network Virtual Appliance Sites in a Network Virtual Appliance resource.

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

INSERT examples

create_or_update

Creates or updates the specified Network Virtual Appliance Site.

INSERT INTO azure.network.virtual_appliance_sites (
data__properties,
data__name,
data__id,
resourceGroupName,
networkVirtualApplianceName,
siteName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ networkVirtualApplianceName }}',
'{{ siteName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_appliance_sites
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_appliance_sites resource.
    - name: networkVirtualApplianceName
      value: string
      description: Required parameter for the virtual_appliance_sites resource.
    - name: siteName
      value: string
      description: Required parameter for the virtual_appliance_sites resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_appliance_sites resource.
    - name: properties
      value: object
      description: |
        The properties of the Virtual Appliance Sites.
    - name: name
      value: string
      description: |
        Name of the virtual appliance site.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified site from a Virtual Appliance.

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