Edit

Share via

Get-AzPipelineGroup

  • Reference
Module:
Az.Monitor

Returns the specific pipeline group instance.

Syntax

Get-AzPipelineGroup
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPipelineGroup
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPipelineGroup
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPipelineGroup
   -InputObject <IPipelineGroupIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Returns the specific pipeline group instance.

Examples

Example 1: List all the pipeline group resources in a resource group

Get-AzPipelineGroup -SubscriptionId 00000000-0000-0000-0000-000000000000 -ResourceGroupName testgroup

Exporter                        : {{
                                    "azureMonitorWorkspaceLogs": {
                                      "api": {
                                        "schema": {
                                          "recordMap": [
                                            {
                                              "from": "body",
                                              "to": "Body"
                                            },
                                            {
                                              "from": "severity_text",
                                              "to": "SeverityText"
                                            },
                                            {
                                              "from": "time_unix_nano",
                                              "to": "TimeGenerated"
                                            }
                                          ]
                                        },
                                        "dataCollectionEndpointUrl":
                                  "https://myexporter.eastus-1.ingest.monitor.azure.com",
                                        "stream": "Custom-MyTableRawData",
                                        "dataCollectionRule": "dcr-00000000000000000000000000000000"
                                      }
                                    },
                                    "type": "AzureMonitorWorkspaceLogs",
                                    "name": "gigla1"
                                  }}
ExtendedLocationName            : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/kubetest/provid
                                  ers/Microsoft.ExtendedLocation/customLocations/myloc
ExtendedLocationType            : CustomLocation
Id                              : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/kubetest/provid
                                  ers/Microsoft.Monitor/pipelineGroups/mygroup
Location                        : eastus2euap
Name                            : mygroup
NetworkingConfiguration         : {}
PersistencePersistentVolumeName :
Processor                       : {{
                                    "batch": {
                                      "batchSize": 10
                                    },
                                    "type": "Batch",
                                    "name": "batchproc1"
                                  }}
ProvisioningState               : Succeeded
Receiver                        : {{
                                    "otlp": {
                                      "endpoint": "0.0.0.0:7777"
                                    },
                                    "type": "OTLP",
                                    "name": "otlp1"
                                  }, {
                                    "udp": {
                                      "endpoint": "0.0.0.0:5555"
                                    },
                                    "type": "UDP",
                                    "name": "myudpreceiveralittlelong26283032"
                                  }, {
                                    "syslog": {
                                      "endpoint": "0.0.0.0:4444"
                                    },
                                    "type": "Syslog",
                                    "name": "mysyslog1"
                                  }}
Replica                         : 1
ResourceGroupName               : kubetest
RetryAfter                      :
ServicePipeline                 : {{
                                    "name": "MyPipeline1",
                                    "type": "logs",
                                    "receivers": [ "otlp1", "myudpreceiveralittlelong26283032", "mysyslog1" ],
                                    "processors": [ "batchproc1" ],
                                    "exporters": [ "gigla1" ]
                                  }}
SystemDataCreatedAt             : 9/25/2024 11:24:39 AM
SystemDataCreatedBy             : xxxxxxxx@microsoft.com
SystemDataCreatedByType         : User
SystemDataLastModifiedAt        : 9/25/2024 11:25:11 AM
SystemDataLastModifiedBy        : 00000000-0000-0000-0000-000000000000
SystemDataLastModifiedByType    : Application
Tag                             : {
                                  }
Type                            : microsoft.monitor/pipelinegroups

List all the pipeline group resources in a resource group

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter

Type:IPipelineGroupIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of pipeline group. The name is case insensitive.

Type:String
Aliases:PipelineGroupName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IPipelineGroupIdentity

Outputs

IPipelineGroup