Microsoft.Network networkVirtualAppliances 2020-04-01

Template format

To create a Microsoft.Network/networkVirtualAppliances resource, add the following JSON to the resources section of your template.

  "name": "string",
  "type": "Microsoft.Network/networkVirtualAppliances",
  "apiVersion": "2020-04-01",
  "location": "string",
  "tags": {},
  "properties": {
    "bootStrapConfigurationBlob": [
    "virtualHub": {
      "id": "string"
    "cloudInitConfigurationBlob": [
    "virtualApplianceAsn": "integer"
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  "sku": {
    "vendor": "string",
    "bundledScaleUnit": "string",
    "marketPlaceVersion": "string"

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Network/networkVirtualAppliances object

Name Type Required Value
name string Yes The name of Network Virtual Appliance.
type enum Yes Microsoft.Network/networkVirtualAppliances
apiVersion enum Yes 2020-04-01
location string Yes Resource location.
tags object No Resource tags.
properties object Yes Properties of the Network Virtual Appliance. - NetworkVirtualAppliancePropertiesFormat object
identity object No The service principal that has read access to cloud-init and config blob. - ManagedServiceIdentity object
sku object No Network Virtual Appliance SKU. - VirtualApplianceSkuProperties object

NetworkVirtualAppliancePropertiesFormat object

Name Type Required Value
bootStrapConfigurationBlob array No BootStrapConfigurationBlob storage URLs. - string
virtualHub object No The Virtual Hub where Network Virtual Appliance is being deployed. - SubResource object
cloudInitConfigurationBlob array No CloudInitConfigurationBlob storage URLs. - string
virtualApplianceAsn integer No VirtualAppliance ASN.

ManagedServiceIdentity object

Name Type Required Value
type enum No 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. - SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None
userAssignedIdentities object No 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}'.

VirtualApplianceSkuProperties object

Name Type Required Value
vendor string No Virtual Appliance Vendor.
bundledScaleUnit string No Virtual Appliance Scale Unit.
marketPlaceVersion string No Virtual Appliance Version.

SubResource object

Name Type Required Value
id string No Resource ID.