Microsoft.NetworkFunction azureTrafficCollectors 2022-05-01

• Latest
• 2022-11-01
• 2022-08-01
• 2022-05-01
• 2021-09-01-preview

Bicep resource definition

The azureTrafficCollectors resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.NetworkFunction/azureTrafficCollectors resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.NetworkFunction/azureTrafficCollectors@2022-05-01' = {
  location: 'string'
  name: 'string'
  properties: {
    collectorPolicies: [
      {
        properties: {
          emissionPolicies: [
            {
              emissionDestinations: [
                {
                  destinationType: 'string'
                }
              ]
              emissionType: 'string'
            }
          ]
          ingestionPolicy: {
            ingestionSources: [
              {
                resourceId: 'string'
                sourceType: 'string'
              }
            ]
            ingestionType: 'string'
          }
        }
      }
    ]
    virtualHub: {}
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.NetworkFunction/azureTrafficCollectors

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the Azure Traffic Collector.	AzureTrafficCollectorPropertiesFormat
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

AzureTrafficCollectorPropertiesFormat

Name	Description	Value
collectorPolicies	Collector Policies for Azure Traffic Collector.	CollectorPolicy[]
virtualHub	The virtualHub to which the Azure Traffic Collector belongs.	ResourceReference

CollectorPolicy

Name	Description	Value
properties	Properties of the Collector Policy.	CollectorPolicyPropertiesFormat

CollectorPolicyPropertiesFormat

Name	Description	Value
emissionPolicies	Emission policies.	EmissionPoliciesPropertiesFormat[]
ingestionPolicy	Ingestion policies.	IngestionPolicyPropertiesFormat

EmissionPoliciesPropertiesFormat

Name	Description	Value
emissionDestinations	Emission policy destinations.	EmissionPolicyDestination[]
emissionType	Emission format type.	'IPFIX'

EmissionPolicyDestination

Name	Description	Value
destinationType	Emission destination type.	'AzureMonitor'

IngestionPolicyPropertiesFormat

Name	Description	Value
ingestionSources	Ingestion Sources.	IngestionSourcesPropertiesFormat[]
ingestionType	The ingestion type.	'IPFIX'

IngestionSourcesPropertiesFormat

Name	Description	Value
resourceId	Resource ID.	string
sourceType	Ingestion source type.	'Resource'

ResourceReference

Name	Description	Value

TrackedResourceTags

Name	Description	Value

ARM template resource definition

The azureTrafficCollectors resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.NetworkFunction/azureTrafficCollectors resource, add the following JSON to your template.

{
  "type": "Microsoft.NetworkFunction/azureTrafficCollectors",
  "apiVersion": "2022-05-01",
  "name": "string",
  "location": "string",
  "properties": {
    "collectorPolicies": [
      {
        "properties": {
          "emissionPolicies": [
            {
              "emissionDestinations": [
                {
                  "destinationType": "string"
                }
              ],
              "emissionType": "string"
            }
          ],
          "ingestionPolicy": {
            "ingestionSources": [
              {
                "resourceId": "string",
                "sourceType": "string"
              }
            ],
            "ingestionType": "string"
          }
        }
      }
    ],
    "virtualHub": {
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.NetworkFunction/azureTrafficCollectors

Name	Description	Value
apiVersion	The api version	'2022-05-01'
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the Azure Traffic Collector.	AzureTrafficCollectorPropertiesFormat
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.NetworkFunction/azureTrafficCollectors'

AzureTrafficCollectorPropertiesFormat

Name	Description	Value
collectorPolicies	Collector Policies for Azure Traffic Collector.	CollectorPolicy[]
virtualHub	The virtualHub to which the Azure Traffic Collector belongs.	ResourceReference

CollectorPolicy

Name	Description	Value
properties	Properties of the Collector Policy.	CollectorPolicyPropertiesFormat

CollectorPolicyPropertiesFormat

Name	Description	Value
emissionPolicies	Emission policies.	EmissionPoliciesPropertiesFormat[]
ingestionPolicy	Ingestion policies.	IngestionPolicyPropertiesFormat

EmissionPoliciesPropertiesFormat

Name	Description	Value
emissionDestinations	Emission policy destinations.	EmissionPolicyDestination[]
emissionType	Emission format type.	'IPFIX'

EmissionPolicyDestination

Name	Description	Value
destinationType	Emission destination type.	'AzureMonitor'

IngestionPolicyPropertiesFormat

Name	Description	Value
ingestionSources	Ingestion Sources.	IngestionSourcesPropertiesFormat[]
ingestionType	The ingestion type.	'IPFIX'

IngestionSourcesPropertiesFormat

Name	Description	Value
resourceId	Resource ID.	string
sourceType	Ingestion source type.	'Resource'

ResourceReference

Name	Description	Value

TrackedResourceTags

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

The azureTrafficCollectors resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.NetworkFunction/azureTrafficCollectors resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NetworkFunction/azureTrafficCollectors@2022-05-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      collectorPolicies = [
        {
          properties = {
            emissionPolicies = [
              {
                emissionDestinations = [
                  {
                    destinationType = "string"
                  }
                ]
                emissionType = "string"
              }
            ]
            ingestionPolicy = {
              ingestionSources = [
                {
                  resourceId = "string"
                  sourceType = "string"
                }
              ]
              ingestionType = "string"
            }
          }
        }
      ]
      virtualHub = {
      }
    }
  }
}

Property Values

Microsoft.NetworkFunction/azureTrafficCollectors

Name	Description	Value
location	Resource location.	string
name	The resource name	string (required)
properties	Properties of the Azure Traffic Collector.	AzureTrafficCollectorPropertiesFormat
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.NetworkFunction/azureTrafficCollectors@2022-05-01"

AzureTrafficCollectorPropertiesFormat

Name	Description	Value
collectorPolicies	Collector Policies for Azure Traffic Collector.	CollectorPolicy[]
virtualHub	The virtualHub to which the Azure Traffic Collector belongs.	ResourceReference

CollectorPolicy

Name	Description	Value
properties	Properties of the Collector Policy.	CollectorPolicyPropertiesFormat

CollectorPolicyPropertiesFormat

Name	Description	Value
emissionPolicies	Emission policies.	EmissionPoliciesPropertiesFormat[]
ingestionPolicy	Ingestion policies.	IngestionPolicyPropertiesFormat

EmissionPoliciesPropertiesFormat

Name	Description	Value
emissionDestinations	Emission policy destinations.	EmissionPolicyDestination[]
emissionType	Emission format type.	'IPFIX'

EmissionPolicyDestination

Name	Description	Value
destinationType	Emission destination type.	'AzureMonitor'

IngestionPolicyPropertiesFormat

Name	Description	Value
ingestionSources	Ingestion Sources.	IngestionSourcesPropertiesFormat[]
ingestionType	The ingestion type.	'IPFIX'

IngestionSourcesPropertiesFormat

Name	Description	Value
resourceId	Resource ID.	string
sourceType	Ingestion source type.	'Resource'

ResourceReference

Name	Description	Value

TrackedResourceTags

Name	Description	Value