Microsoft.Network networkWatchers/packetCaptures 2022-07-01
Bicep リソース定義
networkWatchers/packetCaptures リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Network/networkWatchers/packetCaptures リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Network/networkWatchers/packetCaptures@2022-07-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
bytesToCapturePerPacket: int
filters: [
{
localIPAddress: 'string'
localPort: 'string'
protocol: 'string'
remoteIPAddress: 'string'
remotePort: 'string'
}
]
scope: {
exclude: [
'string'
]
include: [
'string'
]
}
storageLocation: {
filePath: 'string'
storageId: 'string'
storagePath: 'string'
}
target: 'string'
targetType: 'string'
timeLimitInSeconds: int
totalBytesPerSession: int
}
}
プロパティ値
networkWatchers/packetCaptures
名前 | 説明 | 値 |
---|---|---|
name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。 |
種類のリソースのシンボル名: networkWatchers |
properties | パケット キャプチャのプロパティ。 | PacketCaptureParametersOrPacketCaptureResultProperti... (必須) |
PacketCaptureParametersOrPacketCaptureResultProperti...
名前 | 説明 | 値 |
---|---|---|
bytesToCapturePerPacket | パケットごとにキャプチャされたバイト数。残りのバイトは切り捨てられます。 | INT 制約: 最小値 = 0 最大値 = 4294967295 |
filters | パケット キャプチャ フィルターの一覧。 | PacketCaptureFilter[] |
scope | パケット キャプチャを実行するために含めたり除外したりできる AzureVMSS インスタンスの一覧。 インクルードと除外の両方が空の場合、パケット キャプチャは AzureVMSS のすべてのインスタンスで実行されます。 | PacketCaptureMachineScope |
storageLocation | パケット キャプチャ セッションの保存場所。 | PacketCaptureStorageLocation (必須) |
ターゲット (target) | ターゲット リソースの ID(ターゲットの種類として AzureVM と AzureVMSS のみ) が現在サポートされています。 | string (必須) |
targetType | 指定されたリソースのターゲットの種類。 | 'AzureVM' 'AzureVMSS' |
timeLimitInSeconds | キャプチャ セッションの最大継続時間 (秒単位)。 | INT 制約: 最小値 = 0 最大値 = 18000 |
totalBytesPerSession | キャプチャ出力の最大サイズ。 | INT 制約: 最小値 = 0 最大値 = 4294967295 |
PacketCaptureFilter
名前 | 説明 | 値 |
---|---|---|
localIPAddress | フィルター処理するローカル IP アドレス。 表記: 単一アドレス入力の場合は "127.0.0.1" です。 範囲の "127.0.0.1-127.0.0.255" "127.0.0.1;127.0.0.5"? 複数のエントリの場合は 。 現在、複数の範囲はサポートされていません。 現在サポートされていない複数のエントリを含む範囲の混在。 既定値は null です。 | string |
localPort | フィルター処理するローカル ポート。 表記: 単一ポート エントリの場合は "80" です。範囲の場合は 80 から 85" です。 "80;443;" (複数のエントリの場合)。 現在サポートされていない複数の範囲。 現在サポートされていない複数のエントリとの範囲の混在。 既定値は null です。 | string |
protocol | フィルター処理するプロトコル。 | 'Any' 'TCP' 'UDP' |
remoteIPAddress | フィルター処理するローカル IP アドレス。 表記: 単一アドレス入力の場合は "127.0.0.1" です。 範囲の場合は "127.0.0.1-127.0.0.255" です。 "127.0.0.1;127.0.0.5;" (複数のエントリの場合)。 現在サポートされていない複数の範囲。 現在サポートされていない複数のエントリとの範囲の混在。 既定値は null です。 | string |
remotePort | フィルター処理するリモート ポート。 表記: 単一ポート エントリの場合は "80" です。範囲の場合は 80 から 85" です。 "80;443;" (複数のエントリの場合)。 現在サポートされていない複数の範囲。 現在サポートされていない複数のエントリとの範囲の混在。 既定値は null です。 | string |
PacketCaptureMachineScope
名前 | 説明 | 値 |
---|---|---|
除外 | パケット キャプチャの実行から AzureVMSS から除外する必要がある AzureVMSS インスタンスの一覧。 | string[] |
include | パケット キャプチャを実行する AzureVMSS インスタンスの一覧。 | string[] |
PacketCaptureStorageLocation
名前 | 説明 | 値 |
---|---|---|
filePath | ターゲット VM 上の有効なローカル パス。 キャプチャ ファイル (*.cap) の名前を含める必要があります。 Linux 仮想マシンの場合は、/var/captures で始まる必要があります。 ストレージ ID が指定されていない場合は必須。それ以外の場合は省略可能です。 | string |
storageId | パケット キャプチャ セッションを保存するストレージ アカウントの ID。 ローカル ファイル パスが指定されていない場合は必須。 | string |
storagePath | パケット キャプチャを保存するストレージ パスの URI。 パケット キャプチャを保存する場所を記述する整形式の URI である必要があります。 | string |
ARM テンプレート リソース定義
networkWatchers/packetCaptures リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Network/networkWatchers/packetCaptures リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Network/networkWatchers/packetCaptures",
"apiVersion": "2022-07-01",
"name": "string",
"properties": {
"bytesToCapturePerPacket": "int",
"filters": [
{
"localIPAddress": "string",
"localPort": "string",
"protocol": "string",
"remoteIPAddress": "string",
"remotePort": "string"
}
],
"scope": {
"exclude": [ "string" ],
"include": [ "string" ]
},
"storageLocation": {
"filePath": "string",
"storageId": "string",
"storagePath": "string"
},
"target": "string",
"targetType": "string",
"timeLimitInSeconds": "int",
"totalBytesPerSession": "int"
}
}
プロパティ値
networkWatchers/packetCaptures
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.Network/networkWatchers/packetCaptures' |
apiVersion | リソース API のバージョン | '2022-07-01' |
name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
properties | パケット キャプチャのプロパティ。 | PacketCaptureParametersOrPacketCaptureResultProperti... (必須) |
PacketCaptureParametersOrPacketCaptureResultProperti...
名前 | 説明 | 値 |
---|---|---|
bytesToCapturePerPacket | パケットごとにキャプチャされたバイト数。残りのバイトは切り捨てられます。 | INT 制約: 最小値 = 0 最大値 = 4294967295 |
filters | パケット キャプチャ フィルターの一覧。 | PacketCaptureFilter[] |
scope | パケット キャプチャを実行するために含めるか除外できる AzureVMSS インスタンスの一覧。 含まれていると除外される両方が空の場合、パケット キャプチャは AzureVMSS のすべてのインスタンスで実行されます。 | PacketCaptureMachineScope |
storageLocation | パケット キャプチャ セッションの保存場所。 | PacketCaptureStorageLocation (必須) |
ターゲット (target) | ターゲット リソースの ID(ターゲットの種類として AzureVM と AzureVMSS のみ) が現在サポートされています。 | string (必須) |
targetType | 指定されたリソースのターゲットの種類。 | 'AzureVM' 'AzureVMSS' |
timeLimitInSeconds | キャプチャ セッションの最大継続時間 (秒単位)。 | INT 制約: 最小値 = 0 最大値 = 18000 |
totalBytesPerSession | キャプチャ出力の最大サイズ。 | INT 制約: 最小値 = 0 最大値 = 4294967295 |
PacketCaptureFilter
名前 | 説明 | 値 |
---|---|---|
localIPAddress | フィルター処理するローカル IP アドレス。 表記: 単一アドレス入力の場合は "127.0.0.1" です。 範囲の "127.0.0.1-127.0.0.255" "127.0.0.1;127.0.0.5"? 複数のエントリの場合は 。 現在、複数の範囲はサポートされていません。 現在サポートされていない複数のエントリを含む範囲の混在。 既定値は null です。 | string |
localPort | フィルター処理するローカル ポート。 表記: 単一ポート エントリの場合は "80" です。範囲の場合は 80 から 85" です。 "80;複数のエントリの場合は 443;" 。 現在、複数の範囲はサポートされていません。 現在サポートされていない複数のエントリを含む範囲の混在。 既定値は null です。 | string |
protocol | フィルター処理するプロトコル。 | 'Any' 'TCP' 'UDP' |
remoteIPAddress | フィルター処理するローカル IP アドレス。 表記: 単一アドレス入力の場合は "127.0.0.1" です。 範囲の "127.0.0.1-127.0.0.255" "127.0.0.1;複数のエントリの場合は 127.0.0.5;"。 現在、複数の範囲はサポートされていません。 現在サポートされていない複数のエントリを含む範囲の混在。 既定値は null です。 | string |
remotePort | フィルター処理するリモート ポート。 表記: 単一ポート エントリの場合は "80" です。範囲の場合は 80 から 85" です。 "80;複数のエントリの場合は 443;" 。 現在、複数の範囲はサポートされていません。 現在サポートされていない複数のエントリを含む範囲の混在。 既定値は null です。 | string |
PacketCaptureMachineScope
名前 | 説明 | 値 |
---|---|---|
除外 | 実行中のパケット キャプチャから AzureVMSS から除外する必要がある AzureVMSS インスタンスの一覧。 | string[] |
include | パケット キャプチャを実行する AzureVMSS インスタンスの一覧。 | string[] |
PacketCaptureStorageLocation
名前 | 説明 | 値 |
---|---|---|
filePath | ターゲット VM 上の有効なローカル パス。 キャプチャ ファイル (*.cap) の名前を含める必要があります。 Linux 仮想マシンの場合は、/var/captures で始まる必要があります。 ストレージ ID が指定されていない場合は必須。それ以外の場合は省略可能です。 | string |
storageId | パケット キャプチャ セッションを保存するストレージ アカウントの ID。 ローカル ファイル パスが指定されていない場合は必須です。 | string |
storagePath | パケット キャプチャを保存するストレージ パスの URI。 パケット キャプチャを保存する場所を記述する整形式 URI である必要があります。 | string |
Terraform (AzAPI プロバイダー) リソース定義
networkWatchers/packetCaptures リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Network/networkWatchers/packetCaptures リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkWatchers/packetCaptures@2022-07-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
bytesToCapturePerPacket = int
filters = [
{
localIPAddress = "string"
localPort = "string"
protocol = "string"
remoteIPAddress = "string"
remotePort = "string"
}
]
scope = {
exclude = [
"string"
]
include = [
"string"
]
}
storageLocation = {
filePath = "string"
storageId = "string"
storagePath = "string"
}
target = "string"
targetType = "string"
timeLimitInSeconds = int
totalBytesPerSession = int
}
})
}
プロパティ値
networkWatchers/packetCaptures
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.Network/networkWatchers/packetCaptures@2022-07-01" |
name | リソース名 | string (必須) |
parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: networkWatchers |
properties | パケット キャプチャのプロパティ。 | PacketCaptureParametersOrPacketCaptureResultProperti... (必須) |
PacketCaptureParametersOrPacketCaptureResultProperti...
名前 | 説明 | 値 |
---|---|---|
bytesToCapturePerPacket | パケットごとにキャプチャされたバイト数。残りのバイトは切り捨てられます。 | INT 制約: 最小値 = 0 最大値 = 4294967295 |
filters | パケット キャプチャ フィルターの一覧。 | PacketCaptureFilter[] |
scope | パケット キャプチャを実行するために含めるか除外できる AzureVMSS インスタンスの一覧。 含まれていると除外される両方が空の場合、パケット キャプチャは AzureVMSS のすべてのインスタンスで実行されます。 | PacketCaptureMachineScope |
storageLocation | パケット キャプチャ セッションの保存場所。 | PacketCaptureStorageLocation (必須) |
ターゲット (target) | ターゲット リソースの ID。現在、ターゲットの種類として AzureVM と AzureVMSS のみがサポートされています。 | string (必須) |
targetType | 指定されたリソースのターゲットの種類。 | "AzureVM" "AzureVMSS" |
timeLimitInSeconds | キャプチャ セッションの最大期間 (秒単位)。 | INT 制約: 最小値 = 0 最大値 = 18000 |
totalBytesPerSession | キャプチャ出力の最大サイズ。 | INT 制約: 最小値 = 0 最大値 = 4294967295 |
PacketCaptureFilter
名前 | 説明 | 値 |
---|---|---|
localIPAddress | フィルター処理するローカル IP アドレス。 表記: 単一アドレス入力の場合は "127.0.0.1" です。 範囲の場合は "127.0.0.1-127.0.0.255" です。 "127.0.0.1;127.0.0.5"? 複数のエントリの場合は 。 現在サポートされていない複数の範囲。 現在サポートされていない複数のエントリとの範囲の混在。 既定値は null です。 | string |
localPort | フィルター処理するローカル ポート。 表記: 単一ポート エントリの場合は "80" です。範囲の場合は 80 から 85" です。 "80;443;" (複数のエントリの場合)。 現在サポートされていない複数の範囲。 現在サポートされていない複数のエントリとの範囲の混在。 既定値は null です。 | string |
protocol | フィルター処理するプロトコル。 | "Any" "TCP" "UDP" |
remoteIPAddress | フィルター処理するローカル IP アドレス。 表記: 単一アドレス入力の場合は "127.0.0.1" です。 範囲の場合は "127.0.0.1-127.0.0.255" です。 "127.0.0.1;127.0.0.5;" (複数のエントリの場合)。 現在サポートされていない複数の範囲。 現在サポートされていない複数のエントリとの範囲の混在。 既定値は null です。 | string |
remotePort | フィルター処理するリモート ポート。 表記: 単一ポート エントリの場合は "80" です。範囲の場合は 80 から 85" です。 "80;443;" (複数のエントリの場合)。 現在サポートされていない複数の範囲。 現在サポートされていない複数のエントリとの範囲の混在。 既定値は null です。 | string |
PacketCaptureMachineScope
名前 | 説明 | 値 |
---|---|---|
除外 | 実行中のパケット キャプチャから AzureVMSS から除外する必要がある AzureVMSS インスタンスの一覧。 | string[] |
include | パケット キャプチャを実行する AzureVMSS インスタンスの一覧。 | string[] |
PacketCaptureStorageLocation
名前 | 説明 | 値 |
---|---|---|
filePath | ターゲット VM 上の有効なローカル パス。 キャプチャ ファイル (*.cap) の名前を含める必要があります。 Linux 仮想マシンの場合は、/var/captures で始まる必要があります。 ストレージ ID が指定されていない場合は必須。それ以外の場合は省略可能です。 | string |
storageId | パケット キャプチャ セッションを保存するストレージ アカウントの ID。 ローカル ファイル パスが指定されていない場合は必須です。 | string |
storagePath | パケット キャプチャを保存するストレージ パスの URI。 パケット キャプチャを保存する場所を記述する整形式 URI である必要があります。 | string |