NetworkVirtualAppliancePropertiesFormat interface

Network Virtual Appliance definition.

Properties

additionalNics

Details required for Additional Network Interface. This property is not compatible with the NVA deployed in VNets.

addressFamily

The address families to deploy the NVA in. ["IPv4", "IPv6"] deploys a dual-stack NVA (the vHub/VNet must also be dual-stack). ["IPv4"], an empty array, or omitting the field deploys an IPv4-only NVA. The value "IPv6" may only appear in combination with "IPv4"; standalone ["IPv6"] is reserved for future use and is rejected by the service today.

addressPrefix

Address Prefix.

addressPrefixV6

Address Prefix for Dual-Stack NVAs.

bootStrapConfigurationBlobs

BootStrapConfigurationBlobs storage URLs.

cloudInitConfiguration

CloudInitConfiguration string in plain text.

cloudInitConfigurationBlobs

CloudInitConfigurationBlob storage URLs.

delegation

The delegation for the Virtual Appliance. Only appliable for SaaS NVA.

deploymentType

The deployment type. PartnerManaged for the SaaS NVA

inboundSecurityRules

List of references to InboundSecurityRules.

internetIngressPublicIps

List of Resource Uri of Public IPs for Internet Ingress Scenario.

migrationStatus

The migration status of the Network Virtual Appliance.

networkProfile

Network Profile containing configurations for Public and Private NIC.

nvaInterfaceConfigurations

The NVA in VNet interface configurations

nvaSku

Network Virtual Appliance SKU.

partnerManagedResource

The delegation for the Virtual Appliance

privateIpAddress

A Internal Load Balancer's HA port frontend IP address. Can be used to set routes & UDR to load balance traffic between NVA instances

privateIpAddressV6

An Internal Load Balancer's HA port frontend IPv6 address. Can be used to set routes & UDR to load balance traffic between NVA instances. This field appears in dual-stack NVAs.

provisioningState

The provisioning state of the resource.

sshPublicKey

Public key for SSH login.

virtualApplianceAsn

VirtualAppliance ASN. Microsoft private, public and IANA reserved ASN are not supported.

virtualApplianceConnections

List of references to VirtualApplianceConnections.

virtualApplianceNics

List of Virtual Appliance Network Interfaces.

virtualApplianceSites

List of references to VirtualApplianceSite.

virtualHub

The Virtual Hub where Network Virtual Appliance is being deployed.

Property Details

additionalNics

Details required for Additional Network Interface. This property is not compatible with the NVA deployed in VNets.

additionalNics?: VirtualApplianceAdditionalNicProperties[]

Property Value

addressFamily

The address families to deploy the NVA in. ["IPv4", "IPv6"] deploys a dual-stack NVA (the vHub/VNet must also be dual-stack). ["IPv4"], an empty array, or omitting the field deploys an IPv4-only NVA. The value "IPv6" may only appear in combination with "IPv4"; standalone ["IPv6"] is reserved for future use and is rejected by the service today.

addressFamily?: string[]

Property Value

string[]

addressPrefix

Address Prefix.

addressPrefix?: string

Property Value

string

addressPrefixV6

Address Prefix for Dual-Stack NVAs.

addressPrefixV6?: string

Property Value

string

bootStrapConfigurationBlobs

BootStrapConfigurationBlobs storage URLs.

bootStrapConfigurationBlobs?: string[]

Property Value

string[]

cloudInitConfiguration

CloudInitConfiguration string in plain text.

cloudInitConfiguration?: string

Property Value

string

cloudInitConfigurationBlobs

CloudInitConfigurationBlob storage URLs.

cloudInitConfigurationBlobs?: string[]

Property Value

string[]

delegation

The delegation for the Virtual Appliance. Only appliable for SaaS NVA.

delegation?: DelegationProperties

Property Value

deploymentType

The deployment type. PartnerManaged for the SaaS NVA

deploymentType?: string

Property Value

string

inboundSecurityRules

List of references to InboundSecurityRules.

inboundSecurityRules?: SubResource[]

Property Value

internetIngressPublicIps

List of Resource Uri of Public IPs for Internet Ingress Scenario.

internetIngressPublicIps?: InternetIngressPublicIpsProperties[]

Property Value

migrationStatus

The migration status of the Network Virtual Appliance.

migrationStatus?: NetworkVirtualApplianceMigrationStatus

Property Value

networkProfile

Network Profile containing configurations for Public and Private NIC.

networkProfile?: NetworkVirtualAppliancePropertiesFormatNetworkProfile

Property Value

nvaInterfaceConfigurations

The NVA in VNet interface configurations

nvaInterfaceConfigurations?: NvaInterfaceConfigurationsProperties[]

Property Value

nvaSku

Network Virtual Appliance SKU.

nvaSku?: VirtualApplianceSkuProperties

Property Value

partnerManagedResource

The delegation for the Virtual Appliance

partnerManagedResource?: PartnerManagedResourceProperties

Property Value

privateIpAddress

A Internal Load Balancer's HA port frontend IP address. Can be used to set routes & UDR to load balance traffic between NVA instances

privateIpAddress?: string

Property Value

string

privateIpAddressV6

An Internal Load Balancer's HA port frontend IPv6 address. Can be used to set routes & UDR to load balance traffic between NVA instances. This field appears in dual-stack NVAs.

privateIpAddressV6?: string

Property Value

string

provisioningState

The provisioning state of the resource.

provisioningState?: string

Property Value

string

sshPublicKey

Public key for SSH login.

sshPublicKey?: string

Property Value

string

virtualApplianceAsn

VirtualAppliance ASN. Microsoft private, public and IANA reserved ASN are not supported.

virtualApplianceAsn?: number

Property Value

number

virtualApplianceConnections

List of references to VirtualApplianceConnections.

virtualApplianceConnections?: SubResource[]

Property Value

virtualApplianceNics

List of Virtual Appliance Network Interfaces.

virtualApplianceNics?: VirtualApplianceNicProperties[]

Property Value

virtualApplianceSites

List of references to VirtualApplianceSite.

virtualApplianceSites?: SubResource[]

Property Value

virtualHub

The Virtual Hub where Network Virtual Appliance is being deployed.

virtualHub?: SubResource

Property Value