Microsoft.Monitor pipelineGroups

Bicep resource definition

The pipelineGroups 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.Monitor/pipelineGroups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Monitor/pipelineGroups@2026-04-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    executionPlacement: {
      constraints: [
        {
          capability: 'string'
          operator: 'string'
          values: [
            'string'
          ]
        }
      ]
      distribution: {
        maxInstancesPerHost: int
      }
    }
    exporters: [
      {
        azureMonitorWorkspaceLogs: {
          api: {
            dataCollectionEndpointUrl: 'string'
            dataCollectionRule: 'string'
            schema: {
              recordMap: [
                {
                  from: 'string'
                  to: 'string'
                }
              ]
              resourceMap: [
                {
                  from: 'string'
                  to: 'string'
                }
              ]
              scopeMap: [
                {
                  from: 'string'
                  to: 'string'
                }
              ]
            }
            stream: 'string'
          }
          persistence: {
            maxStorageUsage: int
            retentionPeriod: int
          }
        }
        name: 'string'
        type: 'string'
      }
    ]
    processors: [
      {
        batch: {
          batchSize: int
          timeout: int
        }
        name: 'string'
        transformLanguage: {
          transformStatement: 'string'
        }
        type: 'string'
      }
    ]
    receivers: [
      {
        name: 'string'
        otlp: {
          endpoint: 'string'
        }
        syslog: {
          allowedFormats: [
            'string'
          ]
          allowSkipPriHeader: bool
          endpoint: 'string'
          transportProtocol: 'string'
        }
        tlsConfiguration: 'string'
        type: 'string'
      }
    ]
    replicas: int
    service: {
      persistence: {
        persistentVolumeName: 'string'
      }
      pipelines: [
        {
          exporters: [
            'string'
          ]
          name: 'string'
          processors: [
            'string'
          ]
          receivers: [
            'string'
          ]
          type: 'string'
        }
      ]
    }
    tlsConfigurations: [
      {
        clientCa: {
          location: 'string'
          subLocation: 'string'
          type: 'string'
        }
        mode: 'string'
        name: 'string'
        tlsCertificate: {
          certificate: {
            location: 'string'
            subLocation: 'string'
            type: 'string'
          }
          privateKey: {
            location: 'string'
            subLocation: 'string'
            type: 'string'
          }
        }
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Monitor/pipelineGroups

Name	Description	Value
extendedLocation	The complex type of the extended location.	AzureResourceManagerCommonTypesExtendedLocation
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
properties	The resource-specific properties for this resource.	PipelineGroupProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

AzureMonitorWorkspaceLogsApiConfig

Name	Description	Value
dataCollectionEndpointUrl	Data collection endpoint ingestion url.	string Constraints: Pattern = `^(https?)://[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*$` (required)
dataCollectionRule	Data Collection Rule (DCR) immutable id.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9.-]{1,1000}[^-]$` (required)
schema	The schema mapping for incoming data.	SchemaMap (required)
stream	Stream name in destination. Azure Monitor stream is related to the destination table.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9._-]{1,1000}[^-]$` (required)

AzureMonitorWorkspaceLogsExporter

Name	Description	Value
api	API configurations for Azure Monitor workspace exporter.	AzureMonitorWorkspaceLogsApiConfig (required)
persistence	Persistence options for the exporter.	ExporterPersistenceConfiguration

AzureResourceManagerCommonTypesExtendedLocation

Name	Description	Value
name	The name of the extended location.	string (required)
type	The type of the extended location.	'CustomLocation' 'EdgeZone' (required)

BatchProcessor

Name	Description	Value
batchSize	Size of the batch.	int Constraints: Min value = 10 Max value = 100000
timeout	Timeout in milliseconds.	int Constraints: Min value = 10 Max value = 300000

CertificateSource

Name	Description	Value
location	Location of the certificate source.	string (required)
subLocation	Sub-location within the certificate source.	string (required)
type	The type of certificate source.	'kubernetesConfigMap' 'kubernetesSecret' (required)

CertificateWithKey

Name	Description	Value
certificate	Source configuration for the TLS certificate.	CertificateSource (required)
privateKey	Source configuration for the private key. Private keys must be stored in Kubernetes secrets for security reasons.	PrivateKeySource (required)

DistributionPolicy

Name	Description	Value
maxInstancesPerHost	Maximum number of instances allowed per compute unit (node/VM). If not specified, default scheduling applies.	int Constraints: Min value = 1

ExecutionPlacement

Name	Description	Value
constraints	A list of placement constraints to guide where pipelineGroup instances should run.	PlacementConstraint[]
distribution	Distribution policy for spreading instances across compute units (nodes/VMs).	DistributionPolicy

Exporter

Name	Description	Value
azureMonitorWorkspaceLogs	Azure Monitor Workspace Logs specific configurations.	AzureMonitorWorkspaceLogsExporter
name	The name of exporter.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
type	The type of exporter.	'AzureMonitorWorkspaceLogs' (required)

ExporterPersistenceConfiguration

Name	Description	Value
maxStorageUsage	Max storage usage in gigabytes.	int Constraints: Min value = 1
retentionPeriod	Retention period in minutes.	int Constraints: Min value = 1

OtlpReceiver

Name	Description	Value
endpoint	OTLP GRPC endpoint definition. Example: 0.0.0.0:<port>.	string Constraints: Pattern = `^[a-zA-Z0-9-\.]+:[0-9]+$` (required)

PersistenceConfigurations

Name	Description	Value
persistentVolumeName	The name of the mounted persistent volume.	string (required)

Pipeline

Name	Description	Value
exporters	Reference to exporters configured for the pipeline.	string[] (required)
name	Name of the pipeline.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
processors	Reference to processors configured for the pipeline.	string[]
receivers	Reference to receivers configured for the pipeline.	string[] (required)
type	The type of pipeline	'Logs' (required)

PipelineGroupProperties

Name	Description	Value
executionPlacement	Constraints for guiding the execution environment of the pipeline group.	ExecutionPlacement
exporters	The exporters specified for a pipeline group instance.	Exporter[] (required)
processors	The processors specified for a pipeline group instance.	Processor[] (required)
receivers	The receivers specified for a pipeline group instance.	Receiver[] (required)
replicas	Defines the amount of replicas of the pipeline group instance.	int Constraints: Min value = 1
service	The service section for a given pipeline group instance.	Service (required)
tlsConfigurations	TLS configurations for the pipeline group instance.	TlsConfiguration[]

PlacementConstraint

Name	Description	Value
capability	The capability or attribute key used to match compute unit properties.	string (required)
operator	The match operator, e.g., In, NotIn, Exists, DoesNotExist.	'DoesNotExist' 'Exists' 'In' 'NotIn' (required)
values	The values to match against. Not required for Exists/DoesNotExist.	string[]

PrivateKeySource

Name	Description	Value
location	Location of the private key source.	string (required)
subLocation	Sub-location within the private key source.	string (required)
type	The type of private key source. Only kubernetesSecret is supported for security reasons.	'kubernetesSecret' (required)

Processor

Name	Description	Value
batch	Batch processor configurations.	BatchProcessor
name	The name of processor.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
transformLanguage	Transform language processor configurations.	TransformLanguageProcessor
type	The type of processor.	'Batch' 'MicrosoftCommonSecurityLog' 'MicrosoftSyslog' 'TransformLanguage' (required)

Receiver

Name	Description	Value
name	The name of receiver.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
otlp	OTLP receiver configurations. This field is mandatory for OTLP receivers.	OtlpReceiver
syslog	Syslog configurations. This field is mandatory for syslog type receivers.	SyslogReceiver
tlsConfiguration	Reference to a named TLS configuration. If not specified, default TLS configuration is used.	string
type	The type of receiver.	'OTLP' 'Syslog' (required)

RecordMap

Name	Description	Value
from	Record Map Key.	string (required)
to	Record Map Value.	string (required)

ResourceMap

Name	Description	Value
from	Resource Map Key.	string (required)
to	Resource Map Value.	string (required)

SchemaMap

Name	Description	Value
recordMap	Record Map.	RecordMap[] (required)
resourceMap	Resource Map captures information about the entity for which telemetry is recorded. For example, metrics exposed by a Kubernetes container can be linked to a resource that specifies the cluster, namespace, pod, and container name.Resource may capture an entire hierarchy of entity identification. It may describe the host in the cloud and specific container or an application running in the process.	ResourceMap[]
scopeMap	A scope map is a logical unit of the application code with which the emitted telemetry can be associated.	ScopeMap[]

ScopeMap

Name	Description	Value
from	Scope Map Key.	string (required)
to	Scope Map Value.	string (required)

Service

Name	Description	Value
persistence	Persistence options to all pipelines in the instance.	PersistenceConfigurations
pipelines	Pipelines belonging to a given pipeline group.	Pipeline[] (required)

SyslogReceiver

Name	Description	Value
allowedFormats	List of allowed message formats for syslog/CEF ingestion. Default 'all'.	String array containing any of: 'all' 'cefRfc3164' 'cefRfc5424' 'rawCef' 'syslogRfc3164' 'syslogRfc5424'
allowSkipPriHeader	Configure the receiver to allow parsing of messages without the PRI header. Default false.	bool
endpoint	Syslog receiver endpoint definition. Example: 0.0.0.0:<port>.	string Constraints: Pattern = `^[a-zA-Z0-9-\.]+:[0-9]+$` (required)
transportProtocol	Transport protocol. Default tcp.	'tcp' 'udp'

TlsConfiguration

Name	Description	Value
clientCa	Certificate source configuration for the client CA certificate for validating client certificates. If not specified, default CA certificates are used.	CertificateSource
mode	The TLS security mode for receivers using this configuration. Default is 'mutualTls'.	'disabled' 'mutualTls' 'serverOnly'
name	The name of the TLS configuration.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
tlsCertificate	TLS certificate and its private key. If not specified, default TLS certificate is used.	CertificateWithKey

TrackedResourceTags

Name	Description	Value

TransformLanguageProcessor

Name	Description	Value
transformStatement	Transform statement to execute over the data passing through the processor.	string Constraints: Min length = 1 Max length = 10000 (required)

ARM template resource definition

The pipelineGroups 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.

Usage Examples

Resource format

To create a Microsoft.Monitor/pipelineGroups resource, add the following JSON to your template.

{
  "type": "Microsoft.Monitor/pipelineGroups",
  "apiVersion": "2026-04-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "executionPlacement": {
      "constraints": [
        {
          "capability": "string",
          "operator": "string",
          "values": [ "string" ]
        }
      ],
      "distribution": {
        "maxInstancesPerHost": "int"
      }
    },
    "exporters": [
      {
        "azureMonitorWorkspaceLogs": {
          "api": {
            "dataCollectionEndpointUrl": "string",
            "dataCollectionRule": "string",
            "schema": {
              "recordMap": [
                {
                  "from": "string",
                  "to": "string"
                }
              ],
              "resourceMap": [
                {
                  "from": "string",
                  "to": "string"
                }
              ],
              "scopeMap": [
                {
                  "from": "string",
                  "to": "string"
                }
              ]
            },
            "stream": "string"
          },
          "persistence": {
            "maxStorageUsage": "int",
            "retentionPeriod": "int"
          }
        },
        "name": "string",
        "type": "string"
      }
    ],
    "processors": [
      {
        "batch": {
          "batchSize": "int",
          "timeout": "int"
        },
        "name": "string",
        "transformLanguage": {
          "transformStatement": "string"
        },
        "type": "string"
      }
    ],
    "receivers": [
      {
        "name": "string",
        "otlp": {
          "endpoint": "string"
        },
        "syslog": {
          "allowedFormats": [ "string" ],
          "allowSkipPriHeader": "bool",
          "endpoint": "string",
          "transportProtocol": "string"
        },
        "tlsConfiguration": "string",
        "type": "string"
      }
    ],
    "replicas": "int",
    "service": {
      "persistence": {
        "persistentVolumeName": "string"
      },
      "pipelines": [
        {
          "exporters": [ "string" ],
          "name": "string",
          "processors": [ "string" ],
          "receivers": [ "string" ],
          "type": "string"
        }
      ]
    },
    "tlsConfigurations": [
      {
        "clientCa": {
          "location": "string",
          "subLocation": "string",
          "type": "string"
        },
        "mode": "string",
        "name": "string",
        "tlsCertificate": {
          "certificate": {
            "location": "string",
            "subLocation": "string",
            "type": "string"
          },
          "privateKey": {
            "location": "string",
            "subLocation": "string",
            "type": "string"
          }
        }
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Monitor/pipelineGroups

Name	Description	Value
apiVersion	The api version	'2026-04-01'
extendedLocation	The complex type of the extended location.	AzureResourceManagerCommonTypesExtendedLocation
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
properties	The resource-specific properties for this resource.	PipelineGroupProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Monitor/pipelineGroups'

AzureMonitorWorkspaceLogsApiConfig

Name	Description	Value
dataCollectionEndpointUrl	Data collection endpoint ingestion url.	string Constraints: Pattern = `^(https?)://[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*$` (required)
dataCollectionRule	Data Collection Rule (DCR) immutable id.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9.-]{1,1000}[^-]$` (required)
schema	The schema mapping for incoming data.	SchemaMap (required)
stream	Stream name in destination. Azure Monitor stream is related to the destination table.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9._-]{1,1000}[^-]$` (required)

AzureMonitorWorkspaceLogsExporter

Name	Description	Value
api	API configurations for Azure Monitor workspace exporter.	AzureMonitorWorkspaceLogsApiConfig (required)
persistence	Persistence options for the exporter.	ExporterPersistenceConfiguration

AzureResourceManagerCommonTypesExtendedLocation

Name	Description	Value
name	The name of the extended location.	string (required)
type	The type of the extended location.	'CustomLocation' 'EdgeZone' (required)

BatchProcessor

Name	Description	Value
batchSize	Size of the batch.	int Constraints: Min value = 10 Max value = 100000
timeout	Timeout in milliseconds.	int Constraints: Min value = 10 Max value = 300000

CertificateSource

Name	Description	Value
location	Location of the certificate source.	string (required)
subLocation	Sub-location within the certificate source.	string (required)
type	The type of certificate source.	'kubernetesConfigMap' 'kubernetesSecret' (required)

CertificateWithKey

Name	Description	Value
certificate	Source configuration for the TLS certificate.	CertificateSource (required)
privateKey	Source configuration for the private key. Private keys must be stored in Kubernetes secrets for security reasons.	PrivateKeySource (required)

DistributionPolicy

Name	Description	Value
maxInstancesPerHost	Maximum number of instances allowed per compute unit (node/VM). If not specified, default scheduling applies.	int Constraints: Min value = 1

ExecutionPlacement

Name	Description	Value
constraints	A list of placement constraints to guide where pipelineGroup instances should run.	PlacementConstraint[]
distribution	Distribution policy for spreading instances across compute units (nodes/VMs).	DistributionPolicy

Exporter

Name	Description	Value
azureMonitorWorkspaceLogs	Azure Monitor Workspace Logs specific configurations.	AzureMonitorWorkspaceLogsExporter
name	The name of exporter.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
type	The type of exporter.	'AzureMonitorWorkspaceLogs' (required)

ExporterPersistenceConfiguration

Name	Description	Value
maxStorageUsage	Max storage usage in gigabytes.	int Constraints: Min value = 1
retentionPeriod	Retention period in minutes.	int Constraints: Min value = 1

OtlpReceiver

Name	Description	Value
endpoint	OTLP GRPC endpoint definition. Example: 0.0.0.0:<port>.	string Constraints: Pattern = `^[a-zA-Z0-9-\.]+:[0-9]+$` (required)

PersistenceConfigurations

Name	Description	Value
persistentVolumeName	The name of the mounted persistent volume.	string (required)

Pipeline

Name	Description	Value
exporters	Reference to exporters configured for the pipeline.	string[] (required)
name	Name of the pipeline.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
processors	Reference to processors configured for the pipeline.	string[]
receivers	Reference to receivers configured for the pipeline.	string[] (required)
type	The type of pipeline	'Logs' (required)

PipelineGroupProperties

Name	Description	Value
executionPlacement	Constraints for guiding the execution environment of the pipeline group.	ExecutionPlacement
exporters	The exporters specified for a pipeline group instance.	Exporter[] (required)
processors	The processors specified for a pipeline group instance.	Processor[] (required)
receivers	The receivers specified for a pipeline group instance.	Receiver[] (required)
replicas	Defines the amount of replicas of the pipeline group instance.	int Constraints: Min value = 1
service	The service section for a given pipeline group instance.	Service (required)
tlsConfigurations	TLS configurations for the pipeline group instance.	TlsConfiguration[]

PlacementConstraint

Name	Description	Value
capability	The capability or attribute key used to match compute unit properties.	string (required)
operator	The match operator, e.g., In, NotIn, Exists, DoesNotExist.	'DoesNotExist' 'Exists' 'In' 'NotIn' (required)
values	The values to match against. Not required for Exists/DoesNotExist.	string[]

PrivateKeySource

Name	Description	Value
location	Location of the private key source.	string (required)
subLocation	Sub-location within the private key source.	string (required)
type	The type of private key source. Only kubernetesSecret is supported for security reasons.	'kubernetesSecret' (required)

Processor

Name	Description	Value
batch	Batch processor configurations.	BatchProcessor
name	The name of processor.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
transformLanguage	Transform language processor configurations.	TransformLanguageProcessor
type	The type of processor.	'Batch' 'MicrosoftCommonSecurityLog' 'MicrosoftSyslog' 'TransformLanguage' (required)

Receiver

Name	Description	Value
name	The name of receiver.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
otlp	OTLP receiver configurations. This field is mandatory for OTLP receivers.	OtlpReceiver
syslog	Syslog configurations. This field is mandatory for syslog type receivers.	SyslogReceiver
tlsConfiguration	Reference to a named TLS configuration. If not specified, default TLS configuration is used.	string
type	The type of receiver.	'OTLP' 'Syslog' (required)

RecordMap

Name	Description	Value
from	Record Map Key.	string (required)
to	Record Map Value.	string (required)

ResourceMap

Name	Description	Value
from	Resource Map Key.	string (required)
to	Resource Map Value.	string (required)

SchemaMap

Name	Description	Value
recordMap	Record Map.	RecordMap[] (required)
resourceMap	Resource Map captures information about the entity for which telemetry is recorded. For example, metrics exposed by a Kubernetes container can be linked to a resource that specifies the cluster, namespace, pod, and container name.Resource may capture an entire hierarchy of entity identification. It may describe the host in the cloud and specific container or an application running in the process.	ResourceMap[]
scopeMap	A scope map is a logical unit of the application code with which the emitted telemetry can be associated.	ScopeMap[]

ScopeMap

Name	Description	Value
from	Scope Map Key.	string (required)
to	Scope Map Value.	string (required)

Service

Name	Description	Value
persistence	Persistence options to all pipelines in the instance.	PersistenceConfigurations
pipelines	Pipelines belonging to a given pipeline group.	Pipeline[] (required)

SyslogReceiver

Name	Description	Value
allowedFormats	List of allowed message formats for syslog/CEF ingestion. Default 'all'.	String array containing any of: 'all' 'cefRfc3164' 'cefRfc5424' 'rawCef' 'syslogRfc3164' 'syslogRfc5424'
allowSkipPriHeader	Configure the receiver to allow parsing of messages without the PRI header. Default false.	bool
endpoint	Syslog receiver endpoint definition. Example: 0.0.0.0:<port>.	string Constraints: Pattern = `^[a-zA-Z0-9-\.]+:[0-9]+$` (required)
transportProtocol	Transport protocol. Default tcp.	'tcp' 'udp'

TlsConfiguration

Name	Description	Value
clientCa	Certificate source configuration for the client CA certificate for validating client certificates. If not specified, default CA certificates are used.	CertificateSource
mode	The TLS security mode for receivers using this configuration. Default is 'mutualTls'.	'disabled' 'mutualTls' 'serverOnly'
name	The name of the TLS configuration.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
tlsCertificate	TLS certificate and its private key. If not specified, default TLS certificate is used.	CertificateWithKey

TrackedResourceTags

Name	Description	Value

TransformLanguageProcessor

Name	Description	Value
transformStatement	Transform statement to execute over the data passing through the processor.	string Constraints: Min length = 1 Max length = 10000 (required)

Terraform (AzAPI provider) resource definition

The pipelineGroups 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.Monitor/pipelineGroups resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Monitor/pipelineGroups@2026-04-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      executionPlacement = {
        constraints = [
          {
            capability = "string"
            operator = "string"
            values = [
              "string"
            ]
          }
        ]
        distribution = {
          maxInstancesPerHost = int
        }
      }
      exporters = [
        {
          azureMonitorWorkspaceLogs = {
            api = {
              dataCollectionEndpointUrl = "string"
              dataCollectionRule = "string"
              schema = {
                recordMap = [
                  {
                    from = "string"
                    to = "string"
                  }
                ]
                resourceMap = [
                  {
                    from = "string"
                    to = "string"
                  }
                ]
                scopeMap = [
                  {
                    from = "string"
                    to = "string"
                  }
                ]
              }
              stream = "string"
            }
            persistence = {
              maxStorageUsage = int
              retentionPeriod = int
            }
          }
          name = "string"
          type = "string"
        }
      ]
      processors = [
        {
          batch = {
            batchSize = int
            timeout = int
          }
          name = "string"
          transformLanguage = {
            transformStatement = "string"
          }
          type = "string"
        }
      ]
      receivers = [
        {
          name = "string"
          otlp = {
            endpoint = "string"
          }
          syslog = {
            allowedFormats = [
              "string"
            ]
            allowSkipPriHeader = bool
            endpoint = "string"
            transportProtocol = "string"
          }
          tlsConfiguration = "string"
          type = "string"
        }
      ]
      replicas = int
      service = {
        persistence = {
          persistentVolumeName = "string"
        }
        pipelines = [
          {
            exporters = [
              "string"
            ]
            name = "string"
            processors = [
              "string"
            ]
            receivers = [
              "string"
            ]
            type = "string"
          }
        ]
      }
      tlsConfigurations = [
        {
          clientCa = {
            location = "string"
            subLocation = "string"
            type = "string"
          }
          mode = "string"
          name = "string"
          tlsCertificate = {
            certificate = {
              location = "string"
              subLocation = "string"
              type = "string"
            }
            privateKey = {
              location = "string"
              subLocation = "string"
              type = "string"
            }
          }
        }
      ]
    }
  }
}

Property Values

Microsoft.Monitor/pipelineGroups

Name	Description	Value
extendedLocation	The complex type of the extended location.	AzureResourceManagerCommonTypesExtendedLocation
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
properties	The resource-specific properties for this resource.	PipelineGroupProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Monitor/pipelineGroups@2026-04-01"

AzureMonitorWorkspaceLogsApiConfig

Name	Description	Value
dataCollectionEndpointUrl	Data collection endpoint ingestion url.	string Constraints: Pattern = `^(https?)://[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*$` (required)
dataCollectionRule	Data Collection Rule (DCR) immutable id.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9.-]{1,1000}[^-]$` (required)
schema	The schema mapping for incoming data.	SchemaMap (required)
stream	Stream name in destination. Azure Monitor stream is related to the destination table.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9._-]{1,1000}[^-]$` (required)

AzureMonitorWorkspaceLogsExporter

Name	Description	Value
api	API configurations for Azure Monitor workspace exporter.	AzureMonitorWorkspaceLogsApiConfig (required)
persistence	Persistence options for the exporter.	ExporterPersistenceConfiguration

AzureResourceManagerCommonTypesExtendedLocation

Name	Description	Value
name	The name of the extended location.	string (required)
type	The type of the extended location.	'CustomLocation' 'EdgeZone' (required)

BatchProcessor

Name	Description	Value
batchSize	Size of the batch.	int Constraints: Min value = 10 Max value = 100000
timeout	Timeout in milliseconds.	int Constraints: Min value = 10 Max value = 300000

CertificateSource

Name	Description	Value
location	Location of the certificate source.	string (required)
subLocation	Sub-location within the certificate source.	string (required)
type	The type of certificate source.	'kubernetesConfigMap' 'kubernetesSecret' (required)

CertificateWithKey

Name	Description	Value
certificate	Source configuration for the TLS certificate.	CertificateSource (required)
privateKey	Source configuration for the private key. Private keys must be stored in Kubernetes secrets for security reasons.	PrivateKeySource (required)

DistributionPolicy

Name	Description	Value
maxInstancesPerHost	Maximum number of instances allowed per compute unit (node/VM). If not specified, default scheduling applies.	int Constraints: Min value = 1

ExecutionPlacement

Name	Description	Value
constraints	A list of placement constraints to guide where pipelineGroup instances should run.	PlacementConstraint[]
distribution	Distribution policy for spreading instances across compute units (nodes/VMs).	DistributionPolicy

Exporter

Name	Description	Value
azureMonitorWorkspaceLogs	Azure Monitor Workspace Logs specific configurations.	AzureMonitorWorkspaceLogsExporter
name	The name of exporter.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
type	The type of exporter.	'AzureMonitorWorkspaceLogs' (required)

ExporterPersistenceConfiguration

Name	Description	Value
maxStorageUsage	Max storage usage in gigabytes.	int Constraints: Min value = 1
retentionPeriod	Retention period in minutes.	int Constraints: Min value = 1

OtlpReceiver

Name	Description	Value
endpoint	OTLP GRPC endpoint definition. Example: 0.0.0.0:<port>.	string Constraints: Pattern = `^[a-zA-Z0-9-\.]+:[0-9]+$` (required)

PersistenceConfigurations

Name	Description	Value
persistentVolumeName	The name of the mounted persistent volume.	string (required)

Pipeline

Name	Description	Value
exporters	Reference to exporters configured for the pipeline.	string[] (required)
name	Name of the pipeline.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
processors	Reference to processors configured for the pipeline.	string[]
receivers	Reference to receivers configured for the pipeline.	string[] (required)
type	The type of pipeline	'Logs' (required)

PipelineGroupProperties

Name	Description	Value
executionPlacement	Constraints for guiding the execution environment of the pipeline group.	ExecutionPlacement
exporters	The exporters specified for a pipeline group instance.	Exporter[] (required)
processors	The processors specified for a pipeline group instance.	Processor[] (required)
receivers	The receivers specified for a pipeline group instance.	Receiver[] (required)
replicas	Defines the amount of replicas of the pipeline group instance.	int Constraints: Min value = 1
service	The service section for a given pipeline group instance.	Service (required)
tlsConfigurations	TLS configurations for the pipeline group instance.	TlsConfiguration[]

PlacementConstraint

Name	Description	Value
capability	The capability or attribute key used to match compute unit properties.	string (required)
operator	The match operator, e.g., In, NotIn, Exists, DoesNotExist.	'DoesNotExist' 'Exists' 'In' 'NotIn' (required)
values	The values to match against. Not required for Exists/DoesNotExist.	string[]

PrivateKeySource

Name	Description	Value
location	Location of the private key source.	string (required)
subLocation	Sub-location within the private key source.	string (required)
type	The type of private key source. Only kubernetesSecret is supported for security reasons.	'kubernetesSecret' (required)

Processor

Name	Description	Value
batch	Batch processor configurations.	BatchProcessor
name	The name of processor.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
transformLanguage	Transform language processor configurations.	TransformLanguageProcessor
type	The type of processor.	'Batch' 'MicrosoftCommonSecurityLog' 'MicrosoftSyslog' 'TransformLanguage' (required)

Receiver

Name	Description	Value
name	The name of receiver.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
otlp	OTLP receiver configurations. This field is mandatory for OTLP receivers.	OtlpReceiver
syslog	Syslog configurations. This field is mandatory for syslog type receivers.	SyslogReceiver
tlsConfiguration	Reference to a named TLS configuration. If not specified, default TLS configuration is used.	string
type	The type of receiver.	'OTLP' 'Syslog' (required)

RecordMap

Name	Description	Value
from	Record Map Key.	string (required)
to	Record Map Value.	string (required)

ResourceMap

Name	Description	Value
from	Resource Map Key.	string (required)
to	Resource Map Value.	string (required)

SchemaMap

Name	Description	Value
recordMap	Record Map.	RecordMap[] (required)
resourceMap	Resource Map captures information about the entity for which telemetry is recorded. For example, metrics exposed by a Kubernetes container can be linked to a resource that specifies the cluster, namespace, pod, and container name.Resource may capture an entire hierarchy of entity identification. It may describe the host in the cloud and specific container or an application running in the process.	ResourceMap[]
scopeMap	A scope map is a logical unit of the application code with which the emitted telemetry can be associated.	ScopeMap[]

ScopeMap

Name	Description	Value
from	Scope Map Key.	string (required)
to	Scope Map Value.	string (required)

Service

Name	Description	Value
persistence	Persistence options to all pipelines in the instance.	PersistenceConfigurations
pipelines	Pipelines belonging to a given pipeline group.	Pipeline[] (required)

SyslogReceiver

Name	Description	Value
allowedFormats	List of allowed message formats for syslog/CEF ingestion. Default 'all'.	String array containing any of: 'all' 'cefRfc3164' 'cefRfc5424' 'rawCef' 'syslogRfc3164' 'syslogRfc5424'
allowSkipPriHeader	Configure the receiver to allow parsing of messages without the PRI header. Default false.	bool
endpoint	Syslog receiver endpoint definition. Example: 0.0.0.0:<port>.	string Constraints: Pattern = `^[a-zA-Z0-9-\.]+:[0-9]+$` (required)
transportProtocol	Transport protocol. Default tcp.	'tcp' 'udp'

TlsConfiguration

Name	Description	Value
clientCa	Certificate source configuration for the client CA certificate for validating client certificates. If not specified, default CA certificates are used.	CertificateSource
mode	The TLS security mode for receivers using this configuration. Default is 'mutualTls'.	'disabled' 'mutualTls' 'serverOnly'
name	The name of the TLS configuration.	string Constraints: Pattern = `^(?!-)[a-zA-Z0-9-]{3,32}[^-]$` (required)
tlsCertificate	TLS certificate and its private key. If not specified, default TLS certificate is used.	CertificateWithKey

TrackedResourceTags

Name	Description	Value

TransformLanguageProcessor

Name	Description	Value
transformStatement	Transform statement to execute over the data passing through the processor.	string Constraints: Min length = 1 Max length = 10000 (required)

Feedback

Was this page helpful?

Last updated on 2026-04-13