1. Packages
  2. Azure Native
  3. API Docs
  4. networkfunction
  5. AzureTrafficCollector
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.38.0 published on Monday, Apr 22, 2024 by Pulumi

azure-native.networkfunction.AzureTrafficCollector

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.38.0 published on Monday, Apr 22, 2024 by Pulumi

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

    Other available API versions: 2022-08-01.

    Example Usage

    Create a traffic collector

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var azureTrafficCollector = new AzureNative.NetworkFunction.AzureTrafficCollector("azureTrafficCollector", new()
        {
            AzureTrafficCollectorName = "atc",
            Location = "West US",
            ResourceGroupName = "rg1",
            Tags = 
            {
                { "key1", "value1" },
            },
        });
    
    });
    
    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.NewAzureTrafficCollector(ctx, "azureTrafficCollector", &networkfunction.AzureTrafficCollectorArgs{
    			AzureTrafficCollectorName: pulumi.String("atc"),
    			Location:                  pulumi.String("West US"),
    			ResourceGroupName:         pulumi.String("rg1"),
    			Tags: pulumi.StringMap{
    				"key1": pulumi.String("value1"),
    			},
    		})
    		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.AzureTrafficCollector;
    import com.pulumi.azurenative.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 azureTrafficCollector = new AzureTrafficCollector("azureTrafficCollector", AzureTrafficCollectorArgs.builder()        
                .azureTrafficCollectorName("atc")
                .location("West US")
                .resourceGroupName("rg1")
                .tags(Map.of("key1", "value1"))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    azure_traffic_collector = azure_native.networkfunction.AzureTrafficCollector("azureTrafficCollector",
        azure_traffic_collector_name="atc",
        location="West US",
        resource_group_name="rg1",
        tags={
            "key1": "value1",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const azureTrafficCollector = new azure_native.networkfunction.AzureTrafficCollector("azureTrafficCollector", {
        azureTrafficCollectorName: "atc",
        location: "West US",
        resourceGroupName: "rg1",
        tags: {
            key1: "value1",
        },
    });
    
    resources:
      azureTrafficCollector:
        type: azure-native:networkfunction:AzureTrafficCollector
        properties:
          azureTrafficCollectorName: atc
          location: West US
          resourceGroupName: rg1
          tags:
            key1: value1
    

    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,
                              azure_traffic_collector_name: Optional[str] = None,
                              location: 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-native: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.

    Example

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

    var azureTrafficCollectorResource = new AzureNative.NetworkFunction.AzureTrafficCollector("azureTrafficCollectorResource", new()
    {
        ResourceGroupName = "string",
        AzureTrafficCollectorName = "string",
        Location = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := networkfunction.NewAzureTrafficCollector(ctx, "azureTrafficCollectorResource", &networkfunction.AzureTrafficCollectorArgs{
    ResourceGroupName: pulumi.String("string"),
    AzureTrafficCollectorName: pulumi.String("string"),
    Location: pulumi.String("string"),
    Tags: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    })
    
    var azureTrafficCollectorResource = new AzureTrafficCollector("azureTrafficCollectorResource", AzureTrafficCollectorArgs.builder()        
        .resourceGroupName("string")
        .azureTrafficCollectorName("string")
        .location("string")
        .tags(Map.of("string", "string"))
        .build());
    
    azure_traffic_collector_resource = azure_native.networkfunction.AzureTrafficCollector("azureTrafficCollectorResource",
        resource_group_name="string",
        azure_traffic_collector_name="string",
        location="string",
        tags={
            "string": "string",
        })
    
    const azureTrafficCollectorResource = new azure_native.networkfunction.AzureTrafficCollector("azureTrafficCollectorResource", {
        resourceGroupName: "string",
        azureTrafficCollectorName: "string",
        location: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:networkfunction:AzureTrafficCollector
    properties:
        azureTrafficCollectorName: string
        location: 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

    The AzureTrafficCollector resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group.
    AzureTrafficCollectorName string
    Azure Traffic Collector name
    Location string
    Resource location.
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    The name of the resource group.
    AzureTrafficCollectorName string
    Azure Traffic Collector name
    Location string
    Resource location.
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    The name of the resource group.
    azureTrafficCollectorName String
    Azure Traffic Collector name
    location String
    Resource location.
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    The name of the resource group.
    azureTrafficCollectorName string
    Azure Traffic Collector name
    location string
    Resource location.
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    The name of the resource group.
    azure_traffic_collector_name str
    Azure Traffic Collector name
    location str
    Resource location.
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    The name of the resource group.
    azureTrafficCollectorName String
    Azure Traffic Collector name
    location String
    Resource location.
    tags Map<String>
    Resource tags.

    Outputs

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

    CollectorPolicies List<Pulumi.AzureNative.NetworkFunction.Outputs.ResourceReferenceResponse>
    Collector Policies for Azure Traffic Collector.
    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 of the application rule collection resource.
    SystemData Pulumi.AzureNative.NetworkFunction.Outputs.TrackedResourceResponseSystemData
    Metadata pertaining to creation and last modification of the resource.
    Type string
    Resource type.
    VirtualHub Pulumi.AzureNative.NetworkFunction.Outputs.ResourceReferenceResponse
    The virtualHub to which the Azure Traffic Collector belongs.
    CollectorPolicies []ResourceReferenceResponse
    Collector Policies for Azure Traffic Collector.
    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 of the application rule collection resource.
    SystemData TrackedResourceResponseSystemData
    Metadata pertaining to creation and last modification of the resource.
    Type string
    Resource type.
    VirtualHub ResourceReferenceResponse
    The virtualHub to which the Azure Traffic Collector belongs.
    collectorPolicies List<ResourceReferenceResponse>
    Collector Policies for Azure Traffic Collector.
    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 of the application rule collection resource.
    systemData TrackedResourceResponseSystemData
    Metadata pertaining to creation and last modification of the resource.
    type String
    Resource type.
    virtualHub ResourceReferenceResponse
    The virtualHub to which the Azure Traffic Collector belongs.
    collectorPolicies ResourceReferenceResponse[]
    Collector Policies for Azure Traffic Collector.
    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 of the application rule collection resource.
    systemData TrackedResourceResponseSystemData
    Metadata pertaining to creation and last modification of the resource.
    type string
    Resource type.
    virtualHub ResourceReferenceResponse
    The virtualHub to which the Azure Traffic Collector belongs.
    collector_policies Sequence[ResourceReferenceResponse]
    Collector Policies for Azure Traffic Collector.
    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 of the application rule collection resource.
    system_data TrackedResourceResponseSystemData
    Metadata pertaining to creation and last modification of the resource.
    type str
    Resource type.
    virtual_hub ResourceReferenceResponse
    The virtualHub to which the Azure Traffic Collector belongs.
    collectorPolicies List<Property Map>
    Collector Policies for Azure Traffic Collector.
    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 of the application rule collection resource.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    Resource type.
    virtualHub Property Map
    The virtualHub to which the Azure Traffic Collector belongs.

    Supporting Types

    ResourceReferenceResponse, ResourceReferenceResponseArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    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:AzureTrafficCollector atc /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName} 
    

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi