Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. networkfunction
  5. CollectorPolicy

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.networkfunction.CollectorPolicy

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Network Function Collector Policy.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West US 2",
});
const exampleExpressRoutePort = new azure.network.ExpressRoutePort("example", {
    name: "example-erp",
    resourceGroupName: example.name,
    location: example.location,
    peeringLocation: "Equinix-Seattle-SE2",
    bandwidthInGbps: 10,
    encapsulation: "Dot1Q",
});
const exampleExpressRouteCircuit = new azure.network.ExpressRouteCircuit("example", {
    name: "example-erc",
    location: example.location,
    resourceGroupName: example.name,
    expressRoutePortId: exampleExpressRoutePort.id,
    bandwidthInGbps: 1,
    sku: {
        tier: "Standard",
        family: "MeteredData",
    },
});
const exampleExpressRouteCircuitPeering = new azure.network.ExpressRouteCircuitPeering("example", {
    peeringType: "MicrosoftPeering",
    expressRouteCircuitName: exampleExpressRouteCircuit.name,
    resourceGroupName: example.name,
    peerAsn: 100,
    primaryPeerAddressPrefix: "192.168.199.0/30",
    secondaryPeerAddressPrefix: "192.168.200.0/30",
    vlanId: 300,
    microsoftPeeringConfig: {
        advertisedPublicPrefixes: ["123.6.0.0/24"],
    },
});
const exampleAzureTrafficCollector = new azure.networkfunction.AzureTrafficCollector("example", {
    name: "example-nfatc",
    location: example.location,
    resourceGroupName: example.name,
}, {
    dependsOn: [exampleExpressRouteCircuitPeering],
});
const exampleCollectorPolicy = new azure.networkfunction.CollectorPolicy("example", {
    name: "example-nfcp",
    trafficCollectorId: exampleAzureTrafficCollector.id,
    location: example.location,
    ipfxEmission: {
        destinationTypes: "AzureMonitor",
    },
    ipfxIngestion: {
        sourceResourceIds: [exampleExpressRouteCircuit.id],
    },
    tags: {
        key: "value",
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West US 2")
example_express_route_port = azure.network.ExpressRoutePort("example",
    name="example-erp",
    resource_group_name=example.name,
    location=example.location,
    peering_location="Equinix-Seattle-SE2",
    bandwidth_in_gbps=10,
    encapsulation="Dot1Q")
example_express_route_circuit = azure.network.ExpressRouteCircuit("example",
    name="example-erc",
    location=example.location,
    resource_group_name=example.name,
    express_route_port_id=example_express_route_port.id,
    bandwidth_in_gbps=1,
    sku={
        "tier": "Standard",
        "family": "MeteredData",
    })
example_express_route_circuit_peering = azure.network.ExpressRouteCircuitPeering("example",
    peering_type="MicrosoftPeering",
    express_route_circuit_name=example_express_route_circuit.name,
    resource_group_name=example.name,
    peer_asn=100,
    primary_peer_address_prefix="192.168.199.0/30",
    secondary_peer_address_prefix="192.168.200.0/30",
    vlan_id=300,
    microsoft_peering_config={
        "advertised_public_prefixes": ["123.6.0.0/24"],
    })
example_azure_traffic_collector = azure.networkfunction.AzureTrafficCollector("example",
    name="example-nfatc",
    location=example.location,
    resource_group_name=example.name,
    opts = pulumi.ResourceOptions(depends_on=[example_express_route_circuit_peering]))
example_collector_policy = azure.networkfunction.CollectorPolicy("example",
    name="example-nfcp",
    traffic_collector_id=example_azure_traffic_collector.id,
    location=example.location,
    ipfx_emission={
        "destination_types": "AzureMonitor",
    },
    ipfx_ingestion={
        "source_resource_ids": [example_express_route_circuit.id],
    },
    tags={
        "key": "value",
    })

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/networkfunction"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West US 2"),
		})
		if err != nil {
			return err
		}
		exampleExpressRoutePort, err := network.NewExpressRoutePort(ctx, "example", &network.ExpressRoutePortArgs{
			Name:              pulumi.String("example-erp"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			PeeringLocation:   pulumi.String("Equinix-Seattle-SE2"),
			BandwidthInGbps:   pulumi.Int(10),
			Encapsulation:     pulumi.String("Dot1Q"),
		})
		if err != nil {
			return err
		}
		exampleExpressRouteCircuit, err := network.NewExpressRouteCircuit(ctx, "example", &network.ExpressRouteCircuitArgs{
			Name:               pulumi.String("example-erc"),
			Location:           example.Location,
			ResourceGroupName:  example.Name,
			ExpressRoutePortId: exampleExpressRoutePort.ID(),
			BandwidthInGbps:    pulumi.Float64(1),
			Sku: &network.ExpressRouteCircuitSkuArgs{
				Tier:   pulumi.String("Standard"),
				Family: pulumi.String("MeteredData"),
			},
		})
		if err != nil {
			return err
		}
		exampleExpressRouteCircuitPeering, err := network.NewExpressRouteCircuitPeering(ctx, "example", &network.ExpressRouteCircuitPeeringArgs{
			PeeringType:                pulumi.String("MicrosoftPeering"),
			ExpressRouteCircuitName:    exampleExpressRouteCircuit.Name,
			ResourceGroupName:          example.Name,
			PeerAsn:                    pulumi.Int(100),
			PrimaryPeerAddressPrefix:   pulumi.String("192.168.199.0/30"),
			SecondaryPeerAddressPrefix: pulumi.String("192.168.200.0/30"),
			VlanId:                     pulumi.Int(300),
			MicrosoftPeeringConfig: &network.ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs{
				AdvertisedPublicPrefixes: pulumi.StringArray{
					pulumi.String("123.6.0.0/24"),
				},
			},
		})
		if err != nil {
			return err
		}
		exampleAzureTrafficCollector, err := networkfunction.NewAzureTrafficCollector(ctx, "example", &networkfunction.AzureTrafficCollectorArgs{
			Name:              pulumi.String("example-nfatc"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleExpressRouteCircuitPeering,
		}))
		if err != nil {
			return err
		}
		_, err = networkfunction.NewCollectorPolicy(ctx, "example", &networkfunction.CollectorPolicyArgs{
			Name:               pulumi.String("example-nfcp"),
			TrafficCollectorId: exampleAzureTrafficCollector.ID(),
			Location:           example.Location,
			IpfxEmission: &networkfunction.CollectorPolicyIpfxEmissionArgs{
				DestinationTypes: pulumi.String("AzureMonitor"),
			},
			IpfxIngestion: &networkfunction.CollectorPolicyIpfxIngestionArgs{
				SourceResourceIds: pulumi.StringArray{
					exampleExpressRouteCircuit.ID(),
				},
			},
			Tags: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West US 2",
    });

    var exampleExpressRoutePort = new Azure.Network.ExpressRoutePort("example", new()
    {
        Name = "example-erp",
        ResourceGroupName = example.Name,
        Location = example.Location,
        PeeringLocation = "Equinix-Seattle-SE2",
        BandwidthInGbps = 10,
        Encapsulation = "Dot1Q",
    });

    var exampleExpressRouteCircuit = new Azure.Network.ExpressRouteCircuit("example", new()
    {
        Name = "example-erc",
        Location = example.Location,
        ResourceGroupName = example.Name,
        ExpressRoutePortId = exampleExpressRoutePort.Id,
        BandwidthInGbps = 1,
        Sku = new Azure.Network.Inputs.ExpressRouteCircuitSkuArgs
        {
            Tier = "Standard",
            Family = "MeteredData",
        },
    });

    var exampleExpressRouteCircuitPeering = new Azure.Network.ExpressRouteCircuitPeering("example", new()
    {
        PeeringType = "MicrosoftPeering",
        ExpressRouteCircuitName = exampleExpressRouteCircuit.Name,
        ResourceGroupName = example.Name,
        PeerAsn = 100,
        PrimaryPeerAddressPrefix = "192.168.199.0/30",
        SecondaryPeerAddressPrefix = "192.168.200.0/30",
        VlanId = 300,
        MicrosoftPeeringConfig = new Azure.Network.Inputs.ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs
        {
            AdvertisedPublicPrefixes = new[]
            {
                "123.6.0.0/24",
            },
        },
    });

    var exampleAzureTrafficCollector = new Azure.NetworkFunction.AzureTrafficCollector("example", new()
    {
        Name = "example-nfatc",
        Location = example.Location,
        ResourceGroupName = example.Name,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleExpressRouteCircuitPeering,
        },
    });

    var exampleCollectorPolicy = new Azure.NetworkFunction.CollectorPolicy("example", new()
    {
        Name = "example-nfcp",
        TrafficCollectorId = exampleAzureTrafficCollector.Id,
        Location = example.Location,
        IpfxEmission = new Azure.NetworkFunction.Inputs.CollectorPolicyIpfxEmissionArgs
        {
            DestinationTypes = "AzureMonitor",
        },
        IpfxIngestion = new Azure.NetworkFunction.Inputs.CollectorPolicyIpfxIngestionArgs
        {
            SourceResourceIds = new[]
            {
                exampleExpressRouteCircuit.Id,
            },
        },
        Tags = 
        {
            { "key", "value" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.ExpressRoutePort;
import com.pulumi.azure.network.ExpressRoutePortArgs;
import com.pulumi.azure.network.ExpressRouteCircuit;
import com.pulumi.azure.network.ExpressRouteCircuitArgs;
import com.pulumi.azure.network.inputs.ExpressRouteCircuitSkuArgs;
import com.pulumi.azure.network.ExpressRouteCircuitPeering;
import com.pulumi.azure.network.ExpressRouteCircuitPeeringArgs;
import com.pulumi.azure.network.inputs.ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs;
import com.pulumi.azure.networkfunction.AzureTrafficCollector;
import com.pulumi.azure.networkfunction.AzureTrafficCollectorArgs;
import com.pulumi.azure.networkfunction.CollectorPolicy;
import com.pulumi.azure.networkfunction.CollectorPolicyArgs;
import com.pulumi.azure.networkfunction.inputs.CollectorPolicyIpfxEmissionArgs;
import com.pulumi.azure.networkfunction.inputs.CollectorPolicyIpfxIngestionArgs;
import com.pulumi.resources.CustomResourceOptions;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West US 2")
            .build());

        var exampleExpressRoutePort = new ExpressRoutePort("exampleExpressRoutePort", ExpressRoutePortArgs.builder()
            .name("example-erp")
            .resourceGroupName(example.name())
            .location(example.location())
            .peeringLocation("Equinix-Seattle-SE2")
            .bandwidthInGbps(10)
            .encapsulation("Dot1Q")
            .build());

        var exampleExpressRouteCircuit = new ExpressRouteCircuit("exampleExpressRouteCircuit", ExpressRouteCircuitArgs.builder()
            .name("example-erc")
            .location(example.location())
            .resourceGroupName(example.name())
            .expressRoutePortId(exampleExpressRoutePort.id())
            .bandwidthInGbps(1)
            .sku(ExpressRouteCircuitSkuArgs.builder()
                .tier("Standard")
                .family("MeteredData")
                .build())
            .build());

        var exampleExpressRouteCircuitPeering = new ExpressRouteCircuitPeering("exampleExpressRouteCircuitPeering", ExpressRouteCircuitPeeringArgs.builder()
            .peeringType("MicrosoftPeering")
            .expressRouteCircuitName(exampleExpressRouteCircuit.name())
            .resourceGroupName(example.name())
            .peerAsn(100)
            .primaryPeerAddressPrefix("192.168.199.0/30")
            .secondaryPeerAddressPrefix("192.168.200.0/30")
            .vlanId(300)
            .microsoftPeeringConfig(ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs.builder()
                .advertisedPublicPrefixes("123.6.0.0/24")
                .build())
            .build());

        var exampleAzureTrafficCollector = new AzureTrafficCollector("exampleAzureTrafficCollector", AzureTrafficCollectorArgs.builder()
            .name("example-nfatc")
            .location(example.location())
            .resourceGroupName(example.name())
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleExpressRouteCircuitPeering)
                .build());

        var exampleCollectorPolicy = new CollectorPolicy("exampleCollectorPolicy", CollectorPolicyArgs.builder()
            .name("example-nfcp")
            .trafficCollectorId(exampleAzureTrafficCollector.id())
            .location(example.location())
            .ipfxEmission(CollectorPolicyIpfxEmissionArgs.builder()
                .destinationTypes("AzureMonitor")
                .build())
            .ipfxIngestion(CollectorPolicyIpfxIngestionArgs.builder()
                .sourceResourceIds(exampleExpressRouteCircuit.id())
                .build())
            .tags(Map.of("key", "value"))
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West US 2
  exampleExpressRoutePort:
    type: azure:network:ExpressRoutePort
    name: example
    properties:
      name: example-erp
      resourceGroupName: ${example.name}
      location: ${example.location}
      peeringLocation: Equinix-Seattle-SE2
      bandwidthInGbps: 10
      encapsulation: Dot1Q
  exampleExpressRouteCircuit:
    type: azure:network:ExpressRouteCircuit
    name: example
    properties:
      name: example-erc
      location: ${example.location}
      resourceGroupName: ${example.name}
      expressRoutePortId: ${exampleExpressRoutePort.id}
      bandwidthInGbps: 1
      sku:
        tier: Standard
        family: MeteredData
  exampleExpressRouteCircuitPeering:
    type: azure:network:ExpressRouteCircuitPeering
    name: example
    properties:
      peeringType: MicrosoftPeering
      expressRouteCircuitName: ${exampleExpressRouteCircuit.name}
      resourceGroupName: ${example.name}
      peerAsn: 100
      primaryPeerAddressPrefix: 192.168.199.0/30
      secondaryPeerAddressPrefix: 192.168.200.0/30
      vlanId: 300
      microsoftPeeringConfig:
        advertisedPublicPrefixes:
          - 123.6.0.0/24
  exampleAzureTrafficCollector:
    type: azure:networkfunction:AzureTrafficCollector
    name: example
    properties:
      name: example-nfatc
      location: ${example.location}
      resourceGroupName: ${example.name}
    options:
      dependson:
        - ${exampleExpressRouteCircuitPeering}
  exampleCollectorPolicy:
    type: azure:networkfunction:CollectorPolicy
    name: example
    properties:
      name: example-nfcp
      trafficCollectorId: ${exampleAzureTrafficCollector.id}
      location: ${example.location}
      ipfxEmission:
        destinationTypes: AzureMonitor
      ipfxIngestion:
        sourceResourceIds:
          - ${exampleExpressRouteCircuit.id}
      tags:
        key: value

    Create CollectorPolicy Resource

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

    Constructor syntax

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

@overload
def CollectorPolicy(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    ipfx_emission: Optional[CollectorPolicyIpfxEmissionArgs] = None,
                    ipfx_ingestion: Optional[CollectorPolicyIpfxIngestionArgs] = None,
                    traffic_collector_id: Optional[str] = None,
                    location: Optional[str] = None,
                    name: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None)
    func NewCollectorPolicy(ctx *Context, name string, args CollectorPolicyArgs, opts ...ResourceOption) (*CollectorPolicy, error)
    public CollectorPolicy(string name, CollectorPolicyArgs args, CustomResourceOptions? opts = null)
    public CollectorPolicy(String name, CollectorPolicyArgs args)
public CollectorPolicy(String name, CollectorPolicyArgs args, CustomResourceOptions options)

    type: azure:networkfunction:CollectorPolicy
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 CollectorPolicyArgs
    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 CollectorPolicyArgs
    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 CollectorPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CollectorPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CollectorPolicyArgs
    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 collectorPolicyResource = new Azure.NetworkFunction.CollectorPolicy("collectorPolicyResource", new()
{
    IpfxEmission = new Azure.NetworkFunction.Inputs.CollectorPolicyIpfxEmissionArgs
    {
        DestinationTypes = "string",
    },
    IpfxIngestion = new Azure.NetworkFunction.Inputs.CollectorPolicyIpfxIngestionArgs
    {
        SourceResourceIds = new[]
        {
            "string",
        },
    },
    TrafficCollectorId = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := networkfunction.NewCollectorPolicy(ctx, "collectorPolicyResource", &networkfunction.CollectorPolicyArgs{
	IpfxEmission: &networkfunction.CollectorPolicyIpfxEmissionArgs{
		DestinationTypes: pulumi.String("string"),
	},
	IpfxIngestion: &networkfunction.CollectorPolicyIpfxIngestionArgs{
		SourceResourceIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	TrafficCollectorId: pulumi.String("string"),
	Location:           pulumi.String("string"),
	Name:               pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var collectorPolicyResource = new CollectorPolicy("collectorPolicyResource", CollectorPolicyArgs.builder()
    .ipfxEmission(CollectorPolicyIpfxEmissionArgs.builder()
        .destinationTypes("string")
        .build())
    .ipfxIngestion(CollectorPolicyIpfxIngestionArgs.builder()
        .sourceResourceIds("string")
        .build())
    .trafficCollectorId("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    collector_policy_resource = azure.networkfunction.CollectorPolicy("collectorPolicyResource",
    ipfx_emission={
        "destination_types": "string",
    },
    ipfx_ingestion={
        "source_resource_ids": ["string"],
    },
    traffic_collector_id="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })

    const collectorPolicyResource = new azure.networkfunction.CollectorPolicy("collectorPolicyResource", {
    ipfxEmission: {
        destinationTypes: "string",
    },
    ipfxIngestion: {
        sourceResourceIds: ["string"],
    },
    trafficCollectorId: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: azure:networkfunction:CollectorPolicy
properties:
    ipfxEmission:
        destinationTypes: string
    ipfxIngestion:
        sourceResourceIds:
            - string
    location: string
    name: string
    tags:
        string: string
    trafficCollectorId: string

    CollectorPolicy 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 CollectorPolicy resource accepts the following input properties:

    IpfxEmission CollectorPolicyIpfxEmission
    An ipfx_emission block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    IpfxIngestion CollectorPolicyIpfxIngestion
    An ipfx_ingestion block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    TrafficCollectorId string
    Specifies the Azure Traffic Collector ID of the Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    Location string
    Specifies the Azure Region where the Network Function Collector Policy should exist. Changing this forces a new Network Function Collector Policy to be created.
    Name string
    Specifies the name which should be used for this Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Network Function Collector Policy.
    IpfxEmission CollectorPolicyIpfxEmissionArgs
    An ipfx_emission block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    IpfxIngestion CollectorPolicyIpfxIngestionArgs
    An ipfx_ingestion block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    TrafficCollectorId string
    Specifies the Azure Traffic Collector ID of the Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    Location string
    Specifies the Azure Region where the Network Function Collector Policy should exist. Changing this forces a new Network Function Collector Policy to be created.
    Name string
    Specifies the name which should be used for this Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Network Function Collector Policy.
    ipfxEmission CollectorPolicyIpfxEmission
    An ipfx_emission block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    ipfxIngestion CollectorPolicyIpfxIngestion
    An ipfx_ingestion block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    trafficCollectorId String
    Specifies the Azure Traffic Collector ID of the Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    location String
    Specifies the Azure Region where the Network Function Collector Policy should exist. Changing this forces a new Network Function Collector Policy to be created.
    name String
    Specifies the name which should be used for this Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Network Function Collector Policy.
    ipfxEmission CollectorPolicyIpfxEmission
    An ipfx_emission block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    ipfxIngestion CollectorPolicyIpfxIngestion
    An ipfx_ingestion block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    trafficCollectorId string
    Specifies the Azure Traffic Collector ID of the Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    location string
    Specifies the Azure Region where the Network Function Collector Policy should exist. Changing this forces a new Network Function Collector Policy to be created.
    name string
    Specifies the name which should be used for this Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Network Function Collector Policy.
    ipfx_emission CollectorPolicyIpfxEmissionArgs
    An ipfx_emission block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    ipfx_ingestion CollectorPolicyIpfxIngestionArgs
    An ipfx_ingestion block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    traffic_collector_id str
    Specifies the Azure Traffic Collector ID of the Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    location str
    Specifies the Azure Region where the Network Function Collector Policy should exist. Changing this forces a new Network Function Collector Policy to be created.
    name str
    Specifies the name which should be used for this Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Network Function Collector Policy.
    ipfxEmission Property Map
    An ipfx_emission block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    ipfxIngestion Property Map
    An ipfx_ingestion block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    trafficCollectorId String
    Specifies the Azure Traffic Collector ID of the Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    location String
    Specifies the Azure Region where the Network Function Collector Policy should exist. Changing this forces a new Network Function Collector Policy to be created.
    name String
    Specifies the name which should be used for this Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Network Function Collector Policy.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CollectorPolicy Resource

    Get an existing CollectorPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CollectorPolicyState, opts?: CustomResourceOptions): CollectorPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ipfx_emission: Optional[CollectorPolicyIpfxEmissionArgs] = None,
        ipfx_ingestion: Optional[CollectorPolicyIpfxIngestionArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        traffic_collector_id: Optional[str] = None) -> CollectorPolicy
    func GetCollectorPolicy(ctx *Context, name string, id IDInput, state *CollectorPolicyState, opts ...ResourceOption) (*CollectorPolicy, error)
    public static CollectorPolicy Get(string name, Input<string> id, CollectorPolicyState? state, CustomResourceOptions? opts = null)
    public static CollectorPolicy get(String name, Output<String> id, CollectorPolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    IpfxEmission CollectorPolicyIpfxEmission
    An ipfx_emission block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    IpfxIngestion CollectorPolicyIpfxIngestion
    An ipfx_ingestion block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    Location string
    Specifies the Azure Region where the Network Function Collector Policy should exist. Changing this forces a new Network Function Collector Policy to be created.
    Name string
    Specifies the name which should be used for this Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Network Function Collector Policy.
    TrafficCollectorId string
    Specifies the Azure Traffic Collector ID of the Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    IpfxEmission CollectorPolicyIpfxEmissionArgs
    An ipfx_emission block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    IpfxIngestion CollectorPolicyIpfxIngestionArgs
    An ipfx_ingestion block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    Location string
    Specifies the Azure Region where the Network Function Collector Policy should exist. Changing this forces a new Network Function Collector Policy to be created.
    Name string
    Specifies the name which should be used for this Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Network Function Collector Policy.
    TrafficCollectorId string
    Specifies the Azure Traffic Collector ID of the Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    ipfxEmission CollectorPolicyIpfxEmission
    An ipfx_emission block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    ipfxIngestion CollectorPolicyIpfxIngestion
    An ipfx_ingestion block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    location String
    Specifies the Azure Region where the Network Function Collector Policy should exist. Changing this forces a new Network Function Collector Policy to be created.
    name String
    Specifies the name which should be used for this Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Network Function Collector Policy.
    trafficCollectorId String
    Specifies the Azure Traffic Collector ID of the Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    ipfxEmission CollectorPolicyIpfxEmission
    An ipfx_emission block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    ipfxIngestion CollectorPolicyIpfxIngestion
    An ipfx_ingestion block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    location string
    Specifies the Azure Region where the Network Function Collector Policy should exist. Changing this forces a new Network Function Collector Policy to be created.
    name string
    Specifies the name which should be used for this Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Network Function Collector Policy.
    trafficCollectorId string
    Specifies the Azure Traffic Collector ID of the Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    ipfx_emission CollectorPolicyIpfxEmissionArgs
    An ipfx_emission block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    ipfx_ingestion CollectorPolicyIpfxIngestionArgs
    An ipfx_ingestion block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    location str
    Specifies the Azure Region where the Network Function Collector Policy should exist. Changing this forces a new Network Function Collector Policy to be created.
    name str
    Specifies the name which should be used for this Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Network Function Collector Policy.
    traffic_collector_id str
    Specifies the Azure Traffic Collector ID of the Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    ipfxEmission Property Map
    An ipfx_emission block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    ipfxIngestion Property Map
    An ipfx_ingestion block as defined below. Changing this forces a new Network Function Collector Policy to be created.
    location String
    Specifies the Azure Region where the Network Function Collector Policy should exist. Changing this forces a new Network Function Collector Policy to be created.
    name String
    Specifies the name which should be used for this Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Network Function Collector Policy.
    trafficCollectorId String
    Specifies the Azure Traffic Collector ID of the Network Function Collector Policy. Changing this forces a new Network Function Collector Policy to be created.

    Supporting Types

    CollectorPolicyIpfxEmission, CollectorPolicyIpfxEmissionArgs

    DestinationTypes string
    A list of emission destination types. The only possible value is AzureMonitor. Changing this forces a new Network Function Collector Policy to be created.
    DestinationTypes string
    A list of emission destination types. The only possible value is AzureMonitor. Changing this forces a new Network Function Collector Policy to be created.
    destinationTypes String
    A list of emission destination types. The only possible value is AzureMonitor. Changing this forces a new Network Function Collector Policy to be created.
    destinationTypes string
    A list of emission destination types. The only possible value is AzureMonitor. Changing this forces a new Network Function Collector Policy to be created.
    destination_types str
    A list of emission destination types. The only possible value is AzureMonitor. Changing this forces a new Network Function Collector Policy to be created.
    destinationTypes String
    A list of emission destination types. The only possible value is AzureMonitor. Changing this forces a new Network Function Collector Policy to be created.

    CollectorPolicyIpfxIngestion, CollectorPolicyIpfxIngestionArgs

    SourceResourceIds List<string>
    A list of ingestion source resource IDs. Changing this forces a new Network Function Collector Policy to be created.
    SourceResourceIds []string
    A list of ingestion source resource IDs. Changing this forces a new Network Function Collector Policy to be created.
    sourceResourceIds List<String>
    A list of ingestion source resource IDs. Changing this forces a new Network Function Collector Policy to be created.
    sourceResourceIds string[]
    A list of ingestion source resource IDs. Changing this forces a new Network Function Collector Policy to be created.
    source_resource_ids Sequence[str]
    A list of ingestion source resource IDs. Changing this forces a new Network Function Collector Policy to be created.
    sourceResourceIds List<String>
    A list of ingestion source resource IDs. Changing this forces a new Network Function Collector Policy to be created.

    Import

    Network Function Collector Policy can be imported using the resource id, e.g.

    $ pulumi import azure:networkfunction/collectorPolicy:CollectorPolicy example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/azureTrafficCollector1/collectorPolicies/collectorPolicy1

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure