az monitor pipeline-group
Note
このリファレンスは、Azure CLI (バージョン 2.61.0 以降) の monitor-pipeline-group 拡張機能の一部です。 az monitor pipeline-group コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
パイプライン グループを管理します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az monitor pipeline-group create |
パイプライン グループ インスタンスを作成します。 |
Extension | GA |
az monitor pipeline-group delete |
パイプライン グループ インスタンスを削除します。 |
Extension | GA |
az monitor pipeline-group list |
指定したサブスクリプション内のすべてのワークスペースを一覧表示します。 |
Extension | GA |
az monitor pipeline-group show |
特定のパイプライン グループ インスタンスを取得します。 |
Extension | GA |
az monitor pipeline-group update |
パイプライン グループ インスタンスを更新します。 |
Extension | GA |
az monitor pipeline-group wait |
条件が満たされるまで CLI を待機状態にします。 |
Extension | GA |
az monitor pipeline-group create
パイプライン グループ インスタンスを作成します。
az monitor pipeline-group create --name --pipeline-group-name
--resource-group
[--exporters]
[--extended-___location]
[--___location]
[--network-config]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--processors]
[--receivers]
[--replicas]
[--service]
[--tags]
例
UDP レシーバーを使用して PipelineGroup インスタンスを作成する
az monitor pipeline-group create --resource-group myResourceGroup --pipeline-group-name plGroup1 --___location eastus2 --extended-___location "{name:/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/myTestCustomLocation,type:CustomLocation}" --tags "{tag1:A,tag2:B}" --receivers "[{type:UDP,name:udp-receiver1,udp:{endpoint:'0.0.0.0:518',encoding:utf-8}}]" --processors "[]" --exporters "[{type:AzureMonitorWorkspaceLogs,name:my-workspace-logs-exporter1,azure-monitor-workspace-logs:{api:{data-collection-endpoint-url:'https://logs-myingestion-eb0s.eastus-1.ingest.monitor.azure.com',stream:Custom-MyTableRawData_CL,data-collection-rule:dcr-00000000000000000000000000000000,schema:{record-map:[{from:body,to:Body},{from:severity_text,to:SeverityText},{from:time_unix_nano,to:TimeGenerated}]}},concurrency:{worker-count:4,batch-queue-size:100}}}]" --service "{pipelines:[{name:MyPipelineForLogs1,type:logs,receivers:[udp-receiver1],processors:[],exporters:[my-workspace-logs-exporter1]}]}"
必須のパラメーター
パイプライン グループの名前。 名前では大文字と小文字が区別されません。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
パイプライン グループ インスタンスに指定されたエクスポーター。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
指定されたパイプライン グループの拡張された場所。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Resource Arguments |
リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Arguments |
パイプライン グループ インスタンスのネットワーク構成。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
パイプライン グループ インスタンスに指定されたプロセッサ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
パイプライン グループ インスタンスに指定されたレシーバー。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
パイプライン グループ インスタンスのレプリカの量を定義します。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
特定のパイプライン グループ インスタンスのサービス セクション。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Resource Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az monitor pipeline-group delete
パイプライン グループ インスタンスを削除します。
az monitor pipeline-group delete [--ids]
[--name --pipeline-group-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
パイプライン グループの名前。 名前では大文字と小文字が区別されません。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
確認を求めないでください。
プロパティ | 値 |
---|---|
規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az monitor pipeline-group list
指定したサブスクリプション内のすべてのワークスペースを一覧表示します。
az monitor pipeline-group list [--max-items]
[--next-token]
[--resource-group]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token
トークン値を指定します。
プロパティ | 値 |
---|---|
Parameter group: | Pagination Arguments |
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
プロパティ | 値 |
---|---|
Parameter group: | Pagination Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az monitor pipeline-group show
特定のパイプライン グループ インスタンスを取得します。
az monitor pipeline-group show [--ids]
[--name --pipeline-group-name]
[--resource-group]
[--subscription]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
パイプライン グループの名前。 名前では大文字と小文字が区別されません。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az monitor pipeline-group update
パイプライン グループ インスタンスを更新します。
az monitor pipeline-group update [--add]
[--exporters]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name --pipeline-group-name]
[--network-config]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--processors]
[--receivers]
[--remove]
[--replicas]
[--resource-group]
[--service]
[--set]
[--subscription]
[--tags]
例
パイプライン グループ インスタンスを更新する
az monitor pipeline-group update --resource-group myResourceGroup --pipeline-group-name plGroup1 --receivers "[{type:UDP,name:udp-receiver1,udp:{endpoint:'0.0.0.0:518',encoding:utf-8}}]" --processors "[]" --exporters "[{type:AzureMonitorWorkspaceLogs,name:my-workspace-logs-exporter1,azure-monitor-workspace-logs:{api:{data-collection-endpoint-url:'https://logs-myingestion-eb0s.eastus-1.ingest.monitor.azure.com',stream:Custom-MyTableRawData_CL,data-collection-rule:dcr-00000000000000000000000000000000,schema:{record-map:[{from:body,to:Body},{from:severity_text,to:SeverityText},{from:time_unix_nano,to:TimeGenerated}]}},concurrency:{worker-count:4,batch-queue-size:100}}}]" --service "{pipelines:[{name:MyPipelineForLogs1,type:logs,receivers:[udp-receiver1],processors:[],exporters:[my-workspace-logs-exporter1]}]}"
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
パイプライン グループ インスタンスに指定されたエクスポーター。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
パイプライン グループの名前。 名前では大文字と小文字が区別されません。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
パイプライン グループ インスタンスのネットワーク構成。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
パイプライン グループ インスタンスに指定されたプロセッサ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
パイプライン グループ インスタンスに指定されたレシーバー。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
パイプライン グループ インスタンスのレプリカの量を定義します。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
特定のパイプライン グループ インスタンスのサービス セクション。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Resource Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az monitor pipeline-group wait
条件が満たされるまで CLI を待機状態にします。
az monitor pipeline-group wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name --pipeline-group-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
削除されるまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
リソースが存在するまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
ポーリング間隔 (秒単位)。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | 30 |
パイプライン グループの名前。 名前では大文字と小文字が区別されません。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
最大待機時間 (秒単位)。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | 3600 |
provisioningState が 'Succeeded' で更新されるまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |