Microsoft.Network virtualNetworkAppliances/capabilities 2026-03-01

• Latest
• 2026-03-01

Bicep resource definition

The virtualNetworkAppliances/capabilities 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/virtualNetworkAppliances/capabilities resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/virtualNetworkAppliances/capabilities@2026-03-01' = {
  name: 'string'
  properties: {
    ipVersion: 'string'
  }
  kind: 'string'
  // For remaining properties, see Microsoft.Network/virtualNetworkAppliances/capabilities objects
}

Microsoft.Network/virtualNetworkAppliances/capabilities objects

Set the kind property to specify the type of object.

For NAT64, use:

{
  kind: 'NAT64'
}

For PLGateway, use:

{
  kind: 'PLGateway'
}

For PLGatewayFastpath, use:

{
  kind: 'PLGatewayFastpath'
}

For PLIPForwarders, use:

{
  kind: 'PLIPForwarders'
}

Property Values

Microsoft.Network/virtualNetworkAppliances/capabilities

Name	Description	Value
kind	Set to 'NAT64' for type Nat64Capability. Set to 'PLGateway' for type PLGatewayCapability. Set to 'PLGatewayFastpath' for type PLGatewayFastpathCapability. Set to 'PLIPForwarders' for type PlipForwardersCapability.	'NAT64' 'PLGateway' 'PLGatewayFastpath' 'PLIPForwarders' (required)
name	The resource name	string Constraints: Pattern = ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$ (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: virtualNetworkAppliances
properties	The resource-specific properties for this resource.	VirtualNetworkApplianceCapabilityProperties

Nat64Capability

Name	Description	Value
kind	The kind of capability (the top-level discriminator).	'NAT64' (required)

PLGatewayCapability

Name	Description	Value
kind	The kind of capability (the top-level discriminator).	'PLGateway' (required)

PLGatewayFastpathCapability

Name	Description	Value
kind	The kind of capability (the top-level discriminator).	'PLGatewayFastpath' (required)

PlipForwardersCapability

Name	Description	Value
kind	The kind of capability (the top-level discriminator).	'PLIPForwarders' (required)

VirtualNetworkApplianceCapabilityProperties

Name	Description	Value
ipVersion	The IP version the capability applies to. Private Link Gateway FastPath (PLGatewayFastpath) only accepts DualStack; Private Link Gateway (PLGateway) and Private Link IP-forwarders (PLIPForwarders) only accept IPv6. Not applicable to NAT64, which is property-less and must omit this value. The service validates the value against the resource's kind when the capability is created or updated.	'DualStack' 'IPv6'

ARM template resource definition

The virtualNetworkAppliances/capabilities 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.

Usage Examples

Resource format

To create a Microsoft.Network/virtualNetworkAppliances/capabilities resource, add the following JSON to your template.

{
  "name": "string",
  "properties": {
    "ipVersion": "string"
  },
  "kind": "string"
  // For remaining properties, see Microsoft.Network/virtualNetworkAppliances/capabilities objects
}

Microsoft.Network/virtualNetworkAppliances/capabilities objects

Set the kind property to specify the type of object.

For NAT64, use:

{
  "kind": "NAT64"
}

For PLGateway, use:

{
  "kind": "PLGateway"
}

For PLGatewayFastpath, use:

{
  "kind": "PLGatewayFastpath"
}

For PLIPForwarders, use:

{
  "kind": "PLIPForwarders"
}

Property Values

Microsoft.Network/virtualNetworkAppliances/capabilities

Name	Description	Value
apiVersion	The api version	'2026-03-01'
kind	Set to 'NAT64' for type Nat64Capability. Set to 'PLGateway' for type PLGatewayCapability. Set to 'PLGatewayFastpath' for type PLGatewayFastpathCapability. Set to 'PLIPForwarders' for type PlipForwardersCapability.	'NAT64' 'PLGateway' 'PLGatewayFastpath' 'PLIPForwarders' (required)
name	The resource name	string Constraints: Pattern = ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$ (required)
properties	The resource-specific properties for this resource.	VirtualNetworkApplianceCapabilityProperties
type	The resource type	'Microsoft.Network/virtualNetworkAppliances/capabilities'

Nat64Capability

Name	Description	Value
kind	The kind of capability (the top-level discriminator).	'NAT64' (required)

PLGatewayCapability

Name	Description	Value
kind	The kind of capability (the top-level discriminator).	'PLGateway' (required)

PLGatewayFastpathCapability

Name	Description	Value
kind	The kind of capability (the top-level discriminator).	'PLGatewayFastpath' (required)

PlipForwardersCapability

Name	Description	Value
kind	The kind of capability (the top-level discriminator).	'PLIPForwarders' (required)

VirtualNetworkApplianceCapabilityProperties

Name	Description	Value
ipVersion	The IP version the capability applies to. Private Link Gateway FastPath (PLGatewayFastpath) only accepts DualStack; Private Link Gateway (PLGateway) and Private Link IP-forwarders (PLIPForwarders) only accept IPv6. Not applicable to NAT64, which is property-less and must omit this value. The service validates the value against the resource's kind when the capability is created or updated.	'DualStack' 'IPv6'

Terraform (AzAPI provider) resource definition

The virtualNetworkAppliances/capabilities 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/virtualNetworkAppliances/capabilities resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  name = "string"
  properties = {
    ipVersion = "string"
  }
  kind = "string"
  // For remaining properties, see Microsoft.Network/virtualNetworkAppliances/capabilities objects
}

Microsoft.Network/virtualNetworkAppliances/capabilities objects

Set the kind property to specify the type of object.

For NAT64, use:

{
  kind = "NAT64"
}

For PLGateway, use:

{
  kind = "PLGateway"
}

For PLGatewayFastpath, use:

{
  kind = "PLGatewayFastpath"
}

For PLIPForwarders, use:

{
  kind = "PLIPForwarders"
}

Property Values

Microsoft.Network/virtualNetworkAppliances/capabilities

Name	Description	Value
kind	Set to 'NAT64' for type Nat64Capability. Set to 'PLGateway' for type PLGatewayCapability. Set to 'PLGatewayFastpath' for type PLGatewayFastpathCapability. Set to 'PLIPForwarders' for type PlipForwardersCapability.	'NAT64' 'PLGateway' 'PLGatewayFastpath' 'PLIPForwarders' (required)
name	The resource name	string Constraints: Pattern = ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: virtualNetworkAppliances
properties	The resource-specific properties for this resource.	VirtualNetworkApplianceCapabilityProperties
type	The resource type	"Microsoft.Network/virtualNetworkAppliances/capabilities@2026-03-01"

Nat64Capability

Name	Description	Value
kind	The kind of capability (the top-level discriminator).	'NAT64' (required)

PLGatewayCapability

Name	Description	Value
kind	The kind of capability (the top-level discriminator).	'PLGateway' (required)

PLGatewayFastpathCapability

Name	Description	Value
kind	The kind of capability (the top-level discriminator).	'PLGatewayFastpath' (required)

PlipForwardersCapability

Name	Description	Value
kind	The kind of capability (the top-level discriminator).	'PLIPForwarders' (required)

VirtualNetworkApplianceCapabilityProperties

Name	Description	Value
ipVersion	The IP version the capability applies to. Private Link Gateway FastPath (PLGatewayFastpath) only accepts DualStack; Private Link Gateway (PLGateway) and Private Link IP-forwarders (PLIPForwarders) only accept IPv6. Not applicable to NAT64, which is property-less and must omit this value. The service validates the value against the resource's kind when the capability is created or updated.	'DualStack' 'IPv6'