Microsoft.Network NetworkWatchers/packetCaptures 2023-11-01
Definice prostředku Bicep
Typ prostředku networkWatchers/packetCaptures je možné nasadit s operacemi, které cílí:
- Skupiny prostředků – viz příkazy nasazení skupiny prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Network/networkWatchers/packetCaptures, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.Network/networkWatchers/packetCaptures@2023-11-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
bytesToCapturePerPacket: int
captureSettings: {
fileCount: int
fileSizeInBytes: int
sessionTimeLimitInSeconds: int
}
continuousCapture: bool
filters: [
{
localIPAddress: 'string'
localPort: 'string'
protocol: 'string'
remoteIPAddress: 'string'
remotePort: 'string'
}
]
scope: {
exclude: [
'string'
]
include: [
'string'
]
}
storageLocation: {
filePath: 'string'
localPath: 'string'
storageId: 'string'
storagePath: 'string'
}
target: 'string'
targetType: 'string'
timeLimitInSeconds: int
totalBytesPerSession: int
}
}
Hodnoty vlastností
networkWatchers/packetCaptures
Název | Description | Hodnota |
---|---|---|
name | Název prostředku Přečtěte si, jak nastavit názvy a typy pro podřízené prostředky v Bicepu. |
string (povinné) |
Nadřazené | V nástroji Bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek. |
Symbolický název prostředku typu : networkWatchers |
properties | Vlastnosti zachytávání paketů. | PacketCaptureParametersOrPacketCaptureResultProperti... (povinné) |
PacketCaptureParametersOrPacketCaptureResultProperti...
Název | Description | Hodnota |
---|---|---|
bytesToCapturePerPacket | Počet bajtů zachycených na paket, zbývající bajty jsou zkráceny. | int Omezení: Minimální hodnota = 0 Maximální hodnota = 4294967295 |
captureSettings | Nastavení zachycení obsahuje hodnoty FileCount, FileSizeInBytes a SessionTimeLimitInSeconds. | PacketCaptureSettings |
continuousCapture | Toto průběžné zachytávání je logická hodnota s možnou hodnotou null, která může obsahovat hodnotu null, true nebo false. Pokud tento parametr nepředáme, považujeme ho za null, výchozí hodnota je null. | bool |
filtry | Seznam filtrů pro zachytávání paketů | PacketCaptureFilter[] |
scope | Seznam instancí AzureVMSS, které je možné zahrnout nebo vyloučit za účelem spuštění zachytávání paketů. Pokud jsou zahrnuté i vyloučené prázdné, zachytávání paketů se spustí ve všech instancích AzureVMSS. | PacketCaptureMachineScope |
Storagelocation | Umístění úložiště pro relaci zachytávání paketů. | PacketCaptureStorageLocation (povinné) |
Cíl | Aktuálně se podporuje ID cílového prostředku, pouze AzureVM a AzureVMSS jako cílový typ. | string (povinné) |
Targettype | Cílový typ zadaného prostředku. | AzureVM AzureVMSS |
timeLimitInSeconds | Maximální doba trvání relace zachytávání v sekundách | int Omezení: Minimální hodnota = 0 Maximální hodnota = 18000 |
totalBytesPerSession | Maximální velikost výstupu zachycení. | int Omezení: Minimální hodnota = 0 Maximální hodnota = 4294967295 |
PacketCaptureSettings
Název | Description | Hodnota |
---|---|---|
fileCount | Počet souborů. Výchozí hodnota počtu je 10 a maximální počet je 10000. | int Omezení: Minimální hodnota = 0 Maximální hodnota = 10000 |
fileSizeInBytes | Počet zachycených bajtů na paket Výchozí hodnota v bajtech 104857600 (100 MB) a maximum v bajtech 4294967295 (4 GB). | int Omezení: Minimální hodnota = 0 Maximální hodnota = 4294967295 |
sessionTimeLimitInSeconds | Maximální doba trvání relace zachycení v sekundách je pro soubor 604800s (7 dnů). Výchozí hodnota v sekundách 86400 (1 den). | int Omezení: Minimální hodnota = 0 Maximální hodnota = 604800 |
PacketCaptureFilter
Název | Description | Hodnota |
---|---|---|
localIPAddress | Místní IP adresa, podle které se má filtrovat. Notace: "127.0.0.1" pro jeden záznam adresy. "127.0.0.1-127.0.0.255" pro rozsah. "127.0.0.1; 127.0.0.5"? pro více položek. Více oblastí není aktuálně podporováno. Kombinování rozsahů s více položkami není aktuálně podporováno. Výchozí hodnota = null. | řetězec |
localPort | Místní port, na který se má filtrovat. Notace: "80" pro jeden port. 80-85" pro rozsah. "80; 443;" pro více položek. Více oblastí není aktuálně podporováno. Kombinování rozsahů s více položkami není aktuálně podporováno. Výchozí hodnota = null. | řetězec |
Protokol | Protokol, který má být filtrován. | 'Any' (Libovolný) 'TCP' UDP |
remoteIPAddress | Místní IP adresa, podle které se má filtrovat. Notace: "127.0.0.1" pro jeden záznam adresy. "127.0.0.1-127.0.0.255" pro rozsah. "127.0.0.1; 127.0.0.5;" pro více položek. Více oblastí není aktuálně podporováno. Kombinování rozsahů s více položkami není aktuálně podporováno. Výchozí hodnota = null. | řetězec |
remotePort | Vzdálený port, na který se má filtrovat. Notace: "80" pro jeden port. 80-85" pro rozsah. "80; 443;" pro více položek. Více oblastí není aktuálně podporováno. Kombinování rozsahů s více položkami není aktuálně podporováno. Výchozí hodnota = null. | řetězec |
PacketCaptureMachineScope
Název | Description | Hodnota |
---|---|---|
vyloučení | Seznam instancí AzureVMSS, které musí být vyloučeny ze služby AzureVMSS ze zachytávání paketů. | string[] |
include | Seznam instancí AzureVMSS, na kterých se má spustit zachytávání paketů | string[] |
PacketCaptureStorageLocation
Název | Description | Hodnota |
---|---|---|
Filepath | Tato cesta je neplatná, pokud je průběžné zachytávání k dispozici s "true" nebo "false". Platná místní cesta na cílovém virtuálním počítači. Musí obsahovat název souboru zachycení (*.cap). Pro virtuální počítač s Linuxem musí začínat /var/captures. Vyžaduje se, pokud se nezadá ID úložiště, jinak volitelné. | řetězec |
localPath | Tato cesta je platná, pokud se k průběžnému zachytávání poskytuje hodnota true nebo false, a vyžaduje se, pokud se nezadá ID úložiště, jinak volitelné. Musí obsahovat název souboru zachycení (*.cap). Pro virtuální počítač s Linuxem musí začínat /var/captures. | řetězec |
storageId | ID účtu úložiště pro uložení relace zachytávání paketů. Vyžaduje se, pokud není k dispozici žádná cesta localPath ani filePath. | řetězec |
storagePath | Identifikátor URI cesty k úložišti pro uložení zachytávání paketů. Musí to být identifikátor URI ve správném formátu popisující umístění pro uložení zachytávání paketů. | řetězec |
Definice prostředku šablony ARM
Typ prostředku networkWatchers/packetCaptures je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy pro nasazení skupin prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Network/networkWatchers/packetCaptures, přidejte do šablony následující kód JSON.
{
"type": "Microsoft.Network/networkWatchers/packetCaptures",
"apiVersion": "2023-11-01",
"name": "string",
"properties": {
"bytesToCapturePerPacket": "int",
"captureSettings": {
"fileCount": "int",
"fileSizeInBytes": "int",
"sessionTimeLimitInSeconds": "int"
},
"continuousCapture": "bool",
"filters": [
{
"localIPAddress": "string",
"localPort": "string",
"protocol": "string",
"remoteIPAddress": "string",
"remotePort": "string"
}
],
"scope": {
"exclude": [ "string" ],
"include": [ "string" ]
},
"storageLocation": {
"filePath": "string",
"localPath": "string",
"storageId": "string",
"storagePath": "string"
},
"target": "string",
"targetType": "string",
"timeLimitInSeconds": "int",
"totalBytesPerSession": "int"
}
}
Hodnoty vlastností
networkWatchers/packetCaptures
Název | Description | Hodnota |
---|---|---|
typ | Typ prostředku | Microsoft.Network/networkWatchers/packetCaptures |
apiVersion | Verze rozhraní API prostředku | '2023-11-01' |
name | Název prostředku Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM. |
string (povinné) |
properties | Vlastnosti zachytávání paketů. | PacketCaptureParametersOrPacketCaptureResultProperti... (povinné) |
PacketCaptureParametersOrPacketCaptureResultProperti...
Název | Description | Hodnota |
---|---|---|
bytesToCapturePerPacket | Počet zachycených bajtů na paket, zbývající bajty jsou zkráceny. | int Omezení: Minimální hodnota = 0 Maximální hodnota = 4294967295 |
captureSettings | Nastavení zachycení obsahuje hodnoty FileCount, FileSizeInBytes a SessionTimeLimitInSeconds. | PacketCaptureSettings |
continuousCapture | Toto průběžné zachytávání je logická hodnota s možnou hodnotou null, která může obsahovat hodnoty null, true nebo false. Pokud tento parametr nepředáme, považujeme ho za null, výchozí hodnota je null. | bool |
filtry | Seznam filtrů pro zachytávání paketů. | PacketCaptureFilter[] |
scope | Seznam instancí AzureVMSS, které je možné zahrnout nebo vyloučit za účelem zachytávání paketů. Pokud jsou zahrnuté i vyloučené prázdné, zachytávání paketů se spustí na všech instancích AzureVMSS. | PacketCaptureMachineScope |
Storagelocation | Umístění úložiště pro relaci zachytávání paketů. | PacketCaptureStorageLocation (povinné) |
Cíl | ID cílového prostředku, aktuálně se podporuje pouze AzureVM a AzureVMSS jako cílový typ. | string (povinné) |
Targettype | Cílový typ zadaného prostředku. | AzureVM AzureVMSS |
časLimitInSeconds | Maximální doba trvání relace zachycení v sekundách | int Omezení: Minimální hodnota = 0 Maximální hodnota = 18000 |
totalBytesPerSession | Maximální velikost výstupu zachytávání | int Omezení: Minimální hodnota = 0 Maximální hodnota = 4294967295 |
PacketCaptureSettings
Název | Description | Hodnota |
---|---|---|
fileCount | Počet souborů Výchozí hodnota count je 10 a maximální počet je 10 000. | int Omezení: Minimální hodnota = 0 Maximální hodnota = 10000 |
fileSizeInBytes | Počet zachycených bajtů na paket Výchozí hodnota v bajtech 104857600 (100 MB) a maximum v bajtech 4294967295 (4 GB). | int Omezení: Minimální hodnota = 0 Maximální hodnota = 4294967295 |
sessionTimeLimitInSeconds | Maximální doba trvání relace zachycení v sekundách je pro soubor 604800s (7 dnů). Výchozí hodnota v sekundách 86400 (1 den). | int Omezení: Minimální hodnota = 0 Maximální hodnota = 604800 |
PacketCaptureFilter
Název | Description | Hodnota |
---|---|---|
localIPAddress | Místní IP adresa, podle které se má filtrovat. Notace: "127.0.0.1" pro jeden záznam adresy. "127.0.0.1-127.0.0.255" pro rozsah. "127.0.0.1; 127.0.0.5"? pro více položek. Více oblastí není aktuálně podporováno. Kombinování rozsahů s více položkami není aktuálně podporováno. Výchozí hodnota = null. | řetězec |
localPort | Místní port, na který se má filtrovat. Notace: "80" pro jeden port. 80-85" pro rozsah. "80; 443;" pro více položek. Více oblastí není aktuálně podporováno. Kombinování rozsahů s více položkami není aktuálně podporováno. Výchozí hodnota = null. | řetězec |
Protokol | Protokol, který má být filtrován. | 'Any' (Libovolný) 'TCP' UDP |
remoteIPAddress | Místní IP adresa, podle které se má filtrovat. Notace: "127.0.0.1" pro jeden záznam adresy. "127.0.0.1-127.0.0.255" pro rozsah. "127.0.0.1; 127.0.0.5;" pro více položek. Více oblastí není aktuálně podporováno. Kombinování rozsahů s více položkami není aktuálně podporováno. Výchozí hodnota = null. | řetězec |
remotePort | Vzdálený port, na který se má filtrovat. Notace: "80" pro jeden port. 80-85" pro rozsah. "80; 443;" pro více položek. Více oblastí není aktuálně podporováno. Kombinování rozsahů s více položkami není aktuálně podporováno. Výchozí hodnota = null. | řetězec |
PacketCaptureMachineScope
Název | Description | Hodnota |
---|---|---|
vyloučení | Seznam instancí AzureVMSS, které musí být vyloučeny ze služby AzureVMSS ze zachytávání paketů. | string[] |
include | Seznam instancí AzureVMSS, na kterých se má spustit zachytávání paketů | string[] |
PacketCaptureStorageLocation
Název | Description | Hodnota |
---|---|---|
Filepath | Tato cesta je neplatná, pokud je průběžné zachytávání k dispozici s "true" nebo "false". Platná místní cesta na cílovém virtuálním počítači. Musí obsahovat název souboru zachycení (*.cap). Pro virtuální počítač s Linuxem musí začínat /var/captures. Vyžaduje se, pokud se nezadá ID úložiště, jinak volitelné. | řetězec |
localPath | Tato cesta je platná, pokud se k průběžnému zachytávání poskytuje hodnota true nebo false, a vyžaduje se, pokud se nezadá ID úložiště, jinak volitelné. Musí obsahovat název souboru zachycení (*.cap). Pro virtuální počítač s Linuxem musí začínat /var/captures. | řetězec |
storageId | ID účtu úložiště pro uložení relace zachytávání paketů. Vyžaduje se, pokud není k dispozici žádná cesta localPath ani filePath. | řetězec |
storagePath | Identifikátor URI cesty k úložišti pro uložení zachytávání paketů. Musí to být identifikátor URI ve správném formátu popisující umístění pro uložení zachytávání paketů. | řetězec |
Definice prostředku Terraform (poskytovatel AzAPI)
Typ prostředku networkWatchers/packetCaptures je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Network/networkWatchers/packetCaptures, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkWatchers/packetCaptures@2023-11-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
bytesToCapturePerPacket = int
captureSettings = {
fileCount = int
fileSizeInBytes = int
sessionTimeLimitInSeconds = int
}
continuousCapture = bool
filters = [
{
localIPAddress = "string"
localPort = "string"
protocol = "string"
remoteIPAddress = "string"
remotePort = "string"
}
]
scope = {
exclude = [
"string"
]
include = [
"string"
]
}
storageLocation = {
filePath = "string"
localPath = "string"
storageId = "string"
storagePath = "string"
}
target = "string"
targetType = "string"
timeLimitInSeconds = int
totalBytesPerSession = int
}
})
}
Hodnoty vlastností
networkWatchers/packetCaptures
Název | Description | Hodnota |
---|---|---|
typ | Typ prostředku | Microsoft.Network/networkWatchers/packetCaptures@2023-11-01 |
name | Název prostředku | string (povinné) |
parent_id | ID prostředku, který je nadřazený pro tento prostředek. | ID prostředku typu: networkWatchers |
properties | Vlastnosti zachytávání paketů. | PacketCaptureParametersOrPacketCaptureResultProperti... (povinné) |
PacketCaptureParametersOrPacketCaptureResultProperti...
Název | Description | Hodnota |
---|---|---|
bytesToCapturePerPacket | Počet zachycených bajtů na paket, zbývající bajty jsou zkráceny. | int Omezení: Minimální hodnota = 0 Maximální hodnota = 4294967295 |
captureSettings | Nastavení zachycení obsahuje hodnoty FileCount, FileSizeInBytes a SessionTimeLimitInSeconds. | PacketCaptureSettings |
continuousCapture | Toto průběžné zachytávání je logická hodnota s možnou hodnotou null, která může obsahovat hodnoty null, true nebo false. Pokud tento parametr nepředáme, považujeme ho za null, výchozí hodnota je null. | bool |
filtry | Seznam filtrů pro zachytávání paketů. | PacketCaptureFilter[] |
scope | Seznam instancí AzureVMSS, které je možné zahrnout nebo vyloučit za účelem zachytávání paketů. Pokud jsou zahrnuté i vyloučené prázdné, zachytávání paketů se spustí na všech instancích AzureVMSS. | PacketCaptureMachineScope |
Storagelocation | Umístění úložiště pro relaci zachytávání paketů. | PacketCaptureStorageLocation (povinné) |
Cíl | ID cílového prostředku, aktuálně se podporuje pouze AzureVM a AzureVMSS jako cílový typ. | string (povinné) |
Targettype | Cílový typ zadaného prostředku. | AzureVM AzureVMSS |
časLimitInSeconds | Maximální doba trvání relace zachycení v sekundách | int Omezení: Minimální hodnota = 0 Maximální hodnota = 18000 |
totalBytesPerSession | Maximální velikost výstupu zachytávání | int Omezení: Minimální hodnota = 0 Maximální hodnota = 4294967295 |
PacketCaptureSettings
Název | Description | Hodnota |
---|---|---|
fileCount | Počet souborů Výchozí hodnota count je 10 a maximální počet je 10 000. | int Omezení: Minimální hodnota = 0 Maximální hodnota = 10000 |
fileSizeInBytes | Počet zachycených bajtů na paket Výchozí hodnota v bajtech 104857600 (100 MB) a maximum v bajtech 4294967295 (4 GB). | int Omezení: Minimální hodnota = 0 Maximální hodnota = 4294967295 |
sessionTimeLimitInSeconds | Maximální doba trvání relace zachycení v sekundách je pro soubor 604800s (7 dnů). Výchozí hodnota v sekundách 86400 (1 den). | int Omezení: Minimální hodnota = 0 Maximální hodnota = 604800 |
PacketCaptureFilter
Název | Description | Hodnota |
---|---|---|
localIPAddress | Místní IP adresa, podle které se má filtrovat. Notace: "127.0.0.1" pro jeden záznam adresy. "127.0.0.1-127.0.0.255" pro rozsah. "127.0.0.1; 127.0.0.5"? pro více položek. Více oblastí není aktuálně podporováno. Kombinování rozsahů s více položkami není aktuálně podporováno. Výchozí hodnota = null. | řetězec |
localPort | Místní port, na který se má filtrovat. Notace: "80" pro jeden port. 80-85" pro rozsah. "80; 443;" pro více položek. Více oblastí není aktuálně podporováno. Kombinování rozsahů s více položkami není aktuálně podporováno. Výchozí hodnota = null. | řetězec |
Protokol | Protokol, který má být filtrován. | "Any" "TCP" "UDP" |
remoteIPAddress | Místní IP adresa, podle které se má filtrovat. Notace: "127.0.0.1" pro jeden záznam adresy. "127.0.0.1-127.0.0.255" pro rozsah. "127.0.0.1; 127.0.0.5;" pro více položek. Více oblastí není aktuálně podporováno. Kombinování rozsahů s více položkami není aktuálně podporováno. Výchozí hodnota = null. | řetězec |
remotePort | Vzdálený port, na který se má filtrovat. Notace: "80" pro jeden port. 80-85" pro rozsah. "80; 443;" pro více položek. Více oblastí není aktuálně podporováno. Míchání rozsahů s více položkami není aktuálně podporováno. Výchozí = null. | řetězec |
PacketCaptureMachineScope
Název | Description | Hodnota |
---|---|---|
vyloučení | Seznam instancí AzureVMSS, které musí být vyloučeny ze služby AzureVMSS ze spouštění zachytávání paketů | string[] |
include | Seznam instancí AzureVMSS, na kterých se má spustit zachytávání paketů | string[] |
PacketCaptureStorageLocation
Název | Description | Hodnota |
---|---|---|
Filepath | Tato cesta je neplatná, pokud je u funkce Průběžné zachytávání k dispozici hodnota true nebo false. Platná místní cesta na cílovém virtuálním počítači. Musí obsahovat název souboru zachycení (*.cap). Pro virtuální počítač s Linuxem musí začínat na /var/captures. Vyžaduje se, pokud není zadané ŽÁDNÉ ID úložiště, jinak volitelné. | řetězec |
localPath | Tato cesta je platná, pokud má vlastnost Průběžné zachytávání hodnotu true nebo false a vyžaduje se, pokud není zadané ŽÁDNÉ ID úložiště, jinak volitelné. Musí obsahovat název souboru zachycení (*.cap). Pro virtuální počítač s Linuxem musí začínat na /var/captures. | řetězec |
storageId | ID účtu úložiště pro uložení relace zachytávání paketů. Vyžaduje se, pokud není k dispozici žádná cesta localPath nebo filePath. | řetězec |
storagePath | Identifikátor URI cesty úložiště pro uložení zachytávání paketů Musí to být dobře vytvořený identifikátor URI popisující umístění pro uložení zachytávání paketů. | řetězec |