New-AzPipelineGroup
パイプライン グループ インスタンスを作成します。
構文
CreateExpanded (既定)
New-AzPipelineGroup
-Name <String>
-ResourceGroupName <String>
-Location <String>
[-SubscriptionId <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>]
CreateViaJsonFilePath
New-AzPipelineGroup
-Name <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonString
New-AzPipelineGroup
-Name <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
パイプライン グループ インスタンスを作成します。
例
例 1: JSON ファイルを使用してパイプライン グループを作成する
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/pipelinegroups
JSON ファイルを使用してパイプライン グループを作成する
例 2: 拡張パラメーターを使用してパイプライン グループを作成する
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/pipelinegroups
パラメーターを展開してパイプライン グループを作成する
パラメーター
-AsJob
コマンドをジョブとして実行する
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
DefaultProfile パラメーターは機能しません。
別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。
パラメーターのプロパティ
| 型: | PSObject
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Exporter
パイプライン グループ インスタンスに指定されたエクスポーター。
パラメーターのプロパティ
| 型: | IExporter[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CreateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ExtendedLocationName
拡張された場所の名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CreateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ExtendedLocationType
拡張された場所の種類。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CreateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-JsonFilePath
作成操作に指定された Json ファイルのパス
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CreateViaJsonFilePath
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-JsonString
作成操作に指定された Json 文字列
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CreateViaJsonString
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Location
リソースが存在する地理的な場所
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CreateExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
パイプライン グループの名前。
名前は大文字と小文字が区別されます。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | PipelineGroupName |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-NetworkingConfiguration
パイプライン グループ インスタンスのネットワーク構成。
パラメーターのプロパティ
パラメーター セット
CreateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-NoWait
コマンドを非同期的に実行する
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PersistencePersistentVolumeName
マウントされた永続ボリュームの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CreateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Processor
パイプライン グループ インスタンスに指定されたプロセッサ。
パラメーターのプロパティ
| 型: | IProcessor[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CreateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Receiver
パイプライン グループ インスタンスに指定されたレシーバー。
パラメーターのプロパティ
| 型: | IReceiver[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CreateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Replica
パイプライン グループ インスタンスのレプリカの量を定義します。
パラメーターのプロパティ
| 型: | Int32
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CreateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループの名前。
名前は大文字と小文字が区別されます。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ServicePipeline
特定のパイプライン グループに属するパイプライン。
パラメーターのプロパティ
| 型: | IPipeline[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CreateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SubscriptionId
ターゲット サブスクリプションの ID。
値は UUID である必要があります。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | (Get-AzContext).Subscription.Id |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Tag
リソース タグ。
パラメーターのプロパティ
| 型: | Hashtable
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CreateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力