network_virtual_appliances

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

Overview

Name	network_virtual_appliances
Type	Resource
Id	azure.network.network_virtual_appliances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
additionalNics	array	Details required for Additional Network Interface. This property is not compatible with the NVA deployed in VNets.
addressPrefix	string	Address Prefix.
bootStrapConfigurationBlobs	array	BootStrapConfigurationBlobs storage URLs.
cloudInitConfiguration	string	CloudInitConfiguration string in plain text.
cloudInitConfigurationBlobs	array	CloudInitConfigurationBlob storage URLs.
delegation	object	The delegation for the Virtual Appliance. Only appliable for SaaS NVA.
deploymentType	string	The deployment type. PartnerManaged for the SaaS NVA.
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.
inboundSecurityRules	array	List of references to InboundSecurityRules.
internetIngressPublicIps	array	List of Resource Uri of Public IPs for Internet Ingress Scenario.
location	string	Resource location.
networkProfile	object	Network Profile containing configurations for Public and Private NIC.
nvaInterfaceConfigurations	array	The NVA in VNet interface configurations.
nvaSku	object	Network Virtual Appliance SKU.
partnerManagedResource	object	The delegation for the Virtual Appliance.
privateIpAddress	string	A Internal Load Balancer's HA port frontend IP address. Can be used to set routes & UDR to load balance traffic between NVA instances.
provisioningState	string	The provisioning state of the resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
sshPublicKey	string	Public key for SSH login.
tags	object	Resource tags.
type	string	Resource type.
virtualApplianceAsn	integer	VirtualAppliance ASN. Microsoft private, public and IANA reserved ASN are not supported.
virtualApplianceConnections	array	List of references to VirtualApplianceConnections.
virtualApplianceNics	array	List of Virtual Appliance Network Interfaces.
virtualApplianceSites	array	List of references to VirtualApplianceSite.
virtualHub	object	Reference to another subresource.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
additionalNics	array	Details required for Additional Network Interface. This property is not compatible with the NVA deployed in VNets.
addressPrefix	string	Address Prefix.
bootStrapConfigurationBlobs	array	BootStrapConfigurationBlobs storage URLs.
cloudInitConfiguration	string	CloudInitConfiguration string in plain text.
cloudInitConfigurationBlobs	array	CloudInitConfigurationBlob storage URLs.
delegation	object	The delegation for the Virtual Appliance. Only appliable for SaaS NVA.
deploymentType	string	The deployment type. PartnerManaged for the SaaS NVA.
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.
inboundSecurityRules	array	List of references to InboundSecurityRules.
internetIngressPublicIps	array	List of Resource Uri of Public IPs for Internet Ingress Scenario.
location	string	Resource location.
networkProfile	object	Network Profile containing configurations for Public and Private NIC.
nvaInterfaceConfigurations	array	The NVA in VNet interface configurations.
nvaSku	object	Network Virtual Appliance SKU.
partnerManagedResource	object	The delegation for the Virtual Appliance.
privateIpAddress	string	A Internal Load Balancer's HA port frontend IP address. Can be used to set routes & UDR to load balance traffic between NVA instances.
provisioningState	string	The provisioning state of the resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
sshPublicKey	string	Public key for SSH login.
tags	object	Resource tags.
type	string	Resource type.
virtualApplianceAsn	integer	VirtualAppliance ASN. Microsoft private, public and IANA reserved ASN are not supported.
virtualApplianceConnections	array	List of references to VirtualApplianceConnections.
virtualApplianceNics	array	List of Virtual Appliance Network Interfaces.
virtualApplianceSites	array	List of references to VirtualApplianceSite.
virtualHub	object	Reference to another subresource.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
additionalNics	array	Details required for Additional Network Interface. This property is not compatible with the NVA deployed in VNets.
addressPrefix	string	Address Prefix.
bootStrapConfigurationBlobs	array	BootStrapConfigurationBlobs storage URLs.
cloudInitConfiguration	string	CloudInitConfiguration string in plain text.
cloudInitConfigurationBlobs	array	CloudInitConfigurationBlob storage URLs.
delegation	object	The delegation for the Virtual Appliance. Only appliable for SaaS NVA.
deploymentType	string	The deployment type. PartnerManaged for the SaaS NVA.
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.
inboundSecurityRules	array	List of references to InboundSecurityRules.
internetIngressPublicIps	array	List of Resource Uri of Public IPs for Internet Ingress Scenario.
location	string	Resource location.
networkProfile	object	Network Profile containing configurations for Public and Private NIC.
nvaInterfaceConfigurations	array	The NVA in VNet interface configurations.
nvaSku	object	Network Virtual Appliance SKU.
partnerManagedResource	object	The delegation for the Virtual Appliance.
privateIpAddress	string	A Internal Load Balancer's HA port frontend IP address. Can be used to set routes & UDR to load balance traffic between NVA instances.
provisioningState	string	The provisioning state of the resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
sshPublicKey	string	Public key for SSH login.
tags	object	Resource tags.
type	string	Resource type.
virtualApplianceAsn	integer	VirtualAppliance ASN. Microsoft private, public and IANA reserved ASN are not supported.
virtualApplianceConnections	array	List of references to VirtualApplianceConnections.
virtualApplianceNics	array	List of Virtual Appliance Network Interfaces.
virtualApplianceSites	array	List of references to VirtualApplianceSite.
virtualHub	object	Reference to another subresource.

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, subscription_id	$expand	Gets the specified Network Virtual Appliance.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all Network Virtual Appliances in a resource group.
list	select	subscription_id		Gets all Network Virtual Appliances in a subscription.
create_or_update	insert	resource_group_name, network_virtual_appliance_name, subscription_id		Creates or updates the specified Network Virtual Appliance.
update_tags	update	resource_group_name, network_virtual_appliance_name, subscription_id		Updates a Network Virtual Appliance.
create_or_update	replace	resource_group_name, network_virtual_appliance_name, subscription_id		Creates or updates the specified Network Virtual Appliance.
delete	delete	resource_group_name, network_virtual_appliance_name, subscription_id		Deletes the specified Network Virtual Appliance.
get_boot_diagnostic_logs	exec	resource_group_name, network_virtual_appliance_name, subscription_id		Retrieves the boot diagnostic logs for a VM instance belonging to the specified Network Virtual Appliance.
restart	exec	resource_group_name, network_virtual_appliance_name, subscription_id		Restarts one or more VMs belonging to the specified Network Virtual Appliance.
reimage	exec	resource_group_name, network_virtual_appliance_name, subscription_id		Reimages one VM 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
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.
subscription_id	string
$expand	string	Expands referenced resources. Default value is None.

SELECT examples

get

Gets the specified Network Virtual Appliance.

SELECT
id,
name,
additionalNics,
addressPrefix,
bootStrapConfigurationBlobs,
cloudInitConfiguration,
cloudInitConfigurationBlobs,
delegation,
deploymentType,
etag,
identity,
inboundSecurityRules,
internetIngressPublicIps,
location,
networkProfile,
nvaInterfaceConfigurations,
nvaSku,
partnerManagedResource,
privateIpAddress,
provisioningState,
sshPublicKey,
tags,
type,
virtualApplianceAsn,
virtualApplianceConnections,
virtualApplianceNics,
virtualApplianceSites,
virtualHub
FROM azure.network.network_virtual_appliances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_virtual_appliance_name = '{{ network_virtual_appliance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Lists all Network Virtual Appliances in a resource group.

SELECT
id,
name,
additionalNics,
addressPrefix,
bootStrapConfigurationBlobs,
cloudInitConfiguration,
cloudInitConfigurationBlobs,
delegation,
deploymentType,
etag,
identity,
inboundSecurityRules,
internetIngressPublicIps,
location,
networkProfile,
nvaInterfaceConfigurations,
nvaSku,
partnerManagedResource,
privateIpAddress,
provisioningState,
sshPublicKey,
tags,
type,
virtualApplianceAsn,
virtualApplianceConnections,
virtualApplianceNics,
virtualApplianceSites,
virtualHub
FROM azure.network.network_virtual_appliances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all Network Virtual Appliances in a subscription.

SELECT
id,
name,
additionalNics,
addressPrefix,
bootStrapConfigurationBlobs,
cloudInitConfiguration,
cloudInitConfigurationBlobs,
delegation,
deploymentType,
etag,
identity,
inboundSecurityRules,
internetIngressPublicIps,
location,
networkProfile,
nvaInterfaceConfigurations,
nvaSku,
partnerManagedResource,
privateIpAddress,
provisioningState,
sshPublicKey,
tags,
type,
virtualApplianceAsn,
virtualApplianceConnections,
virtualApplianceNics,
virtualApplianceSites,
virtualHub
FROM azure.network.network_virtual_appliances
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified Network Virtual Appliance.

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

Manifest

# Description fields are for documentation purposes
- name: network_virtual_appliances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_virtual_appliances resource.
  - name: network_virtual_appliance_name
    value: "{{ network_virtual_appliance_name }}"
    description: Required parameter for the network_virtual_appliances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_virtual_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 Network Virtual Appliance.
    value:
      nvaSku:
        vendor: "{{ vendor }}"
        bundledScaleUnit: "{{ bundledScaleUnit }}"
        marketPlaceVersion: "{{ marketPlaceVersion }}"
      addressPrefix: "{{ addressPrefix }}"
      bootStrapConfigurationBlobs:
        - "{{ bootStrapConfigurationBlobs }}"
      virtualHub:
        id: "{{ id }}"
      cloudInitConfigurationBlobs:
        - "{{ cloudInitConfigurationBlobs }}"
      cloudInitConfiguration: "{{ cloudInitConfiguration }}"
      virtualApplianceAsn: {{ virtualApplianceAsn }}
      sshPublicKey: "{{ sshPublicKey }}"
      virtualApplianceNics:
        - nicType: "{{ nicType }}"
          name: "{{ name }}"
          publicIpAddress: "{{ publicIpAddress }}"
          privateIpAddress: "{{ privateIpAddress }}"
          instanceName: "{{ instanceName }}"
      networkProfile:
        networkInterfaceConfigurations:
          - type: "{{ type }}"
            properties:
              ipConfigurations:
                - name: "{{ name }}"
                  properties:
                    primary: {{ primary }}
      additionalNics:
        - name: "{{ name }}"
          hasPublicIp: {{ hasPublicIp }}
      internetIngressPublicIps:
        - id: "{{ id }}"
      virtualApplianceSites:
        - id: "{{ id }}"
      virtualApplianceConnections:
        - id: "{{ id }}"
      inboundSecurityRules:
        - id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"
      deploymentType: "{{ deploymentType }}"
      delegation:
        serviceName: "{{ serviceName }}"
        provisioningState: "{{ provisioningState }}"
      partnerManagedResource:
        id: "{{ id }}"
        internalLoadBalancerId: "{{ internalLoadBalancerId }}"
        standardLoadBalancerId: "{{ standardLoadBalancerId }}"
      nvaInterfaceConfigurations:
        - subnet:
            id: "{{ id }}"
          type: "{{ type }}"
          name: "{{ name }}"
      privateIpAddress: "{{ privateIpAddress }}"
  - name: identity
    description: |
      The service principal that has read access to cloud-init and config blob.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update_tags

Updates a Network Virtual Appliance.

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

REPLACE examples

create_or_update

Creates or updates the specified Network Virtual Appliance.

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

DELETE examples

delete

Deletes the specified Network Virtual Appliance.

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

Lifecycle Methods

get_boot_diagnostic_logs

Retrieves the boot diagnostic logs for a VM instance belonging to the specified Network Virtual Appliance.

EXEC azure.network.network_virtual_appliances.get_boot_diagnostic_logs 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_virtual_appliance_name='{{ network_virtual_appliance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"instanceId": {{ instanceId }}, 
"serialConsoleStorageSasUrl": "{{ serialConsoleStorageSasUrl }}", 
"consoleScreenshotStorageSasUrl": "{{ consoleScreenshotStorageSasUrl }}"
}'
;

restart

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

EXEC azure.network.network_virtual_appliances.restart 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_virtual_appliance_name='{{ network_virtual_appliance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"instanceIds": "{{ instanceIds }}"
}'
;

reimage

Reimages one VM belonging to the specified Network Virtual Appliance.

EXEC azure.network.network_virtual_appliances.reimage 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_virtual_appliance_name='{{ network_virtual_appliance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"instanceIds": "{{ instanceIds }}"
}'
;