1. Packages
  2. Azure Native
  3. API Docs
  4. monitor
  5. getPipelineGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.monitor.getPipelineGroup

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Returns the specific pipeline group instance.

Uses Azure REST API version 2024-10-01-preview.

Other available API versions: 2023-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native monitor [ApiVersion]. See the version guide for details.

Using getPipelineGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPipelineGroup(args: GetPipelineGroupArgs, opts?: InvokeOptions): Promise<GetPipelineGroupResult>
function getPipelineGroupOutput(args: GetPipelineGroupOutputArgs, opts?: InvokeOptions): Output<GetPipelineGroupResult>
Copy
def get_pipeline_group(pipeline_group_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPipelineGroupResult
def get_pipeline_group_output(pipeline_group_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPipelineGroupResult]
Copy
func LookupPipelineGroup(ctx *Context, args *LookupPipelineGroupArgs, opts ...InvokeOption) (*LookupPipelineGroupResult, error)
func LookupPipelineGroupOutput(ctx *Context, args *LookupPipelineGroupOutputArgs, opts ...InvokeOption) LookupPipelineGroupResultOutput
Copy

> Note: This function is named LookupPipelineGroup in the Go SDK.

public static class GetPipelineGroup 
{
    public static Task<GetPipelineGroupResult> InvokeAsync(GetPipelineGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineGroupResult> Invoke(GetPipelineGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPipelineGroupResult> getPipelineGroup(GetPipelineGroupArgs args, InvokeOptions options)
public static Output<GetPipelineGroupResult> getPipelineGroup(GetPipelineGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:monitor:getPipelineGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PipelineGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of pipeline group. The name is case insensitive.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
PipelineGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of pipeline group. The name is case insensitive.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
pipelineGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of pipeline group. The name is case insensitive.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
pipelineGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of pipeline group. The name is case insensitive.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
pipeline_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of pipeline group. The name is case insensitive.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
pipelineGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of pipeline group. The name is case insensitive.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getPipelineGroup Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties Pulumi.AzureNative.Monitor.Outputs.PipelineGroupPropertiesResponse
The resource-specific properties for this resource.
SystemData Pulumi.AzureNative.Monitor.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ExtendedLocation Pulumi.AzureNative.Monitor.Outputs.AzureResourceManagerCommonTypesExtendedLocationResponse
The complex type of the extended location.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties PipelineGroupPropertiesResponse
The resource-specific properties for this resource.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ExtendedLocation AzureResourceManagerCommonTypesExtendedLocationResponse
The complex type of the extended location.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
properties PipelineGroupPropertiesResponse
The resource-specific properties for this resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
extendedLocation AzureResourceManagerCommonTypesExtendedLocationResponse
The complex type of the extended location.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
name string
The name of the resource
properties PipelineGroupPropertiesResponse
The resource-specific properties for this resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
extendedLocation AzureResourceManagerCommonTypesExtendedLocationResponse
The complex type of the extended location.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
name str
The name of the resource
properties PipelineGroupPropertiesResponse
The resource-specific properties for this resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
extended_location AzureResourceManagerCommonTypesExtendedLocationResponse
The complex type of the extended location.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
properties Property Map
The resource-specific properties for this resource.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
extendedLocation Property Map
The complex type of the extended location.
tags Map<String>
Resource tags.

Supporting Types

AzureMonitorWorkspaceLogsApiConfigResponse

DataCollectionEndpointUrl This property is required. string
Data collection endpoint ingestion url.
DataCollectionRule This property is required. string
Data Collection Rule (DCR) immutable id.
Schema This property is required. Pulumi.AzureNative.Monitor.Inputs.SchemaMapResponse
The schema mapping for incoming data.
Stream This property is required. string
Stream name in destination. Azure Monitor stream is related to the destination table.
DataCollectionEndpointUrl This property is required. string
Data collection endpoint ingestion url.
DataCollectionRule This property is required. string
Data Collection Rule (DCR) immutable id.
Schema This property is required. SchemaMapResponse
The schema mapping for incoming data.
Stream This property is required. string
Stream name in destination. Azure Monitor stream is related to the destination table.
dataCollectionEndpointUrl This property is required. String
Data collection endpoint ingestion url.
dataCollectionRule This property is required. String
Data Collection Rule (DCR) immutable id.
schema This property is required. SchemaMapResponse
The schema mapping for incoming data.
stream This property is required. String
Stream name in destination. Azure Monitor stream is related to the destination table.
dataCollectionEndpointUrl This property is required. string
Data collection endpoint ingestion url.
dataCollectionRule This property is required. string
Data Collection Rule (DCR) immutable id.
schema This property is required. SchemaMapResponse
The schema mapping for incoming data.
stream This property is required. string
Stream name in destination. Azure Monitor stream is related to the destination table.
data_collection_endpoint_url This property is required. str
Data collection endpoint ingestion url.
data_collection_rule This property is required. str
Data Collection Rule (DCR) immutable id.
schema This property is required. SchemaMapResponse
The schema mapping for incoming data.
stream This property is required. str
Stream name in destination. Azure Monitor stream is related to the destination table.
dataCollectionEndpointUrl This property is required. String
Data collection endpoint ingestion url.
dataCollectionRule This property is required. String
Data Collection Rule (DCR) immutable id.
schema This property is required. Property Map
The schema mapping for incoming data.
stream This property is required. String
Stream name in destination. Azure Monitor stream is related to the destination table.

AzureMonitorWorkspaceLogsExporterResponse

Api This property is required. Pulumi.AzureNative.Monitor.Inputs.AzureMonitorWorkspaceLogsApiConfigResponse
API configurations for Azure Monitor workspace exporter.
Cache Pulumi.AzureNative.Monitor.Inputs.CacheConfigurationResponse
Cache configurations.
Concurrency Pulumi.AzureNative.Monitor.Inputs.ConcurrencyConfigurationResponse
Concurrency configuration for the exporter.
Api This property is required. AzureMonitorWorkspaceLogsApiConfigResponse
API configurations for Azure Monitor workspace exporter.
Cache CacheConfigurationResponse
Cache configurations.
Concurrency ConcurrencyConfigurationResponse
Concurrency configuration for the exporter.
api This property is required. AzureMonitorWorkspaceLogsApiConfigResponse
API configurations for Azure Monitor workspace exporter.
cache CacheConfigurationResponse
Cache configurations.
concurrency ConcurrencyConfigurationResponse
Concurrency configuration for the exporter.
api This property is required. AzureMonitorWorkspaceLogsApiConfigResponse
API configurations for Azure Monitor workspace exporter.
cache CacheConfigurationResponse
Cache configurations.
concurrency ConcurrencyConfigurationResponse
Concurrency configuration for the exporter.
api This property is required. AzureMonitorWorkspaceLogsApiConfigResponse
API configurations for Azure Monitor workspace exporter.
cache CacheConfigurationResponse
Cache configurations.
concurrency ConcurrencyConfigurationResponse
Concurrency configuration for the exporter.
api This property is required. Property Map
API configurations for Azure Monitor workspace exporter.
cache Property Map
Cache configurations.
concurrency Property Map
Concurrency configuration for the exporter.

AzureResourceManagerCommonTypesExtendedLocationResponse

Name This property is required. string
The name of the extended location.
Type This property is required. string
The type of the extended location.
Name This property is required. string
The name of the extended location.
Type This property is required. string
The type of the extended location.
name This property is required. String
The name of the extended location.
type This property is required. String
The type of the extended location.
name This property is required. string
The name of the extended location.
type This property is required. string
The type of the extended location.
name This property is required. str
The name of the extended location.
type This property is required. str
The type of the extended location.
name This property is required. String
The name of the extended location.
type This property is required. String
The type of the extended location.

BatchProcessorResponse

BatchSize int
Size of the batch.
Timeout int
Timeout in milliseconds.
BatchSize int
Size of the batch.
Timeout int
Timeout in milliseconds.
batchSize Integer
Size of the batch.
timeout Integer
Timeout in milliseconds.
batchSize number
Size of the batch.
timeout number
Timeout in milliseconds.
batch_size int
Size of the batch.
timeout int
Timeout in milliseconds.
batchSize Number
Size of the batch.
timeout Number
Timeout in milliseconds.

CacheConfigurationResponse

MaxStorageUsage int
Max storage usage in megabytes.
RetentionPeriod int
Retention period in minutes.
MaxStorageUsage int
Max storage usage in megabytes.
RetentionPeriod int
Retention period in minutes.
maxStorageUsage Integer
Max storage usage in megabytes.
retentionPeriod Integer
Retention period in minutes.
maxStorageUsage number
Max storage usage in megabytes.
retentionPeriod number
Retention period in minutes.
max_storage_usage int
Max storage usage in megabytes.
retention_period int
Retention period in minutes.
maxStorageUsage Number
Max storage usage in megabytes.
retentionPeriod Number
Retention period in minutes.

ConcurrencyConfigurationResponse

BatchQueueSize int
Size of the queue for log batches.
WorkerCount int
Number of parallel workers processing the log queues.
BatchQueueSize int
Size of the queue for log batches.
WorkerCount int
Number of parallel workers processing the log queues.
batchQueueSize Integer
Size of the queue for log batches.
workerCount Integer
Number of parallel workers processing the log queues.
batchQueueSize number
Size of the queue for log batches.
workerCount number
Number of parallel workers processing the log queues.
batch_queue_size int
Size of the queue for log batches.
worker_count int
Number of parallel workers processing the log queues.
batchQueueSize Number
Size of the queue for log batches.
workerCount Number
Number of parallel workers processing the log queues.

ExporterResponse

Name This property is required. string
The name of exporter.
Type This property is required. string
The type of exporter.
AzureMonitorWorkspaceLogs Pulumi.AzureNative.Monitor.Inputs.AzureMonitorWorkspaceLogsExporterResponse
Azure Monitor Workspace Logs specific configurations.
Tcp Pulumi.AzureNative.Monitor.Inputs.TcpExporterResponse
TCP based exporter. Used for pipelineGroup exporter.
Name This property is required. string
The name of exporter.
Type This property is required. string
The type of exporter.
AzureMonitorWorkspaceLogs AzureMonitorWorkspaceLogsExporterResponse
Azure Monitor Workspace Logs specific configurations.
Tcp TcpExporterResponse
TCP based exporter. Used for pipelineGroup exporter.
name This property is required. String
The name of exporter.
type This property is required. String
The type of exporter.
azureMonitorWorkspaceLogs AzureMonitorWorkspaceLogsExporterResponse
Azure Monitor Workspace Logs specific configurations.
tcp TcpExporterResponse
TCP based exporter. Used for pipelineGroup exporter.
name This property is required. string
The name of exporter.
type This property is required. string
The type of exporter.
azureMonitorWorkspaceLogs AzureMonitorWorkspaceLogsExporterResponse
Azure Monitor Workspace Logs specific configurations.
tcp TcpExporterResponse
TCP based exporter. Used for pipelineGroup exporter.
name This property is required. str
The name of exporter.
type This property is required. str
The type of exporter.
azure_monitor_workspace_logs AzureMonitorWorkspaceLogsExporterResponse
Azure Monitor Workspace Logs specific configurations.
tcp TcpExporterResponse
TCP based exporter. Used for pipelineGroup exporter.
name This property is required. String
The name of exporter.
type This property is required. String
The type of exporter.
azureMonitorWorkspaceLogs Property Map
Azure Monitor Workspace Logs specific configurations.
tcp Property Map
TCP based exporter. Used for pipelineGroup exporter.

JsonArrayMapperResponse

Keys This property is required. List<string>
Define the names of the keys in the resulting map. The input json array elements are mapped in order, one for every key.
DestinationField Pulumi.AzureNative.Monitor.Inputs.JsonMapperDestinationFieldResponse
Define a destination field to which the parsed output will be written. The output is a map, it's keys is the given keys array and the matching values are the parsed json array elements.
SourceField Pulumi.AzureNative.Monitor.Inputs.JsonMapperSourceFieldResponse
Define a source field from which a json array will be read and parsed to it's elements. The number of elements in the json array is expected to be the same as the length of keys.
Keys This property is required. []string
Define the names of the keys in the resulting map. The input json array elements are mapped in order, one for every key.
DestinationField JsonMapperDestinationFieldResponse
Define a destination field to which the parsed output will be written. The output is a map, it's keys is the given keys array and the matching values are the parsed json array elements.
SourceField JsonMapperSourceFieldResponse
Define a source field from which a json array will be read and parsed to it's elements. The number of elements in the json array is expected to be the same as the length of keys.
keys This property is required. List<String>
Define the names of the keys in the resulting map. The input json array elements are mapped in order, one for every key.
destinationField JsonMapperDestinationFieldResponse
Define a destination field to which the parsed output will be written. The output is a map, it's keys is the given keys array and the matching values are the parsed json array elements.
sourceField JsonMapperSourceFieldResponse
Define a source field from which a json array will be read and parsed to it's elements. The number of elements in the json array is expected to be the same as the length of keys.
keys This property is required. string[]
Define the names of the keys in the resulting map. The input json array elements are mapped in order, one for every key.
destinationField JsonMapperDestinationFieldResponse
Define a destination field to which the parsed output will be written. The output is a map, it's keys is the given keys array and the matching values are the parsed json array elements.
sourceField JsonMapperSourceFieldResponse
Define a source field from which a json array will be read and parsed to it's elements. The number of elements in the json array is expected to be the same as the length of keys.
keys This property is required. Sequence[str]
Define the names of the keys in the resulting map. The input json array elements are mapped in order, one for every key.
destination_field JsonMapperDestinationFieldResponse
Define a destination field to which the parsed output will be written. The output is a map, it's keys is the given keys array and the matching values are the parsed json array elements.
source_field JsonMapperSourceFieldResponse
Define a source field from which a json array will be read and parsed to it's elements. The number of elements in the json array is expected to be the same as the length of keys.
keys This property is required. List<String>
Define the names of the keys in the resulting map. The input json array elements are mapped in order, one for every key.
destinationField Property Map
Define a destination field to which the parsed output will be written. The output is a map, it's keys is the given keys array and the matching values are the parsed json array elements.
sourceField Property Map
Define a source field from which a json array will be read and parsed to it's elements. The number of elements in the json array is expected to be the same as the length of keys.

JsonMapperDestinationFieldResponse

Destination string
Define the destination's element. The element is the body or the attributes of the message, to which the json array mapper will write the output map.
FieldName string
Define a destination field name under the given element. Leaving this empty, means the root of the element. In case element=attributes and fieldName is empty, the object's attributes themselves will contain the key value output pairs.
Destination string
Define the destination's element. The element is the body or the attributes of the message, to which the json array mapper will write the output map.
FieldName string
Define a destination field name under the given element. Leaving this empty, means the root of the element. In case element=attributes and fieldName is empty, the object's attributes themselves will contain the key value output pairs.
destination String
Define the destination's element. The element is the body or the attributes of the message, to which the json array mapper will write the output map.
fieldName String
Define a destination field name under the given element. Leaving this empty, means the root of the element. In case element=attributes and fieldName is empty, the object's attributes themselves will contain the key value output pairs.
destination string
Define the destination's element. The element is the body or the attributes of the message, to which the json array mapper will write the output map.
fieldName string
Define a destination field name under the given element. Leaving this empty, means the root of the element. In case element=attributes and fieldName is empty, the object's attributes themselves will contain the key value output pairs.
destination str
Define the destination's element. The element is the body or the attributes of the message, to which the json array mapper will write the output map.
field_name str
Define a destination field name under the given element. Leaving this empty, means the root of the element. In case element=attributes and fieldName is empty, the object's attributes themselves will contain the key value output pairs.
destination String
Define the destination's element. The element is the body or the attributes of the message, to which the json array mapper will write the output map.
fieldName String
Define a destination field name under the given element. Leaving this empty, means the root of the element. In case element=attributes and fieldName is empty, the object's attributes themselves will contain the key value output pairs.

JsonMapperSourceFieldResponse

FieldName string
Define a source field name from which the json array mapper will read the json array. Leaving this empty, means reading the body of the message itself.
FieldName string
Define a source field name from which the json array mapper will read the json array. Leaving this empty, means reading the body of the message itself.
fieldName String
Define a source field name from which the json array mapper will read the json array. Leaving this empty, means reading the body of the message itself.
fieldName string
Define a source field name from which the json array mapper will read the json array. Leaving this empty, means reading the body of the message itself.
field_name str
Define a source field name from which the json array mapper will read the json array. Leaving this empty, means reading the body of the message itself.
fieldName String
Define a source field name from which the json array mapper will read the json array. Leaving this empty, means reading the body of the message itself.

NetworkingConfigurationResponse

ExternalNetworkingMode This property is required. string
External networking mode.
Routes This property is required. List<Pulumi.AzureNative.Monitor.Inputs.NetworkingRouteResponse>
Networking routes configuration.
Host string
The address exposed on the cluster. Example: azuremonitorpipeline.contoso.com.
ExternalNetworkingMode This property is required. string
External networking mode.
Routes This property is required. []NetworkingRouteResponse
Networking routes configuration.
Host string
The address exposed on the cluster. Example: azuremonitorpipeline.contoso.com.
externalNetworkingMode This property is required. String
External networking mode.
routes This property is required. List<NetworkingRouteResponse>
Networking routes configuration.
host String
The address exposed on the cluster. Example: azuremonitorpipeline.contoso.com.
externalNetworkingMode This property is required. string
External networking mode.
routes This property is required. NetworkingRouteResponse[]
Networking routes configuration.
host string
The address exposed on the cluster. Example: azuremonitorpipeline.contoso.com.
external_networking_mode This property is required. str
External networking mode.
routes This property is required. Sequence[NetworkingRouteResponse]
Networking routes configuration.
host str
The address exposed on the cluster. Example: azuremonitorpipeline.contoso.com.
externalNetworkingMode This property is required. String
External networking mode.
routes This property is required. List<Property Map>
Networking routes configuration.
host String
The address exposed on the cluster. Example: azuremonitorpipeline.contoso.com.

NetworkingRouteResponse

Receiver This property is required. string
The name of the previously defined receiver.
Path string
Route path.
Port int
The port that will be configured externally. If not specified, it will use the port from the receiver definition.
Subdomain string
Route subdomain.
Receiver This property is required. string
The name of the previously defined receiver.
Path string
Route path.
Port int
The port that will be configured externally. If not specified, it will use the port from the receiver definition.
Subdomain string
Route subdomain.
receiver This property is required. String
The name of the previously defined receiver.
path String
Route path.
port Integer
The port that will be configured externally. If not specified, it will use the port from the receiver definition.
subdomain String
Route subdomain.
receiver This property is required. string
The name of the previously defined receiver.
path string
Route path.
port number
The port that will be configured externally. If not specified, it will use the port from the receiver definition.
subdomain string
Route subdomain.
receiver This property is required. str
The name of the previously defined receiver.
path str
Route path.
port int
The port that will be configured externally. If not specified, it will use the port from the receiver definition.
subdomain str
Route subdomain.
receiver This property is required. String
The name of the previously defined receiver.
path String
Route path.
port Number
The port that will be configured externally. If not specified, it will use the port from the receiver definition.
subdomain String
Route subdomain.

OtlpReceiverResponse

Endpoint This property is required. string
OTLP GRPC endpoint definition. Example: 0.0.0.0:.
Endpoint This property is required. string
OTLP GRPC endpoint definition. Example: 0.0.0.0:.
endpoint This property is required. String
OTLP GRPC endpoint definition. Example: 0.0.0.0:.
endpoint This property is required. string
OTLP GRPC endpoint definition. Example: 0.0.0.0:.
endpoint This property is required. str
OTLP GRPC endpoint definition. Example: 0.0.0.0:.
endpoint This property is required. String
OTLP GRPC endpoint definition. Example: 0.0.0.0:.

PersistenceConfigurationsResponse

PersistentVolumeName This property is required. string
The name of the mounted persistent volume.
PersistentVolumeName This property is required. string
The name of the mounted persistent volume.
persistentVolumeName This property is required. String
The name of the mounted persistent volume.
persistentVolumeName This property is required. string
The name of the mounted persistent volume.
persistent_volume_name This property is required. str
The name of the mounted persistent volume.
persistentVolumeName This property is required. String
The name of the mounted persistent volume.

PipelineGroupPropertiesResponse

Exporters This property is required. List<Pulumi.AzureNative.Monitor.Inputs.ExporterResponse>
The exporters specified for a pipeline group instance.
Processors This property is required. List<Pulumi.AzureNative.Monitor.Inputs.ProcessorResponse>
The processors specified for a pipeline group instance.
ProvisioningState This property is required. string
The provisioning state of a pipeline group instance. Set to Succeeded if everything is healthy.
Receivers This property is required. List<Pulumi.AzureNative.Monitor.Inputs.ReceiverResponse>
The receivers specified for a pipeline group instance.
Service This property is required. Pulumi.AzureNative.Monitor.Inputs.ServiceResponse
The service section for a given pipeline group instance.
NetworkingConfigurations List<Pulumi.AzureNative.Monitor.Inputs.NetworkingConfigurationResponse>
Networking configurations for the pipeline group instance.
Replicas int
Defines the amount of replicas of the pipeline group instance.
Exporters This property is required. []ExporterResponse
The exporters specified for a pipeline group instance.
Processors This property is required. []ProcessorResponse
The processors specified for a pipeline group instance.
ProvisioningState This property is required. string
The provisioning state of a pipeline group instance. Set to Succeeded if everything is healthy.
Receivers This property is required. []ReceiverResponse
The receivers specified for a pipeline group instance.
Service This property is required. ServiceResponse
The service section for a given pipeline group instance.
NetworkingConfigurations []NetworkingConfigurationResponse
Networking configurations for the pipeline group instance.
Replicas int
Defines the amount of replicas of the pipeline group instance.
exporters This property is required. List<ExporterResponse>
The exporters specified for a pipeline group instance.
processors This property is required. List<ProcessorResponse>
The processors specified for a pipeline group instance.
provisioningState This property is required. String
The provisioning state of a pipeline group instance. Set to Succeeded if everything is healthy.
receivers This property is required. List<ReceiverResponse>
The receivers specified for a pipeline group instance.
service This property is required. ServiceResponse
The service section for a given pipeline group instance.
networkingConfigurations List<NetworkingConfigurationResponse>
Networking configurations for the pipeline group instance.
replicas Integer
Defines the amount of replicas of the pipeline group instance.
exporters This property is required. ExporterResponse[]
The exporters specified for a pipeline group instance.
processors This property is required. ProcessorResponse[]
The processors specified for a pipeline group instance.
provisioningState This property is required. string
The provisioning state of a pipeline group instance. Set to Succeeded if everything is healthy.
receivers This property is required. ReceiverResponse[]
The receivers specified for a pipeline group instance.
service This property is required. ServiceResponse
The service section for a given pipeline group instance.
networkingConfigurations NetworkingConfigurationResponse[]
Networking configurations for the pipeline group instance.
replicas number
Defines the amount of replicas of the pipeline group instance.
exporters This property is required. Sequence[ExporterResponse]
The exporters specified for a pipeline group instance.
processors This property is required. Sequence[ProcessorResponse]
The processors specified for a pipeline group instance.
provisioning_state This property is required. str
The provisioning state of a pipeline group instance. Set to Succeeded if everything is healthy.
receivers This property is required. Sequence[ReceiverResponse]
The receivers specified for a pipeline group instance.
service This property is required. ServiceResponse
The service section for a given pipeline group instance.
networking_configurations Sequence[NetworkingConfigurationResponse]
Networking configurations for the pipeline group instance.
replicas int
Defines the amount of replicas of the pipeline group instance.
exporters This property is required. List<Property Map>
The exporters specified for a pipeline group instance.
processors This property is required. List<Property Map>
The processors specified for a pipeline group instance.
provisioningState This property is required. String
The provisioning state of a pipeline group instance. Set to Succeeded if everything is healthy.
receivers This property is required. List<Property Map>
The receivers specified for a pipeline group instance.
service This property is required. Property Map
The service section for a given pipeline group instance.
networkingConfigurations List<Property Map>
Networking configurations for the pipeline group instance.
replicas Number
Defines the amount of replicas of the pipeline group instance.

PipelineResponse

Exporters This property is required. List<string>
Reference to exporters configured for the pipeline.
Name This property is required. string
Name of the pipeline.
Receivers This property is required. List<string>
Reference to receivers configured for the pipeline.
Type This property is required. string
The type of pipeline
Processors List<string>
Reference to processors configured for the pipeline.
Exporters This property is required. []string
Reference to exporters configured for the pipeline.
Name This property is required. string
Name of the pipeline.
Receivers This property is required. []string
Reference to receivers configured for the pipeline.
Type This property is required. string
The type of pipeline
Processors []string
Reference to processors configured for the pipeline.
exporters This property is required. List<String>
Reference to exporters configured for the pipeline.
name This property is required. String
Name of the pipeline.
receivers This property is required. List<String>
Reference to receivers configured for the pipeline.
type This property is required. String
The type of pipeline
processors List<String>
Reference to processors configured for the pipeline.
exporters This property is required. string[]
Reference to exporters configured for the pipeline.
name This property is required. string
Name of the pipeline.
receivers This property is required. string[]
Reference to receivers configured for the pipeline.
type This property is required. string
The type of pipeline
processors string[]
Reference to processors configured for the pipeline.
exporters This property is required. Sequence[str]
Reference to exporters configured for the pipeline.
name This property is required. str
Name of the pipeline.
receivers This property is required. Sequence[str]
Reference to receivers configured for the pipeline.
type This property is required. str
The type of pipeline
processors Sequence[str]
Reference to processors configured for the pipeline.
exporters This property is required. List<String>
Reference to exporters configured for the pipeline.
name This property is required. String
Name of the pipeline.
receivers This property is required. List<String>
Reference to receivers configured for the pipeline.
type This property is required. String
The type of pipeline
processors List<String>
Reference to processors configured for the pipeline.

ProcessorResponse

Name This property is required. string
The name of processor.
Type This property is required. string
The type of processor.
Batch Pulumi.AzureNative.Monitor.Inputs.BatchProcessorResponse
Batch processor configurations.
Name This property is required. string
The name of processor.
Type This property is required. string
The type of processor.
Batch BatchProcessorResponse
Batch processor configurations.
name This property is required. String
The name of processor.
type This property is required. String
The type of processor.
batch BatchProcessorResponse
Batch processor configurations.
name This property is required. string
The name of processor.
type This property is required. string
The type of processor.
batch BatchProcessorResponse
Batch processor configurations.
name This property is required. str
The name of processor.
type This property is required. str
The type of processor.
batch BatchProcessorResponse
Batch processor configurations.
name This property is required. String
The name of processor.
type This property is required. String
The type of processor.
batch Property Map
Batch processor configurations.

ReceiverResponse

Name This property is required. string
The name of receiver.
Type This property is required. string
The type of receiver.
Otlp Pulumi.AzureNative.Monitor.Inputs.OtlpReceiverResponse
OTLP receiver configurations. This field is mandatory for OTLP and pipelineGroup receivers.
Syslog Pulumi.AzureNative.Monitor.Inputs.SyslogReceiverResponse
Syslog configurations. This field is mandatory for syslog type receivers.
Udp Pulumi.AzureNative.Monitor.Inputs.UdpReceiverResponse
UDP receiver configurations. This field is mandatory for UDP receivers.
Name This property is required. string
The name of receiver.
Type This property is required. string
The type of receiver.
Otlp OtlpReceiverResponse
OTLP receiver configurations. This field is mandatory for OTLP and pipelineGroup receivers.
Syslog SyslogReceiverResponse
Syslog configurations. This field is mandatory for syslog type receivers.
Udp UdpReceiverResponse
UDP receiver configurations. This field is mandatory for UDP receivers.
name This property is required. String
The name of receiver.
type This property is required. String
The type of receiver.
otlp OtlpReceiverResponse
OTLP receiver configurations. This field is mandatory for OTLP and pipelineGroup receivers.
syslog SyslogReceiverResponse
Syslog configurations. This field is mandatory for syslog type receivers.
udp UdpReceiverResponse
UDP receiver configurations. This field is mandatory for UDP receivers.
name This property is required. string
The name of receiver.
type This property is required. string
The type of receiver.
otlp OtlpReceiverResponse
OTLP receiver configurations. This field is mandatory for OTLP and pipelineGroup receivers.
syslog SyslogReceiverResponse
Syslog configurations. This field is mandatory for syslog type receivers.
udp UdpReceiverResponse
UDP receiver configurations. This field is mandatory for UDP receivers.
name This property is required. str
The name of receiver.
type This property is required. str
The type of receiver.
otlp OtlpReceiverResponse
OTLP receiver configurations. This field is mandatory for OTLP and pipelineGroup receivers.
syslog SyslogReceiverResponse
Syslog configurations. This field is mandatory for syslog type receivers.
udp UdpReceiverResponse
UDP receiver configurations. This field is mandatory for UDP receivers.
name This property is required. String
The name of receiver.
type This property is required. String
The type of receiver.
otlp Property Map
OTLP receiver configurations. This field is mandatory for OTLP and pipelineGroup receivers.
syslog Property Map
Syslog configurations. This field is mandatory for syslog type receivers.
udp Property Map
UDP receiver configurations. This field is mandatory for UDP receivers.

RecordMapResponse

From This property is required. string
Record Map Key.
To This property is required. string
Record Map Value.
From This property is required. string
Record Map Key.
To This property is required. string
Record Map Value.
from This property is required. String
Record Map Key.
to This property is required. String
Record Map Value.
from This property is required. string
Record Map Key.
to This property is required. string
Record Map Value.
from_ This property is required. str
Record Map Key.
to This property is required. str
Record Map Value.
from This property is required. String
Record Map Key.
to This property is required. String
Record Map Value.

ResourceMapResponse

From This property is required. string
Resource Map Key.
To This property is required. string
Resource Map Value.
From This property is required. string
Resource Map Key.
To This property is required. string
Resource Map Value.
from This property is required. String
Resource Map Key.
to This property is required. String
Resource Map Value.
from This property is required. string
Resource Map Key.
to This property is required. string
Resource Map Value.
from_ This property is required. str
Resource Map Key.
to This property is required. str
Resource Map Value.
from This property is required. String
Resource Map Key.
to This property is required. String
Resource Map Value.

SchemaMapResponse

RecordMap This property is required. List<Pulumi.AzureNative.Monitor.Inputs.RecordMapResponse>
Record Map.
ResourceMap List<Pulumi.AzureNative.Monitor.Inputs.ResourceMapResponse>
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.
ScopeMap List<Pulumi.AzureNative.Monitor.Inputs.ScopeMapResponse>
A scope map is a logical unit of the application code with which the emitted telemetry can be associated.
RecordMap This property is required. []RecordMapResponse
Record Map.
ResourceMap []ResourceMapResponse
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.
ScopeMap []ScopeMapResponse
A scope map is a logical unit of the application code with which the emitted telemetry can be associated.
recordMap This property is required. List<RecordMapResponse>
Record Map.
resourceMap List<ResourceMapResponse>
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.
scopeMap List<ScopeMapResponse>
A scope map is a logical unit of the application code with which the emitted telemetry can be associated.
recordMap This property is required. RecordMapResponse[]
Record Map.
resourceMap ResourceMapResponse[]
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.
scopeMap ScopeMapResponse[]
A scope map is a logical unit of the application code with which the emitted telemetry can be associated.
record_map This property is required. Sequence[RecordMapResponse]
Record Map.
resource_map Sequence[ResourceMapResponse]
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.
scope_map Sequence[ScopeMapResponse]
A scope map is a logical unit of the application code with which the emitted telemetry can be associated.
recordMap This property is required. List<Property Map>
Record Map.
resourceMap List<Property Map>
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.
scopeMap List<Property Map>
A scope map is a logical unit of the application code with which the emitted telemetry can be associated.

ScopeMapResponse

From This property is required. string
Scope Map Key.
To This property is required. string
Scope Map Value.
From This property is required. string
Scope Map Key.
To This property is required. string
Scope Map Value.
from This property is required. String
Scope Map Key.
to This property is required. String
Scope Map Value.
from This property is required. string
Scope Map Key.
to This property is required. string
Scope Map Value.
from_ This property is required. str
Scope Map Key.
to This property is required. str
Scope Map Value.
from This property is required. String
Scope Map Key.
to This property is required. String
Scope Map Value.

ServiceResponse

Pipelines This property is required. List<Pulumi.AzureNative.Monitor.Inputs.PipelineResponse>
Pipelines belonging to a given pipeline group.
Persistence Pulumi.AzureNative.Monitor.Inputs.PersistenceConfigurationsResponse
Persistence options to all pipelines in the instance.
Pipelines This property is required. []PipelineResponse
Pipelines belonging to a given pipeline group.
Persistence PersistenceConfigurationsResponse
Persistence options to all pipelines in the instance.
pipelines This property is required. List<PipelineResponse>
Pipelines belonging to a given pipeline group.
persistence PersistenceConfigurationsResponse
Persistence options to all pipelines in the instance.
pipelines This property is required. PipelineResponse[]
Pipelines belonging to a given pipeline group.
persistence PersistenceConfigurationsResponse
Persistence options to all pipelines in the instance.
pipelines This property is required. Sequence[PipelineResponse]
Pipelines belonging to a given pipeline group.
persistence PersistenceConfigurationsResponse
Persistence options to all pipelines in the instance.
pipelines This property is required. List<Property Map>
Pipelines belonging to a given pipeline group.
persistence Property Map
Persistence options to all pipelines in the instance.

SyslogReceiverResponse

Endpoint This property is required. string
Syslog receiver endpoint definition. Example: 0.0.0.0:.
Protocol string
Protocol to parse syslog messages. Default rfc3164
Endpoint This property is required. string
Syslog receiver endpoint definition. Example: 0.0.0.0:.
Protocol string
Protocol to parse syslog messages. Default rfc3164
endpoint This property is required. String
Syslog receiver endpoint definition. Example: 0.0.0.0:.
protocol String
Protocol to parse syslog messages. Default rfc3164
endpoint This property is required. string
Syslog receiver endpoint definition. Example: 0.0.0.0:.
protocol string
Protocol to parse syslog messages. Default rfc3164
endpoint This property is required. str
Syslog receiver endpoint definition. Example: 0.0.0.0:.
protocol str
Protocol to parse syslog messages. Default rfc3164
endpoint This property is required. String
Syslog receiver endpoint definition. Example: 0.0.0.0:.
protocol String
Protocol to parse syslog messages. Default rfc3164

SystemDataResponse

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.
LastModifiedAt string
The timestamp of resource last modification (UTC)
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.
LastModifiedAt string
The timestamp of resource last modification (UTC)
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.
lastModifiedAt String
The timestamp of resource last modification (UTC)
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.
lastModifiedAt string
The timestamp of resource last modification (UTC)
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_at str
The timestamp of resource last modification (UTC)
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.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

TcpExporterResponse

Url This property is required. string
TCP url to export.
Url This property is required. string
TCP url to export.
url This property is required. String
TCP url to export.
url This property is required. string
TCP url to export.
url This property is required. str
TCP url to export.
url This property is required. String
TCP url to export.

UdpReceiverResponse

Endpoint This property is required. string
TCP endpoint definition. Example: 0.0.0.0:.
Encoding string
The encoding of the stream being received.
JsonArrayMapper Pulumi.AzureNative.Monitor.Inputs.JsonArrayMapperResponse
Json array mapper - allows this udp receiver to parse a value from a given source field as a json array, match a key to each parsed value and output the key-value map to a given output field.
ReadQueueLength int
Max read queue length.
Endpoint This property is required. string
TCP endpoint definition. Example: 0.0.0.0:.
Encoding string
The encoding of the stream being received.
JsonArrayMapper JsonArrayMapperResponse
Json array mapper - allows this udp receiver to parse a value from a given source field as a json array, match a key to each parsed value and output the key-value map to a given output field.
ReadQueueLength int
Max read queue length.
endpoint This property is required. String
TCP endpoint definition. Example: 0.0.0.0:.
encoding String
The encoding of the stream being received.
jsonArrayMapper JsonArrayMapperResponse
Json array mapper - allows this udp receiver to parse a value from a given source field as a json array, match a key to each parsed value and output the key-value map to a given output field.
readQueueLength Integer
Max read queue length.
endpoint This property is required. string
TCP endpoint definition. Example: 0.0.0.0:.
encoding string
The encoding of the stream being received.
jsonArrayMapper JsonArrayMapperResponse
Json array mapper - allows this udp receiver to parse a value from a given source field as a json array, match a key to each parsed value and output the key-value map to a given output field.
readQueueLength number
Max read queue length.
endpoint This property is required. str
TCP endpoint definition. Example: 0.0.0.0:.
encoding str
The encoding of the stream being received.
json_array_mapper JsonArrayMapperResponse
Json array mapper - allows this udp receiver to parse a value from a given source field as a json array, match a key to each parsed value and output the key-value map to a given output field.
read_queue_length int
Max read queue length.
endpoint This property is required. String
TCP endpoint definition. Example: 0.0.0.0:.
encoding String
The encoding of the stream being received.
jsonArrayMapper Property Map
Json array mapper - allows this udp receiver to parse a value from a given source field as a json array, match a key to each parsed value and output the key-value map to a given output field.
readQueueLength Number
Max read queue length.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi