Share via

Microsoft.AVS privateClouds/workloadNetworks/portMirroringProfiles

Bicep resource definition

The privateClouds/workloadNetworks/portMirroringProfiles resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles@2025-09-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    destination: 'string'
    direction: 'string'
    displayName: 'string'
    revision: int
    source: 'string'
  }
}

Property Values

Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles

Name Description Value
name The resource name string

Constraints:
Pattern = ^[-\w\._]+$ (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: privateClouds/workloadNetworks
properties The resource-specific properties for this resource. WorkloadNetworkPortMirroringProperties

WorkloadNetworkPortMirroringProperties

Name Description Value
destination Destination VM Group. string
direction Direction of port mirroring profile. 'BIDIRECTIONAL'
'EGRESS'
'INGRESS'
displayName Display name of the port mirroring profile. string
revision NSX revision number. int
source Source VM Group. string

ARM template resource definition

The privateClouds/workloadNetworks/portMirroringProfiles resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles resource, add the following JSON to your template.

{
  "type": "Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles",
  "apiVersion": "2025-09-01",
  "name": "string",
  "properties": {
    "destination": "string",
    "direction": "string",
    "displayName": "string",
    "revision": "int",
    "source": "string"
  }
}

Property Values

Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles

Name Description Value
apiVersion The api version '2025-09-01'
name The resource name string

Constraints:
Pattern = ^[-\w\._]+$ (required)
properties The resource-specific properties for this resource. WorkloadNetworkPortMirroringProperties
type The resource type 'Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles'

WorkloadNetworkPortMirroringProperties

Name Description Value
destination Destination VM Group. string
direction Direction of port mirroring profile. 'BIDIRECTIONAL'
'EGRESS'
'INGRESS'
displayName Display name of the port mirroring profile. string
revision NSX revision number. int
source Source VM Group. string

Usage Examples

Terraform (AzAPI provider) resource definition

The privateClouds/workloadNetworks/portMirroringProfiles 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.AVS/privateClouds/workloadNetworks/portMirroringProfiles resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles@2025-09-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      destination = "string"
      direction = "string"
      displayName = "string"
      revision = int
      source = "string"
    }
  }
}

Property Values

Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles

Name Description Value
name The resource name string

Constraints:
Pattern = ^[-\w\._]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: privateClouds/workloadNetworks
properties The resource-specific properties for this resource. WorkloadNetworkPortMirroringProperties
type The resource type "Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles@2025-09-01"

WorkloadNetworkPortMirroringProperties

Name Description Value
destination Destination VM Group. string
direction Direction of port mirroring profile. 'BIDIRECTIONAL'
'EGRESS'
'INGRESS'
displayName Display name of the port mirroring profile. string
revision NSX revision number. int
source Source VM Group. string
  • Last updated on