Bicep resource definition
The networkVirtualAppliances resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Network/networkVirtualAppliances resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/networkVirtualAppliances@2023-05-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
additionalNics: [
{
hasPublicIp: bool
name: 'string'
}
]
bootStrapConfigurationBlobs: [
'string'
]
cloudInitConfiguration: 'string'
cloudInitConfigurationBlobs: [
'string'
]
delegation: {
serviceName: 'string'
}
nvaSku: {
bundledScaleUnit: 'string'
marketPlaceVersion: 'string'
vendor: 'string'
}
partnerManagedResource: {}
sshPublicKey: 'string'
virtualApplianceAsn: int
virtualHub: {
id: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Network/networkVirtualAppliances
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
DelegationProperties
| Name |
Description |
Value |
| serviceName |
The service name to which the NVA is delegated. |
string |
ManagedServiceIdentity
| Name |
Description |
Value |
| type |
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. |
'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' |
| 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}'. |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name |
Description |
Value |
| additionalNics |
Details required for Additional Network Interface. |
VirtualApplianceAdditionalNicProperties[] |
| bootStrapConfigurationBlobs |
BootStrapConfigurationBlobs storage URLs. |
string[] |
| cloudInitConfiguration |
CloudInitConfiguration string in plain text. |
string |
| cloudInitConfigurationBlobs |
CloudInitConfigurationBlob storage URLs. |
string[] |
| delegation |
The delegation for the Virtual Appliance |
DelegationProperties |
| nvaSku |
Network Virtual Appliance SKU. |
VirtualApplianceSkuProperties |
| partnerManagedResource |
The delegation for the Virtual Appliance |
PartnerManagedResourceProperties |
| sshPublicKey |
Public key for SSH login. |
string |
| virtualApplianceAsn |
VirtualAppliance ASN. Microsoft private, public and IANA reserved ASN are not supported. |
int
Constraints:
Min value = 0
Max value = 4294967295 |
| virtualHub |
The Virtual Hub where Network Virtual Appliance is being deployed. |
SubResource |
PartnerManagedResourceProperties
SubResource
| Name |
Description |
Value |
| id |
Resource ID. |
string |
VirtualApplianceAdditionalNicProperties
| Name |
Description |
Value |
| hasPublicIp |
Flag (true or false) for Intent for Public Ip on additional nic |
bool |
| name |
Name of additional nic |
string |
VirtualApplianceSkuProperties
| Name |
Description |
Value |
| bundledScaleUnit |
Virtual Appliance Scale Unit. |
string |
| marketPlaceVersion |
Virtual Appliance Version. |
string |
| vendor |
Virtual Appliance Vendor. |
string |
ARM template resource definition
The networkVirtualAppliances resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Network/networkVirtualAppliances resource, add the following JSON to your template.
{
"type": "Microsoft.Network/networkVirtualAppliances",
"apiVersion": "2023-05-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"additionalNics": [
{
"hasPublicIp": "bool",
"name": "string"
}
],
"bootStrapConfigurationBlobs": [ "string" ],
"cloudInitConfiguration": "string",
"cloudInitConfigurationBlobs": [ "string" ],
"delegation": {
"serviceName": "string"
},
"nvaSku": {
"bundledScaleUnit": "string",
"marketPlaceVersion": "string",
"vendor": "string"
},
"partnerManagedResource": {
},
"sshPublicKey": "string",
"virtualApplianceAsn": "int",
"virtualHub": {
"id": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Network/networkVirtualAppliances
| Name |
Description |
Value |
| apiVersion |
The api version |
'2023-05-01' |
| identity |
The service principal that has read access to cloud-init and config blob. |
ManagedServiceIdentity |
| location |
Resource location. |
string |
| name |
The resource name |
string (required) |
| properties |
Properties of the Network Virtual Appliance. |
NetworkVirtualAppliancePropertiesFormat |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
| type |
The resource type |
'Microsoft.Network/networkVirtualAppliances' |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
DelegationProperties
| Name |
Description |
Value |
| serviceName |
The service name to which the NVA is delegated. |
string |
ManagedServiceIdentity
| Name |
Description |
Value |
| type |
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. |
'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' |
| 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}'. |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name |
Description |
Value |
| additionalNics |
Details required for Additional Network Interface. |
VirtualApplianceAdditionalNicProperties[] |
| bootStrapConfigurationBlobs |
BootStrapConfigurationBlobs storage URLs. |
string[] |
| cloudInitConfiguration |
CloudInitConfiguration string in plain text. |
string |
| cloudInitConfigurationBlobs |
CloudInitConfigurationBlob storage URLs. |
string[] |
| delegation |
The delegation for the Virtual Appliance |
DelegationProperties |
| nvaSku |
Network Virtual Appliance SKU. |
VirtualApplianceSkuProperties |
| partnerManagedResource |
The delegation for the Virtual Appliance |
PartnerManagedResourceProperties |
| sshPublicKey |
Public key for SSH login. |
string |
| virtualApplianceAsn |
VirtualAppliance ASN. Microsoft private, public and IANA reserved ASN are not supported. |
int
Constraints:
Min value = 0
Max value = 4294967295 |
| virtualHub |
The Virtual Hub where Network Virtual Appliance is being deployed. |
SubResource |
PartnerManagedResourceProperties
SubResource
| Name |
Description |
Value |
| id |
Resource ID. |
string |
VirtualApplianceAdditionalNicProperties
| Name |
Description |
Value |
| hasPublicIp |
Flag (true or false) for Intent for Public Ip on additional nic |
bool |
| name |
Name of additional nic |
string |
VirtualApplianceSkuProperties
| Name |
Description |
Value |
| bundledScaleUnit |
Virtual Appliance Scale Unit. |
string |
| marketPlaceVersion |
Virtual Appliance Version. |
string |
| vendor |
Virtual Appliance Vendor. |
string |
Usage Examples
The networkVirtualAppliances resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Network/networkVirtualAppliances resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkVirtualAppliances@2023-05-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
additionalNics = [
{
hasPublicIp = bool
name = "string"
}
]
bootStrapConfigurationBlobs = [
"string"
]
cloudInitConfiguration = "string"
cloudInitConfigurationBlobs = [
"string"
]
delegation = {
serviceName = "string"
}
nvaSku = {
bundledScaleUnit = "string"
marketPlaceVersion = "string"
vendor = "string"
}
partnerManagedResource = {
}
sshPublicKey = "string"
virtualApplianceAsn = int
virtualHub = {
id = "string"
}
}
}
}
Property Values
Microsoft.Network/networkVirtualAppliances
| Name |
Description |
Value |
| identity |
The service principal that has read access to cloud-init and config blob. |
ManagedServiceIdentity |
| location |
Resource location. |
string |
| name |
The resource name |
string (required) |
| properties |
Properties of the Network Virtual Appliance. |
NetworkVirtualAppliancePropertiesFormat |
| tags |
Resource tags |
Dictionary of tag names and values. |
| type |
The resource type |
"Microsoft.Network/networkVirtualAppliances@2023-05-01" |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
DelegationProperties
| Name |
Description |
Value |
| serviceName |
The service name to which the NVA is delegated. |
string |
ManagedServiceIdentity
| Name |
Description |
Value |
| type |
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. |
'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' |
| 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}'. |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name |
Description |
Value |
| additionalNics |
Details required for Additional Network Interface. |
VirtualApplianceAdditionalNicProperties[] |
| bootStrapConfigurationBlobs |
BootStrapConfigurationBlobs storage URLs. |
string[] |
| cloudInitConfiguration |
CloudInitConfiguration string in plain text. |
string |
| cloudInitConfigurationBlobs |
CloudInitConfigurationBlob storage URLs. |
string[] |
| delegation |
The delegation for the Virtual Appliance |
DelegationProperties |
| nvaSku |
Network Virtual Appliance SKU. |
VirtualApplianceSkuProperties |
| partnerManagedResource |
The delegation for the Virtual Appliance |
PartnerManagedResourceProperties |
| sshPublicKey |
Public key for SSH login. |
string |
| virtualApplianceAsn |
VirtualAppliance ASN. Microsoft private, public and IANA reserved ASN are not supported. |
int
Constraints:
Min value = 0
Max value = 4294967295 |
| virtualHub |
The Virtual Hub where Network Virtual Appliance is being deployed. |
SubResource |
PartnerManagedResourceProperties
SubResource
| Name |
Description |
Value |
| id |
Resource ID. |
string |
VirtualApplianceAdditionalNicProperties
| Name |
Description |
Value |
| hasPublicIp |
Flag (true or false) for Intent for Public Ip on additional nic |
bool |
| name |
Name of additional nic |
string |
VirtualApplianceSkuProperties
| Name |
Description |
Value |
| bundledScaleUnit |
Virtual Appliance Scale Unit. |
string |
| marketPlaceVersion |
Virtual Appliance Version. |
string |
| vendor |
Virtual Appliance Vendor. |
string |