Microsoft.Network networkWatchers/packetCaptures 2022-01-01
Definição de recurso do Bicep
O tipo de recurso networkWatchers/packetCaptures pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Network/networkWatchers/packetCaptures, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.Network/networkWatchers/packetCaptures@2022-01-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 subordinados no Bicep. |
cadeia (obrigatório) |
principal | No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal. Para obter mais informações, veja Recurso subordinado fora do recurso principal. |
Nome simbólico para recurso do tipo: networkWatchers |
propriedades | 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 ambos incluídos e excluídos estiverem vazios, a captura de pacotes será executada em todas as instâncias do AzureVMSS. | PacketCaptureMachineScope |
storageLocation | A localização de armazenamento para uma sessão de captura de pacotes. | PacketCaptureStorageLocation (obrigatório) |
destino | O ID do recurso de destino, apenas AzureVM e AzureVMSS como tipo de destino são atualmente suportados. | cadeia (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 filtrar. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para o intervalo. "127.0.0.1; 127.0.0.5"? para múltiplas entradas. Vários intervalos não suportados atualmente. Misturar intervalos com múltiplas entradas não suportadas atualmente. Predefinição = nulo. | string |
localPort | Porta local a filtrar. Notação: "80" para entrada de porta única." 80-85" para o intervalo. "80; 443;" para múltiplas entradas. Vários intervalos não suportados atualmente. Misturar intervalos com múltiplas entradas não suportadas atualmente. Predefinição = nulo. | string |
protocolo | Protocolo a filtrar. | "Qualquer" 'TCP' "UDP" |
remoteIPAddress | Endereço IP local a filtrar. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para o intervalo. "127.0.0.1; 127.0.0.5;" para múltiplas entradas. Vários intervalos não suportados atualmente. Misturar intervalos com múltiplas entradas não suportadas atualmente. Predefinição = nulo. | string |
remotePort | Porta remota a filtrar. Notação: "80" para entrada de porta única." 80-85" para o intervalo. "80; 443;" para múltiplas entradas. Vários intervalos não suportados atualmente. Misturar intervalos com múltiplas entradas não suportadas atualmente. Predefinição = nulo. | string |
PacketCaptureMachineScope
Nome | Descrição | Valor |
---|---|---|
excluir | Lista de instâncias do AzureVMSS que têm de ser excluídas do AzureVMSS da execução da captura de pacotes. | cadeia[] |
incluir | Lista de instâncias do AzureVMSS para executar a captura de pacotes. | cadeia[] |
PacketCaptureStorageLocation
Nome | Descrição | Valor |
---|---|---|
filePath | Um caminho local válido na VM de destino. Tem de incluir o nome do ficheiro de captura (*.cap). Para a máquina virtual do linux, tem de começar com /var/captures. Necessário se não for fornecido nenhum ID de armazenamento, caso contrário, opcional. | string |
storageId | O ID da conta de armazenamento para guardar a sessão de captura de pacotes. Necessário se não for fornecido nenhum caminho de ficheiro local. | string |
storagePath | O URI do caminho de armazenamento para guardar a captura de pacotes. Tem de ser um URI bem formado que descreva a localização para guardar a captura de pacotes. | string |
Definição de recurso de modelo do ARM
O tipo de recurso networkWatchers/packetCaptures pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Network/networkWatchers/packetCaptures, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.Network/networkWatchers/packetCaptures",
"apiVersion": "2022-01-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 de recursos | '2022-01-01' |
name | O nome do recurso Veja como definir nomes e tipos para recursos subordinados em modelos do ARM JSON. |
cadeia (obrigatório) |
propriedades | 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 ambos incluídos e excluídos estiverem vazios, a captura de pacotes será executada em todas as instâncias do AzureVMSS. | PacketCaptureMachineScope |
storageLocation | A localização de armazenamento para uma sessão de captura de pacotes. | PacketCaptureStorageLocation (obrigatório) |
destino | O ID do recurso de destino, apenas AzureVM e AzureVMSS como tipo de destino são atualmente suportados. | cadeia (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 da captura. | int Restrições: Valor mínimo = 0 Valor máximo = 4294967295 |
PacketCaptureFilter
Nome | Descrição | Valor |
---|---|---|
localIPAddress | Endereço IP local a filtrar. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para o intervalo. "127.0.0.1; 127.0.0.5"? para múltiplas entradas. Múltiplos intervalos não suportados atualmente. Misturar intervalos com múltiplas entradas não suportadas atualmente. Predefinição = nulo. | string |
localPort | Porta local a filtrar. Notação: "80" para entrada de porta única." 80-85" para o intervalo. "80; 443;" para múltiplas entradas. Múltiplos intervalos não suportados atualmente. Misturar intervalos com múltiplas entradas não suportadas atualmente. Predefinição = nulo. | string |
protocolo | Protocolo a filtrar. | "Qualquer" "TCP" "UDP" |
remoteIPAddress | Endereço IP local a filtrar. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para o intervalo. "127.0.0.1; 127.0.0.5;" para múltiplas entradas. Múltiplos intervalos não suportados atualmente. Misturar intervalos com múltiplas entradas não suportadas atualmente. Predefinição = nulo. | string |
remotePort | Porta remota a filtrar. Notação: "80" para entrada de porta única." 80-85" para o intervalo. "80; 443;" para múltiplas entradas. Múltiplos intervalos não suportados atualmente. Misturar intervalos com múltiplas entradas não suportadas atualmente. Predefinição = nulo. | string |
PacketCaptureMachineScope
Nome | Descrição | Valor |
---|---|---|
excluir | Lista de instâncias do AzureVMSS que têm de ser excluídas do AzureVMSS da execução da captura de pacotes. | string[] |
incluir | Lista de instâncias do AzureVMSS para executar a captura de pacotes. | string[] |
PacketCaptureStorageLocation
Nome | Descrição | Valor |
---|---|---|
filePath | Um caminho local válido na VM de destino. Tem de incluir o nome do ficheiro de captura (*.cap). Para a máquina virtual do Linux, tem de começar com /var/captures. Necessário se não for fornecido nenhum ID de armazenamento, caso contrário, opcional. | string |
storageId | O ID da conta de armazenamento para guardar a sessão de captura de pacotes. Necessário se não for fornecido nenhum caminho de ficheiro local. | string |
storagePath | O URI do caminho de armazenamento para guardar a captura de pacotes. Tem de ser um URI bem formado que descreva a localização para guardar a captura de pacotes. | string |
Definição de recurso terraform (fornecedor AzAPI)
O tipo de recurso networkWatchers/packetCaptures pode ser implementado com operações que visam:
- Grupos de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Network/networkWatchers/packetCaptures, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkWatchers/packetCaptures@2022-01-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@2022-01-01" |
name | O nome do recurso | cadeia (obrigatório) |
parent_id | O ID do recurso que é o principal para este recurso. | ID do recurso do tipo: networkWatchers |
propriedades | 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 ambos incluídos e excluídos estiverem vazios, a captura de pacotes será executada em todas as instâncias do AzureVMSS. | PacketCaptureMachineScope |
storageLocation | A localização de armazenamento para uma sessão de captura de pacotes. | PacketCaptureStorageLocation (obrigatório) |
destino | O ID do recurso de destino, apenas AzureVM e AzureVMSS como tipo de destino são atualmente suportados. | cadeia (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 da captura. | int Restrições: Valor mínimo = 0 Valor máximo = 4294967295 |
PacketCaptureFilter
Nome | Descrição | Valor |
---|---|---|
localIPAddress | Endereço IP local a filtrar. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para o intervalo. "127.0.0.1; 127.0.0.5"? para múltiplas entradas. Múltiplos intervalos não suportados atualmente. Misturar intervalos com múltiplas entradas não suportadas atualmente. Predefinição = nulo. | string |
localPort | Porta local a filtrar. Notação: "80" para entrada de porta única." 80-85" para o intervalo. "80; 443;" para múltiplas entradas. Múltiplos intervalos não suportados atualmente. Misturar intervalos com múltiplas entradas não suportadas atualmente. Predefinição = nulo. | string |
protocolo | Protocolo a filtrar. | "Qualquer" "TCP" "UDP" |
remoteIPAddress | Endereço IP local a filtrar. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para o intervalo. "127.0.0.1; 127.0.0.5;" para múltiplas entradas. Múltiplos intervalos não suportados atualmente. Misturar intervalos com múltiplas entradas não suportadas atualmente. Predefinição = nulo. | string |
remotePort | Porta remota a filtrar. Notação: "80" para entrada de porta única." 80-85" para o intervalo. "80; 443;" para múltiplas entradas. Múltiplos intervalos não suportados atualmente. Misturar intervalos com múltiplas entradas não suportadas atualmente. Predefinição = nulo. | string |
PacketCaptureMachineScope
Nome | Descrição | Valor |
---|---|---|
excluir | Lista de instâncias do AzureVMSS que têm de ser excluídas do AzureVMSS da execução da captura de pacotes. | cadeia[] |
incluir | Lista de instâncias do AzureVMSS para executar a captura de pacotes. | cadeia[] |
PacketCaptureStorageLocation
Nome | Descrição | Valor |
---|---|---|
filePath | Um caminho local válido na VM de destino. Tem de incluir o nome do ficheiro de captura (*.cap). Para a máquina virtual do linux, tem de começar com /var/captures. Necessário se não for fornecido nenhum ID de armazenamento, caso contrário, opcional. | string |
storageId | O ID da conta de armazenamento para guardar a sessão de captura de pacotes. Necessário se não for fornecido nenhum caminho de ficheiro local. | string |
storagePath | O URI do caminho de armazenamento para guardar a captura de pacotes. Tem de ser um URI bem formado que descreva a localização para guardar a captura de pacotes. | string |