Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. networkfunction
  5. CollectorPolicy
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.networkfunction.CollectorPolicy

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-azure-native

    Collector policy resource. Azure REST API version: 2022-11-01. Prior API version in Azure Native 1.x: 2022-05-01

    Example Usage

    Create a collection policy

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

return await Deployment.RunAsync(() => 
{
    var collectorPolicy = new AzureNative.NetworkFunction.CollectorPolicy("collectorPolicy", new()
    {
        AzureTrafficCollectorName = "atc",
        CollectorPolicyName = "cp1",
        EmissionPolicies = new[]
        {
            new AzureNative.NetworkFunction.Inputs.EmissionPoliciesPropertiesFormatArgs
            {
                EmissionDestinations = new[]
                {
                    new AzureNative.NetworkFunction.Inputs.EmissionPolicyDestinationArgs
                    {
                        DestinationType = "AzureMonitor",
                    },
                },
                EmissionType = "IPFIX",
            },
        },
        IngestionPolicy = new AzureNative.NetworkFunction.Inputs.IngestionPolicyPropertiesFormatArgs
        {
            IngestionSources = new[]
            {
                new AzureNative.NetworkFunction.Inputs.IngestionSourcesPropertiesFormatArgs
                {
                    ResourceId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName",
                    SourceType = "Resource",
                },
            },
            IngestionType = "IPFIX",
        },
        Location = "West US",
        ResourceGroupName = "rg1",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkfunction.NewCollectorPolicy(ctx, "collectorPolicy", &networkfunction.CollectorPolicyArgs{
			AzureTrafficCollectorName: pulumi.String("atc"),
			CollectorPolicyName:       pulumi.String("cp1"),
			EmissionPolicies: []networkfunction.EmissionPoliciesPropertiesFormatArgs{
				{
					EmissionDestinations: networkfunction.EmissionPolicyDestinationArray{
						{
							DestinationType: pulumi.String("AzureMonitor"),
						},
					},
					EmissionType: pulumi.String("IPFIX"),
				},
			},
			IngestionPolicy: networkfunction.IngestionPolicyPropertiesFormatResponse{
				IngestionSources: networkfunction.IngestionSourcesPropertiesFormatArray{
					&networkfunction.IngestionSourcesPropertiesFormatArgs{
						ResourceId: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName"),
						SourceType: pulumi.String("Resource"),
					},
				},
				IngestionType: pulumi.String("IPFIX"),
			},
			Location:          pulumi.String("West US"),
			ResourceGroupName: pulumi.String("rg1"),
		})
		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.networkfunction.CollectorPolicy;
import com.pulumi.azurenative.networkfunction.CollectorPolicyArgs;
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 collectorPolicy = new CollectorPolicy("collectorPolicy", CollectorPolicyArgs.builder()        
            .azureTrafficCollectorName("atc")
            .collectorPolicyName("cp1")
            .emissionPolicies(Map.ofEntries(
                Map.entry("emissionDestinations", Map.of("destinationType", "AzureMonitor")),
                Map.entry("emissionType", "IPFIX")
            ))
            .ingestionPolicy(Map.ofEntries(
                Map.entry("ingestionSources", Map.ofEntries(
                    Map.entry("resourceId", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName"),
                    Map.entry("sourceType", "Resource")
                )),
                Map.entry("ingestionType", "IPFIX")
            ))
            .location("West US")
            .resourceGroupName("rg1")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

collector_policy = azure_native.networkfunction.CollectorPolicy("collectorPolicy",
    azure_traffic_collector_name="atc",
    collector_policy_name="cp1",
    emission_policies=[{
        "emissionDestinations": [azure_native.networkfunction.EmissionPolicyDestinationArgs(
            destination_type="AzureMonitor",
        )],
        "emissionType": "IPFIX",
    }],
    ingestion_policy=azure_native.networkfunction.IngestionPolicyPropertiesFormatResponseArgs(
        ingestion_sources=[azure_native.networkfunction.IngestionSourcesPropertiesFormatArgs(
            resource_id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName",
            source_type="Resource",
        )],
        ingestion_type="IPFIX",
    ),
    location="West US",
    resource_group_name="rg1")

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

const collectorPolicy = new azure_native.networkfunction.CollectorPolicy("collectorPolicy", {
    azureTrafficCollectorName: "atc",
    collectorPolicyName: "cp1",
    emissionPolicies: [{
        emissionDestinations: [{
            destinationType: "AzureMonitor",
        }],
        emissionType: "IPFIX",
    }],
    ingestionPolicy: {
        ingestionSources: [{
            resourceId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName",
            sourceType: "Resource",
        }],
        ingestionType: "IPFIX",
    },
    location: "West US",
    resourceGroupName: "rg1",
});

    resources:
  collectorPolicy:
    type: azure-native:networkfunction:CollectorPolicy
    properties:
      azureTrafficCollectorName: atc
      collectorPolicyName: cp1
      emissionPolicies:
        - emissionDestinations:
            - destinationType: AzureMonitor
          emissionType: IPFIX
      ingestionPolicy:
        ingestionSources:
          - resourceId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName
            sourceType: Resource
        ingestionType: IPFIX
      location: West US
      resourceGroupName: rg1

    Create CollectorPolicy Resource

    new CollectorPolicy(name: string, args: CollectorPolicyArgs, opts?: CustomResourceOptions);
    @overload
def CollectorPolicy(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    azure_traffic_collector_name: Optional[str] = None,
                    collector_policy_name: Optional[str] = None,
                    emission_policies: Optional[Sequence[EmissionPoliciesPropertiesFormatArgs]] = None,
                    ingestion_policy: Optional[IngestionPolicyPropertiesFormatArgs] = None,
                    location: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None)
@overload
def CollectorPolicy(resource_name: str,
                    args: CollectorPolicyArgs,
                    opts: Optional[ResourceOptions] = 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-native:networkfunction:CollectorPolicy
properties: # The arguments to resource properties.
options: # 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.
    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.

    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

    The CollectorPolicy resource accepts the following input properties:

    AzureTrafficCollectorName string

    Azure Traffic Collector name

    ResourceGroupName string

    The name of the resource group.

    CollectorPolicyName string

    Collector Policy Name

    EmissionPolicies List<Pulumi.AzureNative.NetworkFunction.Inputs.EmissionPoliciesPropertiesFormat>

    Emission policies.

    IngestionPolicy Pulumi.AzureNative.NetworkFunction.Inputs.IngestionPolicyPropertiesFormat

    Ingestion policies.

    Location string

    Resource location.

    Tags Dictionary<string, string>

    Resource tags.

    AzureTrafficCollectorName string

    Azure Traffic Collector name

    ResourceGroupName string

    The name of the resource group.

    CollectorPolicyName string

    Collector Policy Name

    EmissionPolicies []EmissionPoliciesPropertiesFormatArgs

    Emission policies.

    IngestionPolicy IngestionPolicyPropertiesFormatArgs

    Ingestion policies.

    Location string

    Resource location.

    Tags map[string]string

    Resource tags.

    azureTrafficCollectorName String

    Azure Traffic Collector name

    resourceGroupName String

    The name of the resource group.

    collectorPolicyName String

    Collector Policy Name

    emissionPolicies List<EmissionPoliciesPropertiesFormat>

    Emission policies.

    ingestionPolicy IngestionPolicyPropertiesFormat

    Ingestion policies.

    location String

    Resource location.

    tags Map<String,String>

    Resource tags.

    azureTrafficCollectorName string

    Azure Traffic Collector name

    resourceGroupName string

    The name of the resource group.

    collectorPolicyName string

    Collector Policy Name

    emissionPolicies EmissionPoliciesPropertiesFormat[]

    Emission policies.

    ingestionPolicy IngestionPolicyPropertiesFormat

    Ingestion policies.

    location string

    Resource location.

    tags {[key: string]: string}

    Resource tags.

    azure_traffic_collector_name str

    Azure Traffic Collector name

    resource_group_name str

    The name of the resource group.

    collector_policy_name str

    Collector Policy Name

    emission_policies Sequence[EmissionPoliciesPropertiesFormatArgs]

    Emission policies.

    ingestion_policy IngestionPolicyPropertiesFormatArgs

    Ingestion policies.

    location str

    Resource location.

    tags Mapping[str, str]

    Resource tags.

    azureTrafficCollectorName String

    Azure Traffic Collector name

    resourceGroupName String

    The name of the resource group.

    collectorPolicyName String

    Collector Policy Name

    emissionPolicies List<Property Map>

    Emission policies.

    ingestionPolicy Property Map

    Ingestion policies.

    location String

    Resource location.

    tags Map<String>

    Resource tags.

    Outputs

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

    Etag string

    A unique read-only string that changes whenever the resource is updated.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    Resource name.

    ProvisioningState string

    The provisioning state.

    SystemData Pulumi.AzureNative.NetworkFunction.Outputs.TrackedResourceResponseSystemData

    Metadata pertaining to creation and last modification of the resource.

    Type string

    Resource type.

    Etag string

    A unique read-only string that changes whenever the resource is updated.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    Resource name.

    ProvisioningState string

    The provisioning state.

    SystemData TrackedResourceResponseSystemData

    Metadata pertaining to creation and last modification of the resource.

    Type string

    Resource type.

    etag String

    A unique read-only string that changes whenever the resource is updated.

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    Resource name.

    provisioningState String

    The provisioning state.

    systemData TrackedResourceResponseSystemData

    Metadata pertaining to creation and last modification of the resource.

    type String

    Resource type.

    etag string

    A unique read-only string that changes whenever the resource is updated.

    id string

    The provider-assigned unique ID for this managed resource.

    name string

    Resource name.

    provisioningState string

    The provisioning state.

    systemData TrackedResourceResponseSystemData

    Metadata pertaining to creation and last modification of the resource.

    type string

    Resource type.

    etag str

    A unique read-only string that changes whenever the resource is updated.

    id str

    The provider-assigned unique ID for this managed resource.

    name str

    Resource name.

    provisioning_state str

    The provisioning state.

    system_data TrackedResourceResponseSystemData

    Metadata pertaining to creation and last modification of the resource.

    type str

    Resource type.

    etag String

    A unique read-only string that changes whenever the resource is updated.

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    Resource name.

    provisioningState String

    The provisioning state.

    systemData Property Map

    Metadata pertaining to creation and last modification of the resource.

    type String

    Resource type.

    Supporting Types

    DestinationType, DestinationTypeArgs

    AzureMonitor
    AzureMonitor
    DestinationTypeAzureMonitor
    AzureMonitor
    AzureMonitor
    AzureMonitor
    AzureMonitor
    AzureMonitor
    AZURE_MONITOR
    AzureMonitor
    "AzureMonitor"
    AzureMonitor

    EmissionPoliciesPropertiesFormat, EmissionPoliciesPropertiesFormatArgs

    EmissionDestinations []EmissionPolicyDestination

    Emission policy destinations.

    EmissionType string | EmissionType

    Emission format type.

    emissionDestinations List<EmissionPolicyDestination>

    Emission policy destinations.

    emissionType String | EmissionType

    Emission format type.

    emissionDestinations EmissionPolicyDestination[]

    Emission policy destinations.

    emissionType string | EmissionType

    Emission format type.

    emission_destinations Sequence[EmissionPolicyDestination]

    Emission policy destinations.

    emission_type str | EmissionType

    Emission format type.

    emissionDestinations List<Property Map>

    Emission policy destinations.

    emissionType String | "IPFIX"

    Emission format type.

    EmissionPoliciesPropertiesFormatResponse, EmissionPoliciesPropertiesFormatResponseArgs

    EmissionDestinations []EmissionPolicyDestinationResponse

    Emission policy destinations.

    EmissionType string

    Emission format type.

    emissionDestinations List<EmissionPolicyDestinationResponse>

    Emission policy destinations.

    emissionType String

    Emission format type.

    emissionDestinations EmissionPolicyDestinationResponse[]

    Emission policy destinations.

    emissionType string

    Emission format type.

    emission_destinations Sequence[EmissionPolicyDestinationResponse]

    Emission policy destinations.

    emission_type str

    Emission format type.

    emissionDestinations List<Property Map>

    Emission policy destinations.

    emissionType String

    Emission format type.

    EmissionPolicyDestination, EmissionPolicyDestinationArgs

    DestinationType string | DestinationType

    Emission destination type.

    destinationType String | DestinationType

    Emission destination type.

    destinationType string | DestinationType

    Emission destination type.

    destination_type str | DestinationType

    Emission destination type.

    destinationType String | "AzureMonitor"

    Emission destination type.

    EmissionPolicyDestinationResponse, EmissionPolicyDestinationResponseArgs

    DestinationType string

    Emission destination type.

    DestinationType string

    Emission destination type.

    destinationType String

    Emission destination type.

    destinationType string

    Emission destination type.

    destination_type str

    Emission destination type.

    destinationType String

    Emission destination type.

    EmissionType, EmissionTypeArgs

    IPFIX
    IPFIX
    EmissionTypeIPFIX
    IPFIX
    IPFIX
    IPFIX
    IPFIX
    IPFIX
    IPFIX
    IPFIX
    "IPFIX"
    IPFIX

    IngestionPolicyPropertiesFormat, IngestionPolicyPropertiesFormatArgs

    ingestionSources List<Property Map>

    Ingestion Sources.

    ingestionType String | "IPFIX"

    The ingestion type.

    IngestionPolicyPropertiesFormatResponse, IngestionPolicyPropertiesFormatResponseArgs

    ingestionSources List<Property Map>

    Ingestion Sources.

    ingestionType String

    The ingestion type.

    IngestionSourcesPropertiesFormat, IngestionSourcesPropertiesFormatArgs

    ResourceId string

    Resource ID.

    SourceType string | Pulumi.AzureNative.NetworkFunction.SourceType

    Ingestion source type.

    ResourceId string

    Resource ID.

    SourceType string | SourceType

    Ingestion source type.

    resourceId String

    Resource ID.

    sourceType String | SourceType

    Ingestion source type.

    resourceId string

    Resource ID.

    sourceType string | SourceType

    Ingestion source type.

    resource_id str

    Resource ID.

    source_type str | SourceType

    Ingestion source type.

    resourceId String

    Resource ID.

    sourceType String | "Resource"

    Ingestion source type.

    IngestionSourcesPropertiesFormatResponse, IngestionSourcesPropertiesFormatResponseArgs

    ResourceId string

    Resource ID.

    SourceType string

    Ingestion source type.

    ResourceId string

    Resource ID.

    SourceType string

    Ingestion source type.

    resourceId String

    Resource ID.

    sourceType String

    Ingestion source type.

    resourceId string

    Resource ID.

    sourceType string

    Ingestion source type.

    resource_id str

    Resource ID.

    source_type str

    Ingestion source type.

    resourceId String

    Resource ID.

    sourceType String

    Ingestion source type.

    IngestionType, IngestionTypeArgs

    IPFIX
    IPFIX
    IngestionTypeIPFIX
    IPFIX
    IPFIX
    IPFIX
    IPFIX
    IPFIX
    IPFIX
    IPFIX
    "IPFIX"
    IPFIX

    SourceType, SourceTypeArgs

    Resource
    Resource
    SourceTypeResource
    Resource
    Resource
    Resource
    Resource
    Resource
    RESOURCE
    Resource
    "Resource"
    Resource

    TrackedResourceResponseSystemData, TrackedResourceResponseSystemDataArgs

    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.

    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.

    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.

    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.

    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_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.

    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:networkfunction:CollectorPolicy cp1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}/collectorPolicies/{collectorPolicyName}

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi
    pulumi/pulumi-azure-native