Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. WorkloadNetworkPortMirroring
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.avs.WorkloadNetworkPortMirroring

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    NSX Port Mirroring

    Uses Azure REST API version 2023-09-01. In version 2.x of the Azure Native provider, it used API version 2022-05-01.

    Other available API versions: 2022-05-01, 2023-03-01, 2024-09-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native avs [ApiVersion]. See the version guide for details.

    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",
    });

});

    package main

import (
	avs "github.com/pulumi/pulumi-azure-native-sdk/avs/v3"
	"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
	})
}

    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.0)
            .source("vmGroup1")
            .build());

    }
}

    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",
});

    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")

    resources:
  workloadNetworkPortMirroring:
    type: azure-native:avs:WorkloadNetworkPortMirroring
    properties:
      destination: vmGroup2
      direction: BIDIRECTIONAL
      displayName: portMirroring1
      portMirroringId: portMirroring1
      privateCloudName: cloud1
      resourceGroupName: group1
      revision: 1
      source: vmGroup1

    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 string
    The unique name of the resource.
    args WorkloadNetworkPortMirroringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args WorkloadNetworkPortMirroringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkloadNetworkPortMirroringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
});

    example, err := avs.NewWorkloadNetworkPortMirroring(ctx, "workloadNetworkPortMirroringResource", &avs.WorkloadNetworkPortMirroringArgs{
	PrivateCloudName:  pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Destination:       pulumi.String("string"),
	Direction:         pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	PortMirroringId:   pulumi.String("string"),
	Revision:          pulumi.Float64(0),
	Source:            pulumi.String("string"),
})

    var workloadNetworkPortMirroringResource = new WorkloadNetworkPortMirroring("workloadNetworkPortMirroringResource", WorkloadNetworkPortMirroringArgs.builder()
    .privateCloudName("string")
    .resourceGroupName("string")
    .destination("string")
    .direction("string")
    .displayName("string")
    .portMirroringId("string")
    .revision(0.0)
    .source("string")
    .build());

    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")

    const workloadNetworkPortMirroringResource = new azure_native.avs.WorkloadNetworkPortMirroring("workloadNetworkPortMirroringResource", {
    privateCloudName: "string",
    resourceGroupName: "string",
    destination: "string",
    direction: "string",
    displayName: "string",
    portMirroringId: "string",
    revision: 0,
    source: "string",
});

    type: azure-native:avs:WorkloadNetworkPortMirroring
properties:
    destination: string
    direction: string
    displayName: string
    portMirroringId: string
    privateCloudName: string
    resourceGroupName: string
    revision: 0
    source: string

    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 string
    Name of the private cloud
    ResourceGroupName 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 string
    ID of the NSX port mirroring profile.
    Revision double
    NSX revision number.
    Source string
    Source VM Group.
    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName 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 string
    ID of the NSX port mirroring profile.
    Revision float64
    NSX revision number.
    Source string
    Source VM Group.
    privateCloudName String
    Name of the private cloud
    resourceGroupName 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 String
    ID of the NSX port mirroring profile.
    revision Double
    NSX revision number.
    source String
    Source VM Group.
    privateCloudName string
    Name of the private cloud
    resourceGroupName 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 string
    ID of the NSX port mirroring profile.
    revision number
    NSX revision number.
    source string
    Source VM Group.
    private_cloud_name str
    Name of the private cloud
    resource_group_name 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 str
    ID of the NSX port mirroring profile.
    revision float
    NSX revision number.
    source str
    Source VM Group.
    privateCloudName String
    Name of the private cloud
    resourceGroupName 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 String
    ID of the NSX port mirroring profile.
    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:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state
    Status string
    Port Mirroring Status.
    SystemData Pulumi.AzureNative.AVS.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state
    Status string
    Port Mirroring Status.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The provisioning state
    status String
    Port Mirroring Status.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    The provisioning state
    status string
    Port Mirroring Status.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    The provisioning state
    status str
    Port Mirroring Status.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The provisioning state
    status String
    Port Mirroring Status.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    PortMirroringDirectionEnum, PortMirroringDirectionEnumArgs

    INGRESS
    INGRESSis ingress
    EGRESS
    EGRESSis egress
    BIDIRECTIONAL
    BIDIRECTIONALis bidirectional
    PortMirroringDirectionEnumINGRESS
    INGRESSis ingress
    PortMirroringDirectionEnumEGRESS
    EGRESSis egress
    PortMirroringDirectionEnumBIDIRECTIONAL
    BIDIRECTIONALis bidirectional
    INGRESS
    INGRESSis ingress
    EGRESS
    EGRESSis egress
    BIDIRECTIONAL
    BIDIRECTIONALis bidirectional
    INGRESS
    INGRESSis ingress
    EGRESS
    EGRESSis egress
    BIDIRECTIONAL
    BIDIRECTIONALis bidirectional
    INGRESS
    INGRESSis ingress
    EGRESS
    EGRESSis egress
    BIDIRECTIONAL
    BIDIRECTIONALis bidirectional
    "INGRESS"
    INGRESSis ingress
    "EGRESS"
    EGRESSis egress
    "BIDIRECTIONAL"
    BIDIRECTIONALis bidirectional

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native