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

We recommend using Azure Native.

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

azure.networkfunction.AzureTrafficCollector

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 Azure Traffic Collector.

    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",
});
const exampleAzureTrafficCollector = new azure.networkfunction.AzureTrafficCollector("example", {
    name: "example-nfatc",
    resourceGroupName: example.name,
    location: "West US",
    tags: {
        key: "value",
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West US")
example_azure_traffic_collector = azure.networkfunction.AzureTrafficCollector("example",
    name="example-nfatc",
    resource_group_name=example.name,
    location="West US",
    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/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"),
		})
		if err != nil {
			return err
		}
		_, err = networkfunction.NewAzureTrafficCollector(ctx, "example", &networkfunction.AzureTrafficCollectorArgs{
			Name:              pulumi.String("example-nfatc"),
			ResourceGroupName: example.Name,
			Location:          pulumi.String("West US"),
			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",
    });

    var exampleAzureTrafficCollector = new Azure.NetworkFunction.AzureTrafficCollector("example", new()
    {
        Name = "example-nfatc",
        ResourceGroupName = example.Name,
        Location = "West US",
        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.networkfunction.AzureTrafficCollector;
import com.pulumi.azure.networkfunction.AzureTrafficCollectorArgs;
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")
            .build());

        var exampleAzureTrafficCollector = new AzureTrafficCollector("exampleAzureTrafficCollector", AzureTrafficCollectorArgs.builder()
            .name("example-nfatc")
            .resourceGroupName(example.name())
            .location("West US")
            .tags(Map.of("key", "value"))
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West US
  exampleAzureTrafficCollector:
    type: azure:networkfunction:AzureTrafficCollector
    name: example
    properties:
      name: example-nfatc
      resourceGroupName: ${example.name}
      location: West US
      tags:
        key: value

    Create AzureTrafficCollector Resource

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

    Constructor syntax

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

@overload
def AzureTrafficCollector(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          resource_group_name: Optional[str] = None,
                          location: Optional[str] = None,
                          name: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None)
    func NewAzureTrafficCollector(ctx *Context, name string, args AzureTrafficCollectorArgs, opts ...ResourceOption) (*AzureTrafficCollector, error)
    public AzureTrafficCollector(string name, AzureTrafficCollectorArgs args, CustomResourceOptions? opts = null)
    public AzureTrafficCollector(String name, AzureTrafficCollectorArgs args)
public AzureTrafficCollector(String name, AzureTrafficCollectorArgs args, CustomResourceOptions options)

    type: azure:networkfunction:AzureTrafficCollector
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 AzureTrafficCollectorArgs
    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 AzureTrafficCollectorArgs
    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 AzureTrafficCollectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AzureTrafficCollectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AzureTrafficCollectorArgs
    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 azureTrafficCollectorResource = new Azure.NetworkFunction.AzureTrafficCollector("azureTrafficCollectorResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := networkfunction.NewAzureTrafficCollector(ctx, "azureTrafficCollectorResource", &networkfunction.AzureTrafficCollectorArgs{
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var azureTrafficCollectorResource = new AzureTrafficCollector("azureTrafficCollectorResource", AzureTrafficCollectorArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    azure_traffic_collector_resource = azure.networkfunction.AzureTrafficCollector("azureTrafficCollectorResource",
    resource_group_name="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })

    const azureTrafficCollectorResource = new azure.networkfunction.AzureTrafficCollector("azureTrafficCollectorResource", {
    resourceGroupName: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: azure:networkfunction:AzureTrafficCollector
properties:
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string

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

    ResourceGroupName string
    Specifies the name of the Resource Group where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    Location string
    Specifies the Azure Region where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    Name string
    Specifies the name which should be used for this Network Function Azure Traffic Collector. Changing this forces a new Network Function Azure Traffic Collector to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Network Function Azure Traffic Collector.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    Location string
    Specifies the Azure Region where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    Name string
    Specifies the name which should be used for this Network Function Azure Traffic Collector. Changing this forces a new Network Function Azure Traffic Collector to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Network Function Azure Traffic Collector.
    resourceGroupName String
    Specifies the name of the Resource Group where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    location String
    Specifies the Azure Region where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    name String
    Specifies the name which should be used for this Network Function Azure Traffic Collector. Changing this forces a new Network Function Azure Traffic Collector to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Network Function Azure Traffic Collector.
    resourceGroupName string
    Specifies the name of the Resource Group where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    location string
    Specifies the Azure Region where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    name string
    Specifies the name which should be used for this Network Function Azure Traffic Collector. Changing this forces a new Network Function Azure Traffic Collector to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Network Function Azure Traffic Collector.
    resource_group_name str
    Specifies the name of the Resource Group where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    location str
    Specifies the Azure Region where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    name str
    Specifies the name which should be used for this Network Function Azure Traffic Collector. Changing this forces a new Network Function Azure Traffic Collector to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Network Function Azure Traffic Collector.
    resourceGroupName String
    Specifies the name of the Resource Group where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    location String
    Specifies the Azure Region where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    name String
    Specifies the name which should be used for this Network Function Azure Traffic Collector. Changing this forces a new Network Function Azure Traffic Collector to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Network Function Azure Traffic Collector.

    Outputs

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

    CollectorPolicyIds List<string>
    The list of Resource IDs of collector policies.
    Id string
    The provider-assigned unique ID for this managed resource.
    VirtualHubIds List<string>
    The Resource ID of virtual hub.
    CollectorPolicyIds []string
    The list of Resource IDs of collector policies.
    Id string
    The provider-assigned unique ID for this managed resource.
    VirtualHubIds []string
    The Resource ID of virtual hub.
    collectorPolicyIds List<String>
    The list of Resource IDs of collector policies.
    id String
    The provider-assigned unique ID for this managed resource.
    virtualHubIds List<String>
    The Resource ID of virtual hub.
    collectorPolicyIds string[]
    The list of Resource IDs of collector policies.
    id string
    The provider-assigned unique ID for this managed resource.
    virtualHubIds string[]
    The Resource ID of virtual hub.
    collector_policy_ids Sequence[str]
    The list of Resource IDs of collector policies.
    id str
    The provider-assigned unique ID for this managed resource.
    virtual_hub_ids Sequence[str]
    The Resource ID of virtual hub.
    collectorPolicyIds List<String>
    The list of Resource IDs of collector policies.
    id String
    The provider-assigned unique ID for this managed resource.
    virtualHubIds List<String>
    The Resource ID of virtual hub.

    Look up Existing AzureTrafficCollector Resource

    Get an existing AzureTrafficCollector 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?: AzureTrafficCollectorState, opts?: CustomResourceOptions): AzureTrafficCollector
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        collector_policy_ids: Optional[Sequence[str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        virtual_hub_ids: Optional[Sequence[str]] = None) -> AzureTrafficCollector
    func GetAzureTrafficCollector(ctx *Context, name string, id IDInput, state *AzureTrafficCollectorState, opts ...ResourceOption) (*AzureTrafficCollector, error)
    public static AzureTrafficCollector Get(string name, Input<string> id, AzureTrafficCollectorState? state, CustomResourceOptions? opts = null)
    public static AzureTrafficCollector get(String name, Output<String> id, AzureTrafficCollectorState 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:
    CollectorPolicyIds List<string>
    The list of Resource IDs of collector policies.
    Location string
    Specifies the Azure Region where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    Name string
    Specifies the name which should be used for this Network Function Azure Traffic Collector. Changing this forces a new Network Function Azure Traffic Collector to be created.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Network Function Azure Traffic Collector.
    VirtualHubIds List<string>
    The Resource ID of virtual hub.
    CollectorPolicyIds []string
    The list of Resource IDs of collector policies.
    Location string
    Specifies the Azure Region where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    Name string
    Specifies the name which should be used for this Network Function Azure Traffic Collector. Changing this forces a new Network Function Azure Traffic Collector to be created.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Network Function Azure Traffic Collector.
    VirtualHubIds []string
    The Resource ID of virtual hub.
    collectorPolicyIds List<String>
    The list of Resource IDs of collector policies.
    location String
    Specifies the Azure Region where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    name String
    Specifies the name which should be used for this Network Function Azure Traffic Collector. Changing this forces a new Network Function Azure Traffic Collector to be created.
    resourceGroupName String
    Specifies the name of the Resource Group where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Network Function Azure Traffic Collector.
    virtualHubIds List<String>
    The Resource ID of virtual hub.
    collectorPolicyIds string[]
    The list of Resource IDs of collector policies.
    location string
    Specifies the Azure Region where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    name string
    Specifies the name which should be used for this Network Function Azure Traffic Collector. Changing this forces a new Network Function Azure Traffic Collector to be created.
    resourceGroupName string
    Specifies the name of the Resource Group where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Network Function Azure Traffic Collector.
    virtualHubIds string[]
    The Resource ID of virtual hub.
    collector_policy_ids Sequence[str]
    The list of Resource IDs of collector policies.
    location str
    Specifies the Azure Region where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    name str
    Specifies the name which should be used for this Network Function Azure Traffic Collector. Changing this forces a new Network Function Azure Traffic Collector to be created.
    resource_group_name str
    Specifies the name of the Resource Group where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Network Function Azure Traffic Collector.
    virtual_hub_ids Sequence[str]
    The Resource ID of virtual hub.
    collectorPolicyIds List<String>
    The list of Resource IDs of collector policies.
    location String
    Specifies the Azure Region where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    name String
    Specifies the name which should be used for this Network Function Azure Traffic Collector. Changing this forces a new Network Function Azure Traffic Collector to be created.
    resourceGroupName String
    Specifies the name of the Resource Group where the Network Function Azure Traffic Collector should exist. Changing this forces a new Network Function Azure Traffic Collector to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Network Function Azure Traffic Collector.
    virtualHubIds List<String>
    The Resource ID of virtual hub.

    Import

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

    $ pulumi import azure:networkfunction/azureTrafficCollector:AzureTrafficCollector example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/azureTrafficCollector1

    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