Network Virtual Appliances - Get

Reference

Service:: Virtual Networks

API Version:: 2024-03-01

Gets the specified Network Virtual Appliance.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}?api-version=2024-03-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}?api-version=2024-03-01&$expand={$expand}

URI Parameters

Name	In	Required	Type	Description
networkVirtualApplianceName	path	True	string	The name of Network Virtual Appliance.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.
$expand	query		string	Expands referenced resources.

Responses

Name	Type	Description
200 OK	NetworkVirtualAppliance	Request successful. The operation returns a Network Virtual Appliance resource.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get NetworkVirtualAppliance

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva?api-version=2024-03-01


/**
 * Samples for NetworkVirtualAppliances GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/NetworkVirtualApplianceGet.
     * json
     */
    /**
     * Sample code: Get NetworkVirtualAppliance.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getNetworkVirtualAppliance(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkVirtualAppliances().getByResourceGroupWithResponse("rg1",
            "nva", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_virtual_appliance_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.network_virtual_appliances.get(
        resource_group_name="rg1",
        network_virtual_appliance_name="nva",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/NetworkVirtualApplianceGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4883fa5dbf6f2c9093fac8ce334547e9dfac68fa/specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/NetworkVirtualApplianceGet.json
func ExampleVirtualAppliancesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualAppliancesClient().Get(ctx, "rg1", "nva", &armnetwork.VirtualAppliancesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualAppliance = armnetwork.VirtualAppliance{
	// 	Name: to.Ptr("nva"),
	// 	Type: to.Ptr("Microsoft.Network/networkVirtualAppliances"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 	},
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Identity: &armnetwork.ManagedServiceIdentity{
	// 		Type: to.Ptr(armnetwork.ResourceIdentityTypeUserAssigned),
	// 		UserAssignedIdentities: map[string]*armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 			"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": &armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 			},
	// 		},
	// 	},
	// 	Properties: &armnetwork.VirtualAppliancePropertiesFormat{
	// 		AdditionalNics: []*armnetwork.VirtualApplianceAdditionalNicProperties{
	// 			{
	// 				Name: to.Ptr("exrsdwan"),
	// 				HasPublicIP: to.Ptr(true),
	// 		}},
	// 		AddressPrefix: to.Ptr("192.168.1.0/16"),
	// 		BootStrapConfigurationBlobs: []*string{
	// 			to.Ptr("https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig")},
	// 			CloudInitConfigurationBlobs: []*string{
	// 				to.Ptr("https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig")},
	// 				InboundSecurityRules: []*armnetwork.SubResource{
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1"),
	// 				}},
	// 				InternetIngressPublicIPs: []*armnetwork.InternetIngressPublicIPsProperties{
	// 					{
	// 						ID: to.Ptr("/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip"),
	// 				}},
	// 				NetworkProfile: &armnetwork.VirtualAppliancePropertiesFormatNetworkProfile{
	// 					NetworkInterfaceConfigurations: []*armnetwork.VirtualApplianceNetworkInterfaceConfiguration{
	// 						{
	// 							NicType: to.Ptr(armnetwork.NicTypeInRequestPublicNic),
	// 							Properties: &armnetwork.VirtualApplianceNetworkInterfaceConfigurationProperties{
	// 								IPConfigurations: []*armnetwork.VirtualApplianceIPConfiguration{
	// 									{
	// 										Name: to.Ptr("publicnicipconfig"),
	// 										Properties: &armnetwork.VirtualApplianceIPConfigurationProperties{
	// 											Primary: to.Ptr(true),
	// 										},
	// 									},
	// 									{
	// 										Name: to.Ptr("publicnicipconfig-2"),
	// 										Properties: &armnetwork.VirtualApplianceIPConfigurationProperties{
	// 											Primary: to.Ptr(false),
	// 										},
	// 								}},
	// 							},
	// 						},
	// 						{
	// 							NicType: to.Ptr(armnetwork.NicTypeInRequestPrivateNic),
	// 							Properties: &armnetwork.VirtualApplianceNetworkInterfaceConfigurationProperties{
	// 								IPConfigurations: []*armnetwork.VirtualApplianceIPConfiguration{
	// 									{
	// 										Name: to.Ptr("privatenicipconfig"),
	// 										Properties: &armnetwork.VirtualApplianceIPConfigurationProperties{
	// 											Primary: to.Ptr(true),
	// 										},
	// 									},
	// 									{
	// 										Name: to.Ptr("privatenicipconfig-2"),
	// 										Properties: &armnetwork.VirtualApplianceIPConfigurationProperties{
	// 											Primary: to.Ptr(false),
	// 										},
	// 								}},
	// 							},
	// 					}},
	// 				},
	// 				NvaSKU: &armnetwork.VirtualApplianceSKUProperties{
	// 					BundledScaleUnit: to.Ptr("1"),
	// 					MarketPlaceVersion: to.Ptr("12.1"),
	// 					Vendor: to.Ptr("Cisco SDWAN"),
	// 				},
	// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				VirtualApplianceAsn: to.Ptr[int64](10000),
	// 				VirtualApplianceConnections: []*armnetwork.SubResource{
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/networkVirtualApplianceConnections/connection1"),
	// 				}},
	// 				VirtualApplianceNics: []*armnetwork.VirtualApplianceNicProperties{
	// 					{
	// 						Name: to.Ptr("publicnicipconfig"),
	// 						InstanceName: to.Ptr("nva_0"),
	// 						NicType: to.Ptr(armnetwork.NicTypeInResponsePublicNic),
	// 						PrivateIPAddress: to.Ptr("192.168.12.1"),
	// 						PublicIPAddress: to.Ptr("40.30.2.2"),
	// 					},
	// 					{
	// 						Name: to.Ptr("publicnicipconfig-2"),
	// 						InstanceName: to.Ptr("nva_0"),
	// 						NicType: to.Ptr(armnetwork.NicTypeInResponsePublicNic),
	// 						PrivateIPAddress: to.Ptr("192.168.12.2"),
	// 						PublicIPAddress: to.Ptr("40.30.2.3"),
	// 					},
	// 					{
	// 						Name: to.Ptr("privatenicipconfig"),
	// 						InstanceName: to.Ptr("nva_0"),
	// 						NicType: to.Ptr(armnetwork.NicTypeInResponsePrivateNic),
	// 						PrivateIPAddress: to.Ptr("192.168.12.3"),
	// 						PublicIPAddress: to.Ptr(""),
	// 					},
	// 					{
	// 						Name: to.Ptr("privatenicipconfig-2"),
	// 						InstanceName: to.Ptr("nva_0"),
	// 						NicType: to.Ptr(armnetwork.NicTypeInResponsePrivateNic),
	// 						PrivateIPAddress: to.Ptr("192.168.12.4"),
	// 						PublicIPAddress: to.Ptr(""),
	// 					},
	// 					{
	// 						Name: to.Ptr("exrsdwan"),
	// 						InstanceName: to.Ptr("nva_0"),
	// 						NicType: to.Ptr(armnetwork.NicTypeInResponseAdditionalNic),
	// 						PrivateIPAddress: to.Ptr("10.1.113.4"),
	// 						PublicIPAddress: to.Ptr("4.231.25.19"),
	// 				}},
	// 				VirtualApplianceSites: []*armnetwork.SubResource{
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1"),
	// 				}},
	// 				VirtualHub: &armnetwork.SubResource{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1"),
	// 				},
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the specified Network Virtual Appliance.
 *
 * @summary Gets the specified Network Virtual Appliance.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/NetworkVirtualApplianceGet.json
 */
async function getNetworkVirtualAppliance() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkVirtualApplianceName = "nva";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkVirtualAppliances.get(
    resourceGroupName,
    networkVirtualApplianceName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/NetworkVirtualApplianceGet.json
// this example is just showing the usage of "NetworkVirtualAppliances_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://zcusa.951200.xyz/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this NetworkVirtualApplianceResource
NetworkVirtualApplianceCollection collection = resourceGroupResource.GetNetworkVirtualAppliances();

// invoke the operation
string networkVirtualApplianceName = "nva";
NullableResponse<NetworkVirtualApplianceResource> response = await collection.GetIfExistsAsync(networkVirtualApplianceName);
NetworkVirtualApplianceResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    NetworkVirtualApplianceData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "name": "nva",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva",
  "type": "Microsoft.Network/networkVirtualAppliances",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "tags": {
    "key1": "value1"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {}
    }
  },
  "properties": {
    "nvaSku": {
      "vendor": "Cisco SDWAN",
      "bundledScaleUnit": "1",
      "marketPlaceVersion": "12.1"
    },
    "addressPrefix": "192.168.1.0/16",
    "virtualHub": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1"
    },
    "virtualApplianceSites": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1"
      }
    ],
    "inboundSecurityRules": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1"
      }
    ],
    "virtualApplianceConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/networkVirtualApplianceConnections/connection1"
      }
    ],
    "provisioningState": "Succeeded",
    "bootStrapConfigurationBlobs": [
      "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig"
    ],
    "cloudInitConfigurationBlobs": [
      "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig"
    ],
    "virtualApplianceAsn": 10000,
    "additionalNics": [
      {
        "name": "exrsdwan",
        "hasPublicIp": true
      }
    ],
    "internetIngressPublicIps": [
      {
        "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip"
      }
    ],
    "networkProfile": {
      "networkInterfaceConfigurations": [
        {
          "type": "PublicNic",
          "properties": {
            "ipConfigurations": [
              {
                "name": "publicnicipconfig",
                "properties": {
                  "primary": true
                }
              },
              {
                "name": "publicnicipconfig-2",
                "properties": {
                  "primary": false
                }
              }
            ]
          }
        },
        {
          "type": "PrivateNic",
          "properties": {
            "ipConfigurations": [
              {
                "name": "privatenicipconfig",
                "properties": {
                  "primary": true
                }
              },
              {
                "name": "privatenicipconfig-2",
                "properties": {
                  "primary": false
                }
              }
            ]
          }
        }
      ]
    },
    "virtualApplianceNics": [
      {
        "nicType": "PublicNic",
        "name": "publicnicipconfig",
        "publicIpAddress": "40.30.2.2",
        "privateIpAddress": "192.168.12.1",
        "instanceName": "nva_0"
      },
      {
        "nicType": "PublicNic",
        "name": "publicnicipconfig-2",
        "publicIpAddress": "40.30.2.3",
        "privateIpAddress": "192.168.12.2",
        "instanceName": "nva_0"
      },
      {
        "nicType": "PrivateNic",
        "name": "privatenicipconfig",
        "publicIpAddress": "",
        "privateIpAddress": "192.168.12.3",
        "instanceName": "nva_0"
      },
      {
        "nicType": "PrivateNic",
        "name": "privatenicipconfig-2",
        "publicIpAddress": "",
        "privateIpAddress": "192.168.12.4",
        "instanceName": "nva_0"
      },
      {
        "nicType": "AdditionalNic",
        "name": "exrsdwan",
        "publicIpAddress": "4.231.25.19",
        "privateIpAddress": "10.1.113.4",
        "instanceName": "nva_0"
      }
    ]
  }
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
DelegationProperties	Properties of the delegation.
InternetIngressPublicIpsProperties	Internet Ingress Public Ip Properties
ManagedServiceIdentity	Identity for the resource.
NetworkProfile	Network Profile containing configurations for Public and Private NIC.
NetworkVirtualAppliance	NetworkVirtualAppliance Resource.
NicTypeInRequest	NIC type. This should be either PublicNic or PrivateNic.
NicTypeInResponse	NIC type - PublicNic, PrivateNic, or AdditionalNic.
PartnerManagedResourceProperties	Properties of the partner managed resource.
ProvisioningState	The current provisioning state.
ResourceIdentityType	The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
SubResource	Reference to another subresource.
UserAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
VirtualApplianceAdditionalNicProperties	Network Virtual Appliance Additional Nic Properties
VirtualApplianceIPConfiguration	Represents a single IP configuration.
VirtualApplianceIPConfigurationProperties	Represents a single IP configuration properties.
VirtualApplianceNetworkInterfaceConfiguration	Represents a single NIC configuration.
VirtualApplianceNetworkInterfaceConfigurationProperties	Represents a single NIC configuration properties.
VirtualApplianceNicProperties	Network Virtual Appliance NIC properties.
VirtualApplianceSkuProperties	Network Virtual Appliance Sku Properties.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

DelegationProperties

Properties of the delegation.

Name	Type	Description
provisioningState	ProvisioningState	The current provisioning state.
serviceName	string	The service name to which the NVA is delegated.

InternetIngressPublicIpsProperties

Internet Ingress Public Ip Properties

Name	Type	Description
id	string	Resource Uri of Public Ip

ManagedServiceIdentity

Identity for the resource.

Name	Type	Description
principalId	string	The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type	ResourceIdentityType	The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
userAssignedIdentities	UserAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

NetworkProfile

Network Profile containing configurations for Public and Private NIC.

Name	Type	Description
networkInterfaceConfigurations	VirtualApplianceNetworkInterfaceConfiguration[]	Represents a single NIC configuration.

NetworkVirtualAppliance

NetworkVirtualAppliance Resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
identity	ManagedServiceIdentity	The service principal that has read access to cloud-init and config blob.
location	string	Resource location.
name	string	Resource name.
properties.additionalNics	VirtualApplianceAdditionalNicProperties[]	Details required for Additional Network Interface.
properties.addressPrefix	string	Address Prefix.
properties.bootStrapConfigurationBlobs	string[]	BootStrapConfigurationBlobs storage URLs.
properties.cloudInitConfiguration	string	CloudInitConfiguration string in plain text.
properties.cloudInitConfigurationBlobs	string[]	CloudInitConfigurationBlob storage URLs.
properties.delegation	DelegationProperties	The delegation for the Virtual Appliance
properties.deploymentType	string	The deployment type. PartnerManaged for the SaaS NVA
properties.inboundSecurityRules	SubResource[]	List of references to InboundSecurityRules.
properties.internetIngressPublicIps	InternetIngressPublicIpsProperties[]	List of Resource Uri of Public IPs for Internet Ingress Scenario.
properties.networkProfile	NetworkProfile	Network Profile containing configurations for Public and Private NIC.
properties.nvaSku	VirtualApplianceSkuProperties	Network Virtual Appliance SKU.
properties.partnerManagedResource	PartnerManagedResourceProperties	The delegation for the Virtual Appliance
properties.provisioningState	ProvisioningState	The provisioning state of the resource.
properties.sshPublicKey	string	Public key for SSH login.
properties.virtualApplianceAsn	integer	VirtualAppliance ASN. Microsoft private, public and IANA reserved ASN are not supported.
properties.virtualApplianceConnections	SubResource[]	List of references to VirtualApplianceConnections.
properties.virtualApplianceNics	VirtualApplianceNicProperties[]	List of Virtual Appliance Network Interfaces.
properties.virtualApplianceSites	SubResource[]	List of references to VirtualApplianceSite.
properties.virtualHub	SubResource	The Virtual Hub where Network Virtual Appliance is being deployed.
tags	object	Resource tags.
type	string	Resource type.

NicTypeInRequest

NIC type. This should be either PublicNic or PrivateNic.

Name	Type	Description
PrivateNic	string
PublicNic	string

NicTypeInResponse

NIC type - PublicNic, PrivateNic, or AdditionalNic.

Name	Type	Description
AdditionalNic	string
PrivateNic	string
PublicNic	string

PartnerManagedResourceProperties

Properties of the partner managed resource.

Name	Type	Description
id	string	The partner managed resource id.
internalLoadBalancerId	string	The partner managed ILB resource id
standardLoadBalancerId	string	The partner managed SLB resource id

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

ResourceIdentityType

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

SubResource

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.

UserAssignedIdentities

The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name	Type	Description

VirtualApplianceAdditionalNicProperties

Network Virtual Appliance Additional Nic Properties

Name	Type	Description
hasPublicIp	boolean	Flag (true or false) for Intent for Public Ip on additional nic
name	string	Name of additional nic

VirtualApplianceIPConfiguration

Represents a single IP configuration.

Name	Type	Description
name	string	Name of the IP configuration.
properties	VirtualApplianceIPConfigurationProperties	Represents a single IP configuration properties.

VirtualApplianceIPConfigurationProperties

Represents a single IP configuration properties.

Name	Type	Description
primary	boolean	Whether or not this is primary IP configuration of the NIC.

VirtualApplianceNetworkInterfaceConfiguration

Represents a single NIC configuration.

Name	Type	Description
properties	VirtualApplianceNetworkInterfaceConfigurationProperties	Represents a single NIC configuration properties.
type	NicTypeInRequest	NIC type. This should be either PublicNic or PrivateNic.

VirtualApplianceNetworkInterfaceConfigurationProperties

Represents a single NIC configuration properties.

Name	Type	Description
ipConfigurations	VirtualApplianceIPConfiguration[]	Represents a single IP configuration.

VirtualApplianceNicProperties

Network Virtual Appliance NIC properties.

Name	Type	Description
instanceName	string	Instance on which nic is attached.
name	string	NIC name.
nicType	NicTypeInResponse	NIC type - PublicNic, PrivateNic, or AdditionalNic.
privateIpAddress	string	Private IP address.
publicIpAddress	string	Public IP address.

VirtualApplianceSkuProperties

Network Virtual Appliance Sku Properties.

Name	Type	Description
bundledScaleUnit	string	Virtual Appliance Scale Unit.
marketPlaceVersion	string	Virtual Appliance Version.
vendor	string	Virtual Appliance Vendor.