Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2024-07-01
- 2024-05-01
- 2024-03-01
- 2024-01-01
- 2023-11-01
- 2023-09-01
- 2023-06-01
- 2023-05-01
- 2023-04-01
- 2023-02-01
- 2022-11-01
- 2022-09-01
- 2022-07-01
- 2022-05-01
- 2022-01-01
- 2021-08-01
- 2021-05-01
- 2021-03-01
- 2021-02-01
- 2020-11-01
- 2020-08-01
- 2020-07-01
- 2020-06-01
- 2020-05-01
- 2020-04-01
- 2020-03-01
- 2019-12-01
Bicep resource definition
The networkVirtualAppliances resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/networkVirtualAppliances resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/networkVirtualAppliances@2020-06-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
bootStrapConfigurationBlobs: [
'string'
]
cloudInitConfiguration: 'string'
cloudInitConfigurationBlobs: [
'string'
]
nvaSku: {
bundledScaleUnit: 'string'
marketPlaceVersion: 'string'
vendor: 'string'
}
virtualApplianceAsn: int
virtualHub: {
id: 'string'
}
}
tags: {
{customized property}: '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. See Tags in templates |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Name | Description | Value |
|---|
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 |
|---|
NetworkVirtualAppliancePropertiesFormat
| Name | Description | Value |
|---|---|---|
| bootStrapConfigurationBlobs | BootStrapConfigurationBlobs storage URLs. | string[] |
| cloudInitConfiguration | CloudInitConfiguration string in plain text. | string |
| cloudInitConfigurationBlobs | CloudInitConfigurationBlob storage URLs. | string[] |
| nvaSku | Network Virtual Appliance SKU. | VirtualApplianceSkuProperties |
| virtualApplianceAsn | VirtualAppliance ASN. | int Constraints: Min value = 0 Max value = 4294967295 |
| virtualHub | The Virtual Hub where Network Virtual Appliance is being deployed. | SubResource |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | 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:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/networkVirtualAppliances resource, add the following JSON to your template.
{
"type": "Microsoft.Network/networkVirtualAppliances",
"apiVersion": "2020-06-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"bootStrapConfigurationBlobs": [ "string" ],
"cloudInitConfiguration": "string",
"cloudInitConfigurationBlobs": [ "string" ],
"nvaSku": {
"bundledScaleUnit": "string",
"marketPlaceVersion": "string",
"vendor": "string"
},
"virtualApplianceAsn": "int",
"virtualHub": {
"id": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Network/networkVirtualAppliances
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-06-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
| Name | Description | Value |
|---|
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 |
|---|
NetworkVirtualAppliancePropertiesFormat
| Name | Description | Value |
|---|---|---|
| bootStrapConfigurationBlobs | BootStrapConfigurationBlobs storage URLs. | string[] |
| cloudInitConfiguration | CloudInitConfiguration string in plain text. | string |
| cloudInitConfigurationBlobs | CloudInitConfigurationBlob storage URLs. | string[] |
| nvaSku | Network Virtual Appliance SKU. | VirtualApplianceSkuProperties |
| virtualApplianceAsn | VirtualAppliance ASN. | int Constraints: Min value = 0 Max value = 4294967295 |
| virtualHub | The Virtual Hub where Network Virtual Appliance is being deployed. | SubResource |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
VirtualApplianceSkuProperties
| Name | Description | Value |
|---|---|---|
| bundledScaleUnit | Virtual Appliance Scale Unit. | string |
| marketPlaceVersion | Virtual Appliance Version. | string |
| vendor | Virtual Appliance Vendor. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The networkVirtualAppliances resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/networkVirtualAppliances resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkVirtualAppliances@2020-06-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
bootStrapConfigurationBlobs = [
"string"
]
cloudInitConfiguration = "string"
cloudInitConfigurationBlobs = [
"string"
]
nvaSku = {
bundledScaleUnit = "string"
marketPlaceVersion = "string"
vendor = "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@2020-06-01" |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Name | Description | Value |
|---|
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 |
|---|
NetworkVirtualAppliancePropertiesFormat
| Name | Description | Value |
|---|---|---|
| bootStrapConfigurationBlobs | BootStrapConfigurationBlobs storage URLs. | string[] |
| cloudInitConfiguration | CloudInitConfiguration string in plain text. | string |
| cloudInitConfigurationBlobs | CloudInitConfigurationBlob storage URLs. | string[] |
| nvaSku | Network Virtual Appliance SKU. | VirtualApplianceSkuProperties |
| virtualApplianceAsn | VirtualAppliance ASN. | int Constraints: Min value = 0 Max value = 4294967295 |
| virtualHub | The Virtual Hub where Network Virtual Appliance is being deployed. | SubResource |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
VirtualApplianceSkuProperties
| Name | Description | Value |
|---|---|---|
| bundledScaleUnit | Virtual Appliance Scale Unit. | string |
| marketPlaceVersion | Virtual Appliance Version. | string |
| vendor | Virtual Appliance Vendor. | string |