Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. avs
  5. WorkloadNetworkPortMirroring
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.avs.WorkloadNetworkPortMirroring

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

NSX Port Mirroring Azure REST API version: 2022-05-01. Prior API version in Azure Native 1.x: 2020-07-17-preview.

Other available API versions: 2023-03-01, 2023-09-01.

Example Usage

WorkloadNetworks_CreatePortMirroring

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var workloadNetworkPortMirroring = new AzureNative.AVS.WorkloadNetworkPortMirroring("workloadNetworkPortMirroring", new()
    {
        Destination = "vmGroup2",
        Direction = AzureNative.AVS.PortMirroringDirectionEnum.BIDIRECTIONAL,
        DisplayName = "portMirroring1",
        PortMirroringId = "portMirroring1",
        PrivateCloudName = "cloud1",
        ResourceGroupName = "group1",
        Revision = 1,
        Source = "vmGroup1",
    });

});
Copy
package main

import (
	avs "github.com/pulumi/pulumi-azure-native-sdk/avs/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avs.NewWorkloadNetworkPortMirroring(ctx, "workloadNetworkPortMirroring", &avs.WorkloadNetworkPortMirroringArgs{
			Destination:       pulumi.String("vmGroup2"),
			Direction:         pulumi.String(avs.PortMirroringDirectionEnumBIDIRECTIONAL),
			DisplayName:       pulumi.String("portMirroring1"),
			PortMirroringId:   pulumi.String("portMirroring1"),
			PrivateCloudName:  pulumi.String("cloud1"),
			ResourceGroupName: pulumi.String("group1"),
			Revision:          pulumi.Float64(1),
			Source:            pulumi.String("vmGroup1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.avs.WorkloadNetworkPortMirroring;
import com.pulumi.azurenative.avs.WorkloadNetworkPortMirroringArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var workloadNetworkPortMirroring = new WorkloadNetworkPortMirroring("workloadNetworkPortMirroring", WorkloadNetworkPortMirroringArgs.builder()
            .destination("vmGroup2")
            .direction("BIDIRECTIONAL")
            .displayName("portMirroring1")
            .portMirroringId("portMirroring1")
            .privateCloudName("cloud1")
            .resourceGroupName("group1")
            .revision(1)
            .source("vmGroup1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const workloadNetworkPortMirroring = new azure_native.avs.WorkloadNetworkPortMirroring("workloadNetworkPortMirroring", {
    destination: "vmGroup2",
    direction: azure_native.avs.PortMirroringDirectionEnum.BIDIRECTIONAL,
    displayName: "portMirroring1",
    portMirroringId: "portMirroring1",
    privateCloudName: "cloud1",
    resourceGroupName: "group1",
    revision: 1,
    source: "vmGroup1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

workload_network_port_mirroring = azure_native.avs.WorkloadNetworkPortMirroring("workloadNetworkPortMirroring",
    destination="vmGroup2",
    direction=azure_native.avs.PortMirroringDirectionEnum.BIDIRECTIONAL,
    display_name="portMirroring1",
    port_mirroring_id="portMirroring1",
    private_cloud_name="cloud1",
    resource_group_name="group1",
    revision=1,
    source="vmGroup1")
Copy
resources:
  workloadNetworkPortMirroring:
    type: azure-native:avs:WorkloadNetworkPortMirroring
    properties:
      destination: vmGroup2
      direction: BIDIRECTIONAL
      displayName: portMirroring1
      portMirroringId: portMirroring1
      privateCloudName: cloud1
      resourceGroupName: group1
      revision: 1
      source: vmGroup1
Copy

Create WorkloadNetworkPortMirroring Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WorkloadNetworkPortMirroring(name: string, args: WorkloadNetworkPortMirroringArgs, opts?: CustomResourceOptions);
@overload
def WorkloadNetworkPortMirroring(resource_name: str,
                                 args: WorkloadNetworkPortMirroringArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def WorkloadNetworkPortMirroring(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 private_cloud_name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 destination: Optional[str] = None,
                                 direction: Optional[Union[str, PortMirroringDirectionEnum]] = None,
                                 display_name: Optional[str] = None,
                                 port_mirroring_id: Optional[str] = None,
                                 revision: Optional[float] = None,
                                 source: Optional[str] = None)
func NewWorkloadNetworkPortMirroring(ctx *Context, name string, args WorkloadNetworkPortMirroringArgs, opts ...ResourceOption) (*WorkloadNetworkPortMirroring, error)
public WorkloadNetworkPortMirroring(string name, WorkloadNetworkPortMirroringArgs args, CustomResourceOptions? opts = null)
public WorkloadNetworkPortMirroring(String name, WorkloadNetworkPortMirroringArgs args)
public WorkloadNetworkPortMirroring(String name, WorkloadNetworkPortMirroringArgs args, CustomResourceOptions options)

type: azure-native:avs:WorkloadNetworkPortMirroring
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkloadNetworkPortMirroringArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkloadNetworkPortMirroringArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkloadNetworkPortMirroringArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkloadNetworkPortMirroringArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkloadNetworkPortMirroringArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var workloadNetworkPortMirroringResource = new AzureNative.Avs.WorkloadNetworkPortMirroring("workloadNetworkPortMirroringResource", new()
{
    PrivateCloudName = "string",
    ResourceGroupName = "string",
    Destination = "string",
    Direction = "string",
    DisplayName = "string",
    PortMirroringId = "string",
    Revision = 0,
    Source = "string",
});
Copy
example, err := avs.NewWorkloadNetworkPortMirroring(ctx, "workloadNetworkPortMirroringResource", &avs.WorkloadNetworkPortMirroringArgs{
	PrivateCloudName:  "string",
	ResourceGroupName: "string",
	Destination:       "string",
	Direction:         "string",
	DisplayName:       "string",
	PortMirroringId:   "string",
	Revision:          0,
	Source:            "string",
})
Copy
var workloadNetworkPortMirroringResource = new WorkloadNetworkPortMirroring("workloadNetworkPortMirroringResource", WorkloadNetworkPortMirroringArgs.builder()
    .privateCloudName("string")
    .resourceGroupName("string")
    .destination("string")
    .direction("string")
    .displayName("string")
    .portMirroringId("string")
    .revision(0)
    .source("string")
    .build());
Copy
workload_network_port_mirroring_resource = azure_native.avs.WorkloadNetworkPortMirroring("workloadNetworkPortMirroringResource",
    private_cloud_name=string,
    resource_group_name=string,
    destination=string,
    direction=string,
    display_name=string,
    port_mirroring_id=string,
    revision=0,
    source=string)
Copy
const workloadNetworkPortMirroringResource = new azure_native.avs.WorkloadNetworkPortMirroring("workloadNetworkPortMirroringResource", {
    privateCloudName: "string",
    resourceGroupName: "string",
    destination: "string",
    direction: "string",
    displayName: "string",
    portMirroringId: "string",
    revision: 0,
    source: "string",
});
Copy
type: azure-native:avs:WorkloadNetworkPortMirroring
properties:
    destination: string
    direction: string
    displayName: string
    portMirroringId: string
    privateCloudName: string
    resourceGroupName: string
    revision: 0
    source: string
Copy

WorkloadNetworkPortMirroring Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WorkloadNetworkPortMirroring resource accepts the following input properties:

PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Destination string
Destination VM Group.
Direction string | Pulumi.AzureNative.AVS.PortMirroringDirectionEnum
Direction of port mirroring profile.
DisplayName string
Display name of the port mirroring profile.
PortMirroringId Changes to this property will trigger replacement. string
NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name
Revision double
NSX revision number.
Source string
Source VM Group.
PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Destination string
Destination VM Group.
Direction string | PortMirroringDirectionEnum
Direction of port mirroring profile.
DisplayName string
Display name of the port mirroring profile.
PortMirroringId Changes to this property will trigger replacement. string
NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name
Revision float64
NSX revision number.
Source string
Source VM Group.
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
destination String
Destination VM Group.
direction String | PortMirroringDirectionEnum
Direction of port mirroring profile.
displayName String
Display name of the port mirroring profile.
portMirroringId Changes to this property will trigger replacement. String
NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name
revision Double
NSX revision number.
source String
Source VM Group.
privateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
destination string
Destination VM Group.
direction string | PortMirroringDirectionEnum
Direction of port mirroring profile.
displayName string
Display name of the port mirroring profile.
portMirroringId Changes to this property will trigger replacement. string
NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name
revision number
NSX revision number.
source string
Source VM Group.
private_cloud_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the private cloud
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
destination str
Destination VM Group.
direction str | PortMirroringDirectionEnum
Direction of port mirroring profile.
display_name str
Display name of the port mirroring profile.
port_mirroring_id Changes to this property will trigger replacement. str
NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name
revision float
NSX revision number.
source str
Source VM Group.
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
destination String
Destination VM Group.
direction String | "INGRESS" | "EGRESS" | "BIDIRECTIONAL"
Direction of port mirroring profile.
displayName String
Display name of the port mirroring profile.
portMirroringId Changes to this property will trigger replacement. String
NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name
revision Number
NSX revision number.
source String
Source VM Group.

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkloadNetworkPortMirroring resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
ProvisioningState string
The provisioning state
Status string
Port Mirroring Status.
Type string
Resource type.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
ProvisioningState string
The provisioning state
Status string
Port Mirroring Status.
Type string
Resource type.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
provisioningState String
The provisioning state
status String
Port Mirroring Status.
type String
Resource type.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name.
provisioningState string
The provisioning state
status string
Port Mirroring Status.
type string
Resource type.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name.
provisioning_state str
The provisioning state
status str
Port Mirroring Status.
type str
Resource type.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
provisioningState String
The provisioning state
status String
Port Mirroring Status.
type String
Resource type.

Supporting Types

PortMirroringDirectionEnum
, PortMirroringDirectionEnumArgs

INGRESS
INGRESS
EGRESS
EGRESS
BIDIRECTIONAL
BIDIRECTIONAL
PortMirroringDirectionEnumINGRESS
INGRESS
PortMirroringDirectionEnumEGRESS
EGRESS
PortMirroringDirectionEnumBIDIRECTIONAL
BIDIRECTIONAL
INGRESS
INGRESS
EGRESS
EGRESS
BIDIRECTIONAL
BIDIRECTIONAL
INGRESS
INGRESS
EGRESS
EGRESS
BIDIRECTIONAL
BIDIRECTIONAL
INGRESS
INGRESS
EGRESS
EGRESS
BIDIRECTIONAL
BIDIRECTIONAL
"INGRESS"
INGRESS
"EGRESS"
EGRESS
"BIDIRECTIONAL"
BIDIRECTIONAL

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:avs:WorkloadNetworkPortMirroring portMirroring1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native