virtual_appliances

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

Overview

Name	virtual_appliances
Type	Resource
Id	azure.network.virtual_appliances

Fields

vw_virtual_appliances

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
additional_nics	text	field from the properties object
address_prefix	text	field from the properties object
boot_strap_configuration_blobs	text	field from the properties object
cloud_init_configuration	text	field from the properties object
cloud_init_configuration_blobs	text	field from the properties object
delegation	text	field from the properties object
deployment_type	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
identity	text	Identity for the resource.
inbound_security_rules	text	field from the properties object
internet_ingress_public_ips	text	field from the properties object
location	text	Resource location.
networkVirtualApplianceName	text	field from the properties object
network_profile	text	field from the properties object
nva_sku	text	field from the properties object
partner_managed_resource	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
ssh_public_key	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.
virtual_appliance_asn	text	field from the properties object
virtual_appliance_connections	text	field from the properties object
virtual_appliance_nics	text	field from the properties object
virtual_appliance_sites	text	field from the properties object
virtual_hub	text	field from the properties object

virtual_appliances

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	Identity for the resource.
location	string	Resource location.
properties	object	Network Virtual Appliance definition.
tags	object	Resource tags.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	networkVirtualApplianceName, resourceGroupName, subscriptionId	Gets the specified Network Virtual Appliance.
list	SELECT	subscriptionId	Gets all Network Virtual Appliances in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all Network Virtual Appliances in a resource group.
create_or_update	INSERT	networkVirtualApplianceName, resourceGroupName, subscriptionId	Creates or updates the specified Network Virtual Appliance.
delete	DELETE	networkVirtualApplianceName, resourceGroupName, subscriptionId	Deletes the specified Network Virtual Appliance.
restart	EXEC	networkVirtualApplianceName, resourceGroupName, subscriptionId	Restarts one or more VMs belonging to the specified Network Virtual Appliance.
update_tags	EXEC	networkVirtualApplianceName, resourceGroupName, subscriptionId	Updates a Network Virtual Appliance.

SELECT examples

Gets all Network Virtual Appliances in a subscription.

vw_virtual_appliances

SELECT
id,
name,
additional_nics,
address_prefix,
boot_strap_configuration_blobs,
cloud_init_configuration,
cloud_init_configuration_blobs,
delegation,
deployment_type,
etag,
identity,
inbound_security_rules,
internet_ingress_public_ips,
location,
networkVirtualApplianceName,
network_profile,
nva_sku,
partner_managed_resource,
provisioning_state,
resourceGroupName,
ssh_public_key,
subscriptionId,
tags,
type,
virtual_appliance_asn,
virtual_appliance_connections,
virtual_appliance_nics,
virtual_appliance_sites,
virtual_hub
FROM azure.network.vw_virtual_appliances
WHERE subscriptionId = '{{ subscriptionId }}';

virtual_appliances

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

INSERT example

Use the following StackQL query and manifest file to create a new virtual_appliances resource.

All Properties

/*+ create */
INSERT INTO azure.network.virtual_appliances (
networkVirtualApplianceName,
resourceGroupName,
subscriptionId,
properties,
identity,
id,
location,
tags
)
SELECT 
'{{ networkVirtualApplianceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ identity }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: nvaSku
          value:
            - name: vendor
              value: string
            - name: bundledScaleUnit
              value: string
            - name: marketPlaceVersion
              value: string
        - name: addressPrefix
          value: string
        - name: bootStrapConfigurationBlobs
          value:
            - string
        - name: virtualHub
          value:
            - name: id
              value: string
        - name: cloudInitConfigurationBlobs
          value:
            - string
        - name: cloudInitConfiguration
          value: string
        - name: virtualApplianceAsn
          value: integer
        - name: sshPublicKey
          value: string
        - name: virtualApplianceNics
          value:
            - - name: nicType
                value: string
              - name: name
                value: string
              - name: publicIpAddress
                value: string
              - name: privateIpAddress
                value: string
              - name: instanceName
                value: string
        - name: networkProfile
          value:
            - name: networkInterfaceConfigurations
              value:
                - - name: type
                    value: string
                  - name: properties
                    value:
                      - name: ipConfigurations
                        value:
                          - - name: name
                              value: string
                            - name: properties
                              value:
                                - name: primary
                                  value: boolean
        - name: additionalNics
          value:
            - - name: name
                value: string
              - name: hasPublicIp
                value: boolean
        - name: internetIngressPublicIps
          value:
            - - name: id
                value: string
        - name: virtualApplianceSites
          value:
            - - name: id
                value: string
        - name: virtualApplianceConnections
          value:
            - - name: id
                value: string
        - name: inboundSecurityRules
          value:
            - - name: id
                value: string
        - name: provisioningState
          value: []
        - name: deploymentType
          value: string
        - name: delegation
          value:
            - name: serviceName
              value: string
        - name: partnerManagedResource
          value:
            - name: id
              value: string
            - name: internalLoadBalancerId
              value: string
            - name: standardLoadBalancerId
              value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: object
    - name: etag
      value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object

DELETE example

Deletes the specified virtual_appliances resource.

/*+ delete */
DELETE FROM azure.network.virtual_appliances
WHERE networkVirtualApplianceName = '{{ networkVirtualApplianceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';