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

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
addressPrefix	string	Address Prefix.
etag	string	A unique read-only string that changes whenever the resource is updated.
o365Policy	object	Office 365 Policy.
provisioningState	string	The provisioning state of the resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
addressPrefix	string	Address Prefix.
etag	string	A unique read-only string that changes whenever the resource is updated.
o365Policy	object	Office 365 Policy.
provisioningState	string	The provisioning state of the resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
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, network_virtual_appliance_name, site_name, subscription_id		Gets the specified Virtual Appliance Site.
list	select	resource_group_name, network_virtual_appliance_name, subscription_id		Lists all Network Virtual Appliance Sites in a Network Virtual Appliance resource.
create_or_update	insert	resource_group_name, network_virtual_appliance_name, site_name, subscription_id		Creates or updates the specified Network Virtual Appliance Site.
create_or_update	replace	resource_group_name, network_virtual_appliance_name, site_name, subscription_id		Creates or updates the specified Network Virtual Appliance Site.
delete	delete	resource_group_name, network_virtual_appliance_name, site_name, subscription_id		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
network_virtual_appliance_name	string	The name of Network Virtual Appliance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
site_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
subscription_id	string

SELECT examples

get

Gets the specified Virtual Appliance Site.

SELECT
id,
name,
addressPrefix,
etag,
o365Policy,
provisioningState,
type
FROM azure.network.virtual_appliance_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_virtual_appliance_name = '{{ network_virtual_appliance_name }}' -- required
AND site_name = '{{ site_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
addressPrefix,
etag,
o365Policy,
provisioningState,
type
FROM azure.network.virtual_appliance_sites
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 or updates the specified Network Virtual Appliance Site.

INSERT INTO azure.network.virtual_appliance_sites (
id,
name,
properties,
resource_group_name,
network_virtual_appliance_name,
site_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_virtual_appliance_name }}',
'{{ site_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_appliance_sites
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_appliance_sites resource.
  - name: network_virtual_appliance_name
    value: "{{ network_virtual_appliance_name }}"
    description: Required parameter for the virtual_appliance_sites resource.
  - name: site_name
    value: "{{ site_name }}"
    description: Required parameter for the virtual_appliance_sites resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_appliance_sites resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      The properties of the Virtual Appliance Sites.
    value:
      addressPrefix: "{{ addressPrefix }}"
      o365Policy:
        breakOutCategories:
          allow: {{ allow }}
          optimize: {{ optimize }}
          default: {{ default }}
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates the specified Network Virtual Appliance Site.

REPLACE azure.network.virtual_appliance_sites
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_virtual_appliance_name = '{{ network_virtual_appliance_name }}' --required
AND site_name = '{{ site_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes the specified site from a Virtual Appliance.

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