virtual_appliances

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

Overview

Name	virtual_appliances
Type	Resource
Id	azure.network.virtual_appliances

Fields

The following fields are returned by SELECT queries:

get

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

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The service principal that has read access to cloud-init and config blob.
properties	object	Properties of the Network Virtual Appliance.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

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

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The service principal that has read access to cloud-init and config blob.
properties	object	Properties of the Network Virtual Appliance.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

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

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The service principal that has read access to cloud-init and config blob.
properties	object	Properties of the Network Virtual Appliance.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, networkVirtualApplianceName, subscriptionId	$expand	Gets the specified Network Virtual Appliance.
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all Network Virtual Appliances in a resource group.
list	select	subscriptionId		Gets all Network Virtual Appliances in a subscription.
create_or_update	insert	resourceGroupName, networkVirtualApplianceName, subscriptionId		Creates or updates the specified Network Virtual Appliance.
delete	delete	resourceGroupName, networkVirtualApplianceName, subscriptionId		Deletes the specified Network Virtual Appliance.
update_tags	exec	subscriptionId, resourceGroupName, networkVirtualApplianceName		Updates a Network Virtual Appliance.
restart	exec	resourceGroupName, networkVirtualApplianceName, subscriptionId		Restarts one or more VMs belonging to the specified Network 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 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.
$expand	string	Expands referenced resources.

SELECT examples

get

Gets the specified Network Virtual Appliance.

SELECT
id,
name,
etag,
identity,
properties,
systemData,
type
FROM azure.network.virtual_appliances
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkVirtualApplianceName = '{{ networkVirtualApplianceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Lists all Network Virtual Appliances in a resource group.

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

list

Gets all Network Virtual Appliances in a subscription.

SELECT
id,
name,
etag,
identity,
properties,
systemData,
type
FROM azure.network.virtual_appliances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified Network Virtual Appliance.

INSERT INTO azure.network.virtual_appliances (
data__properties,
data__identity,
resourceGroupName,
networkVirtualApplianceName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ resourceGroupName }}',
'{{ networkVirtualApplianceName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
identity,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_appliances
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_appliances resource.
    - name: networkVirtualApplianceName
      value: string
      description: Required parameter for the virtual_appliances resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_appliances resource.
    - name: properties
      value: object
      description: |
        Properties of the Network Virtual Appliance.
    - name: identity
      value: object
      description: |
        The service principal that has read access to cloud-init and config blob.

DELETE examples

delete

Deletes the specified Network Virtual Appliance.

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

Lifecycle Methods

update_tags

Updates a Network Virtual Appliance.

EXEC azure.network.virtual_appliances.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkVirtualApplianceName='{{ networkVirtualApplianceName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

restart

Restarts one or more VMs belonging to the specified Network Virtual Appliance.

EXEC azure.network.virtual_appliances.restart 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkVirtualApplianceName='{{ networkVirtualApplianceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"instanceIds": "{{ instanceIds }}"
}'
;