New-AzPipelineGroup
create a pipeline group instance.
Syntax
New-AzPipelineGroup
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-Location <String>
[-Exporter <IExporter[]>]
[-ExtendedLocationName <String>]
[-ExtendedLocationType <String>]
[-NetworkingConfiguration <INetworkingConfiguration[]>]
[-PersistencePersistentVolumeName <String>]
[-Processor <IProcessor[]>]
[-Receiver <IReceiver[]>]
[-Replica <Int32>]
[-ServicePipeline <IPipeline[]>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzPipelineGroup
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-JsonFilePath <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzPipelineGroup
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-JsonString <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
create a pipeline group instance.
Examples
Example 1: Create Pipeline Group with JSON file
New-AzPipelineGroup -JsonFilePath CreatePipelineGroupBody.json -Name testgroup -ResourceGroupName kubetest -SubscriptionId 00000000-0000-0000-0000-000000000000
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/prov
iders/Microsoft.ExtendedLocation/customLocations/myloc
ExtendedLocationType : CustomLocation
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/kubetest/prov
iders/Microsoft.Monitor/pipelineGroups/testgroup
Location : centraluseuap
Name : testgroup
NetworkingConfiguration :
PersistencePersistentVolumeName :
Processor : {{
"batch": {
"batchSize": 10
},
"type": "Batch",
"name": "batchproc1"
}}
ProvisioningState : Succeeded
Receiver : {{
"otlp": {
"endpoint": "0.0.0.0:7778"
},
"type": "OTLP",
"name": "otlp1"
}, {
"udp": {
"endpoint": "0.0.0.0:5556"
},
"type": "UDP",
"name": "myudpreceiveralittlelong26283032"
}, {
"syslog": {
"endpoint": "0.0.0.0:4445"
},
"type": "Syslog",
"name": "mysyslog1"
}}
Replica :
ResourceGroupName : kubetest
RetryAfter :
ServicePipeline : {{
"name": "MyPipeline1",
"type": "logs",
"receivers": [ "otlp1", "myudpreceiveralittlelong26283032", "mysyslog1" ],
"processors": [ "batchproc1" ],
"exporters": [ "gigla1" ]
}}
SystemDataCreatedAt : 9/26/2024 6:50:55 AM
SystemDataCreatedBy : xxxxxxxx@microsoft.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 9/26/2024 6:51:30 AM
SystemDataLastModifiedBy : 319f651f-7ddb-4fc6-9857-7aef9250bd05
SystemDataLastModifiedByType : Application
Tag : {
}
Type : microsoft.monitor/pipelinegroupsCreate Pipeline Group with JSON file
Example 2: Create Pipeline Group with expanded parameters
New-AzPipelineGroup -Name testgroup -ResourceGroupName kubetest -SubscriptionId 00000000-0000-0000-0000-000000000000 -Location centraluseuap -ExtendedLocationName "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/kubetest/providers/Microsoft.ExtendedLocation/customLocations/myloc" -ExtendedLocationType CustomLocation -NetworkingConfiguration @() -Replica 1 -Exporter @{name="gigla1"; type="AzureMonitorWorkspaceLogs"; azureMonitorWorkspaceLog=@{api=@{dataCollectionEndpointUrl="https://myexporter.eastus-1.ingest.monitor.azure.com"; dataCollectionRule="dcr-00000000000000000000000000000000"; stream="Custom-MyTableRawData"; schema=@{recordMap=@(@{from="body"; to="Body"},@{from="severity_text"; to="SeverityText"},@{from="time_unix_nano"; to="TimeGenerated"})}}}} -Processor @{name="batchproc1"; type="Batch"; batch=@{batchSize=10}} -Receiver @(@{name="otlp1"; type="OTLP"; otlp=@{endpoint="0.0.0.0:7777"}}, @{name="myudpreceiveralittlelong26283032"; type="UDP"; udp=@{endpoint="0.0.0.0:5555"}}, @{name="mysyslog1"; type="Syslog"; syslog=@{endpoint="0.0.0.0:4444"}}) -ServicePipeline @{name="MyPipeline1"; type="logs"; receiver=@("otlp1", "myudpreceiveralittlelong26283032", "mysyslog1"); processor=@("batchproc1"); exporter=@("gigla1")}
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/prov
iders/Microsoft.ExtendedLocation/customLocations/myloc
ExtendedLocationType : CustomLocation
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/kubetest/prov
iders/Microsoft.Monitor/pipelineGroups/testgroup
Location : centraluseuap
Name : testgroup
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/26/2024 8:18:42 AM
SystemDataCreatedBy : xxxxxxxx@microsoft.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 9/26/2024 8:19:11 AM
SystemDataLastModifiedBy : 319f651f-7ddb-4fc6-9857-7aef9250bd05
SystemDataLastModifiedByType : Application
Tag : {
}
Type : microsoft.monitor/pipelinegroupsCreate Pipeline Group with expanded parameters
Parameters
-AsJob
Run the command as a job
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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 |
-Exporter
The exporters specified for a pipeline group instance.
| Type: | IExporter[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExtendedLocationName
The name of the extended location.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExtendedLocationType
The type of the extended location.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JsonFilePath
Path of Json file supplied to the Create operation
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JsonString
Json string supplied to the Create operation
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
The geo-location where the resource lives
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| 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 |
-NetworkingConfiguration
Networking configurations for the pipeline group instance.
| Type: | INetworkingConfiguration[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PersistencePersistentVolumeName
The name of the mounted persistent volume.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Processor
The processors specified for a pipeline group instance.
| Type: | IProcessor[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Receiver
The receivers specified for a pipeline group instance.
| Type: | IReceiver[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Replica
Defines the amount of replicas of the pipeline group instance.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-ServicePipeline
Pipelines belonging to a given pipeline group.
| Type: | IPipeline[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-Tag
Resource tags.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
Samarbeta med oss på GitHub
Källan för det här innehållet finns på GitHub, där du även kan skapa och granska ärenden och pull-begäranden. Se vår deltagarguide för mer information.
Azure PowerShell