Microsoft.Network networkWatchers/packetCaptures 2023-05-01
Definição de recurso do Bicep
O tipo de recurso networkWatchers/packetCaptures pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Network/networkWatchers/packetCaptures, adicione o Bicep a seguir ao modelo.
resource symbolicname 'Microsoft.Network/networkWatchers/packetCaptures@2023-05-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
}
}
Valores de propriedade
networkWatchers/packetCaptures
Nome | Descrição | Valor |
---|---|---|
name | O nome do recurso Veja como definir nomes e tipos para recursos filho no Bicep. |
cadeia de caracteres (obrigatório) |
pai | No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte Recurso filho fora do recurso pai. |
Nome simbólico para o recurso do tipo: networkWatchers |
properties | Propriedades da captura de pacotes. | PacketCaptureParametersOrPacketCaptureResultProperti... (obrigatório) |
PacketCaptureParametersOrPacketCaptureResultProperti...
Nome | Descrição | Valor |
---|---|---|
bytesToCapturePerPacket | Número de bytes capturados por pacote, os bytes restantes são truncados. | INT Restrições: Valor mínimo = 0 Valor máximo = 4294967295 |
filtros | Uma lista de filtros de captura de pacotes. | PacketCaptureFilter[] |
scope | Uma lista de instâncias do AzureVMSS que podem ser incluídas ou excluídas para executar a captura de pacotes. Se incluídos e excluídos estiverem vazios, a captura de pacotes será executada em todas as instâncias do AzureVMSS. | PacketCaptureMachineScope |
Storagelocation | O local de armazenamento de uma sessão de captura de pacotes. | PacketCaptureStorageLocation (obrigatório) |
destino | Atualmente, há suporte para a ID do recurso de destino, apenas AzureVM e AzureVMSS como tipo de destino. | cadeia de caracteres (obrigatório) |
targetType | Tipo de destino do recurso fornecido. | 'AzureVM' 'AzureVMSS' |
timeLimitInSeconds | Duração máxima da sessão de captura em segundos. | INT Restrições: Valor mínimo = 0 Valor máximo = 18000 |
totalBytesPerSession | Tamanho máximo da saída de captura. | INT Restrições: Valor mínimo = 0 Valor máximo = 4294967295 |
PacketCaptureFilter
Nome | Descrição | Valor |
---|---|---|
localIPAddress | Endereço IP local a ser filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para intervalo. "127.0.0.1; 127.0.0.5"? para várias entradas. No momento, não há suporte para vários intervalos. No momento, não há suporte para a combinação de intervalos com várias entradas. Padrão = nulo. | string |
localPort | Porta local a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para intervalo. "80; 443;" para várias entradas. No momento, não há suporte para vários intervalos. No momento, não há suporte para a combinação de intervalos com várias entradas. Padrão = nulo. | string |
protocolo | Protocolo a ser filtrado. | 'Any' 'TCP' 'UDP' |
remoteIPAddress | Endereço IP local a ser filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para intervalo. "127.0.0.1; 127.0.0.5;" para várias entradas. No momento, não há suporte para vários intervalos. No momento, não há suporte para a combinação de intervalos com várias entradas. Padrão = nulo. | string |
Remoteport | Porta remota a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para intervalo. "80; 443;" para várias entradas. No momento, não há suporte para vários intervalos. No momento, não há suporte para a combinação de intervalos com várias entradas. Padrão = nulo. | string |
PacketCaptureMachineScope
Nome | Descrição | Valor |
---|---|---|
excluir | Lista de instâncias do AzureVMSS que precisam ser excluídas do AzureVMSS da execução da captura de pacotes. | string[] |
include | Lista de instâncias do AzureVMSS na qual executar a captura de pacotes. | string[] |
PacketCaptureStorageLocation
Nome | Descrição | Valor |
---|---|---|
filePath | Um caminho local válido na VM de destino. Deve incluir o nome do arquivo de captura (*.cap). Para a máquina virtual linux, ela deve começar com /var/captures. Obrigatório se nenhuma ID de armazenamento for fornecida, caso contrário, opcional. | string |
storageId | A ID da conta de armazenamento para salvar a sessão de captura de pacotes. Obrigatório se nenhum caminho de arquivo local for fornecido. | string |
storagePath | O URI do caminho de armazenamento para salvar a captura de pacotes. Deve ser um URI bem formado que descreva o local para salvar a captura de pacotes. | string |
Definição de recurso de modelo do ARM
O tipo de recurso networkWatchers/packetCaptures pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Network/networkWatchers/packetCaptures, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.Network/networkWatchers/packetCaptures",
"apiVersion": "2023-05-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"
}
}
Valores de propriedade
networkWatchers/packetCaptures
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de recurso | 'Microsoft.Network/networkWatchers/packetCaptures' |
apiVersion | A versão da API do recurso | '2023-05-01' |
name | O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON. |
cadeia de caracteres (obrigatório) |
properties | Propriedades da captura de pacotes. | PacketCaptureParametersOrPacketCaptureResultProperti... (obrigatório) |
PacketCaptureParametersOrPacketCaptureResultProperti...
Nome | Descrição | Valor |
---|---|---|
bytesToCapturePerPacket | Número de bytes capturados por pacote, os bytes restantes são truncados. | INT Restrições: Valor mínimo = 0 Valor máximo = 4294967295 |
filtros | Uma lista de filtros de captura de pacotes. | PacketCaptureFilter[] |
scope | Uma lista de instâncias do AzureVMSS que podem ser incluídas ou excluídas para executar a captura de pacotes. Se incluídos e excluídos estiverem vazios, a captura de pacotes será executada em todas as instâncias do AzureVMSS. | PacketCaptureMachineScope |
Storagelocation | O local de armazenamento de uma sessão de captura de pacotes. | PacketCaptureStorageLocation (obrigatório) |
destino | Atualmente, há suporte para a ID do recurso de destino, apenas AzureVM e AzureVMSS como tipo de destino. | cadeia de caracteres (obrigatório) |
targetType | Tipo de destino do recurso fornecido. | 'AzureVM' 'AzureVMSS' |
timeLimitInSeconds | Duração máxima da sessão de captura em segundos. | INT Restrições: Valor mínimo = 0 Valor máximo = 18000 |
totalBytesPerSession | Tamanho máximo da saída de captura. | INT Restrições: Valor mínimo = 0 Valor máximo = 4294967295 |
PacketCaptureFilter
Nome | Descrição | Valor |
---|---|---|
localIPAddress | Endereço IP local para filtrar. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para intervalo. "127.0.0.1; 127.0.0.5"? para várias entradas. No momento, não há suporte para vários intervalos. No momento, não há suporte para a combinação de intervalos com várias entradas. Padrão = nulo. | string |
localPort | Porta local a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para intervalo. "80; 443;" para várias entradas. No momento, não há suporte para vários intervalos. No momento, não há suporte para a combinação de intervalos com várias entradas. Padrão = nulo. | string |
protocolo | Protocolo a ser filtrado. | 'Any' 'TCP' 'UDP' |
remoteIPAddress | Endereço IP local para filtrar. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para intervalo. "127.0.0.1; 127.0.0.5;" para várias entradas. No momento, não há suporte para vários intervalos. No momento, não há suporte para a combinação de intervalos com várias entradas. Padrão = nulo. | string |
Remoteport | Porta remota a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para intervalo. "80; 443;" para várias entradas. No momento, não há suporte para vários intervalos. No momento, não há suporte para a combinação de intervalos com várias entradas. Padrão = nulo. | string |
PacketCaptureMachineScope
Nome | Descrição | Valor |
---|---|---|
excluir | Lista de instâncias do AzureVMSS que precisam ser excluídas do AzureVMSS da execução da captura de pacotes. | string[] |
include | Lista de instâncias do AzureVMSS em que executar a captura de pacotes. | string[] |
PacketCaptureStorageLocation
Nome | Descrição | Valor |
---|---|---|
filePath | Um caminho local válido na VM de destino. Deve incluir o nome do arquivo de captura (*.cap). Para a máquina virtual linux, ela deve começar com /var/captures. Obrigatório se nenhuma ID de armazenamento for fornecida, caso contrário, opcional. | string |
storageId | A ID da conta de armazenamento para salvar a sessão de captura de pacotes. Obrigatório se nenhum caminho de arquivo local for fornecido. | string |
storagePath | O URI do caminho de armazenamento para salvar a captura de pacotes. Deve ser um URI bem formado que descreva o local para salvar a captura de pacotes. | string |
Definição de recurso do Terraform (provedor AzAPI)
O tipo de recurso networkWatchers/packetCaptures pode ser implantado com operações direcionadas:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Network/networkWatchers/packetCaptures, adicione o Terraform a seguir ao modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkWatchers/packetCaptures@2023-05-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
}
})
}
Valores de propriedade
networkWatchers/packetCaptures
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de recurso | "Microsoft.Network/networkWatchers/packetCaptures@2023-05-01" |
name | O nome do recurso | cadeia de caracteres (obrigatório) |
parent_id | A ID do recurso que é o pai desse recurso. | ID do recurso do tipo: networkWatchers |
properties | Propriedades da captura de pacotes. | PacketCaptureParametersOrPacketCaptureResultProperti... (obrigatório) |
PacketCaptureParametersOrPacketCaptureResultProperti...
Nome | Descrição | Valor |
---|---|---|
bytesToCapturePerPacket | Número de bytes capturados por pacote, os bytes restantes são truncados. | INT Restrições: Valor mínimo = 0 Valor máximo = 4294967295 |
filtros | Uma lista de filtros de captura de pacotes. | PacketCaptureFilter[] |
scope | Uma lista de instâncias do AzureVMSS que podem ser incluídas ou excluídas para executar a captura de pacotes. Se incluídos e excluídos estiverem vazios, a captura de pacotes será executada em todas as instâncias do AzureVMSS. | PacketCaptureMachineScope |
Storagelocation | O local de armazenamento de uma sessão de captura de pacotes. | PacketCaptureStorageLocation (obrigatório) |
destino | Atualmente, há suporte para a ID do recurso de destino, apenas AzureVM e AzureVMSS como tipo de destino. | cadeia de caracteres (obrigatório) |
targetType | Tipo de destino do recurso fornecido. | "AzureVM" "AzureVMSS" |
timeLimitInSeconds | Duração máxima da sessão de captura em segundos. | INT Restrições: Valor mínimo = 0 Valor máximo = 18000 |
totalBytesPerSession | Tamanho máximo da saída de captura. | INT Restrições: Valor mínimo = 0 Valor máximo = 4294967295 |
PacketCaptureFilter
Nome | Descrição | Valor |
---|---|---|
localIPAddress | Endereço IP local a ser filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para intervalo. "127.0.0.1; 127.0.0.5"? para várias entradas. No momento, não há suporte para vários intervalos. No momento, não há suporte para a combinação de intervalos com várias entradas. Padrão = nulo. | string |
localPort | Porta local a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para intervalo. "80; 443;" para várias entradas. No momento, não há suporte para vários intervalos. No momento, não há suporte para a combinação de intervalos com várias entradas. Padrão = nulo. | string |
protocolo | Protocolo a ser filtrado. | "Qualquer" "TCP" "UDP" |
remoteIPAddress | Endereço IP local a ser filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para intervalo. "127.0.0.1; 127.0.0.5;" para várias entradas. No momento, não há suporte para vários intervalos. No momento, não há suporte para a combinação de intervalos com várias entradas. Padrão = nulo. | string |
Remoteport | Porta remota a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para intervalo. "80; 443;" para várias entradas. No momento, não há suporte para vários intervalos. No momento, não há suporte para a combinação de intervalos com várias entradas. Padrão = nulo. | string |
PacketCaptureMachineScope
Nome | Descrição | Valor |
---|---|---|
excluir | Lista de instâncias do AzureVMSS que precisam ser excluídas do AzureVMSS da execução da captura de pacotes. | string[] |
include | Lista de instâncias do AzureVMSS na qual executar a captura de pacotes. | string[] |
PacketCaptureStorageLocation
Nome | Descrição | Valor |
---|---|---|
filePath | Um caminho local válido na VM de destino. Deve incluir o nome do arquivo de captura (*.cap). Para a máquina virtual linux, ela deve começar com /var/captures. Obrigatório se nenhuma ID de armazenamento for fornecida, caso contrário, opcional. | string |
storageId | A ID da conta de armazenamento para salvar a sessão de captura de pacotes. Obrigatório se nenhum caminho de arquivo local for fornecido. | string |
storagePath | O URI do caminho de armazenamento para salvar a captura de pacotes. Deve ser um URI bem formado que descreva o local para salvar a captura de pacotes. | string |