Network Watchers - Get Network Configuration Diagnostic

Obtiene los datos de diagnóstico de configuración de red para ayudar a los clientes a comprender y depurar el comportamiento de la red. Proporciona información detallada sobre qué reglas de seguridad se aplicaron a un flujo de tráfico especificado y el resultado de evaluar estas reglas. Los clientes deben proporcionar detalles de un flujo como el origen, el destino, el protocolo, etc. La API devuelve si se permitió o denegó el tráfico, las reglas evaluadas para el flujo especificado y los resultados de la evaluación.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/networkConfigurationDiagnostic?api-version=2021-02-01

Parámetros de identificador URI

Name In Required Type Description
networkWatcherName
path True
  • string

Nombre del network watcher.

resourceGroupName
path True
  • string

Nombre del grupo de recursos.

subscriptionId
path True
  • string

Las credenciales de suscripción que identifican de forma única la Microsoft Azure suscripción. El identificador de suscripción forma parte del URI para cada llamada al servicio.

api-version
query True
  • string

Versión de API del cliente.

Cuerpo de la solicitud

Name Required Type Description
profiles True

Lista de perfiles de diagnóstico de configuración de red.

targetResourceId True
  • string

Identificador del recurso de destino para realizar el diagnóstico de configuración de red. Las opciones válidas son VM, NetworkInterface, VMSS/NetworkInterface y Application Gateway.

verbosityLevel

Nivel de detalle.

Respuestas

Name Type Description
200 OK

Solicitud correcta. La operación devuelve el resultado del diagnóstico de configuración de red.

202 Accepted

Aceptado y la operación se completará de forma asincrónica.

Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

Network configuration diagnostic

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/networkConfigurationDiagnostic?api-version=2021-02-01
{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1",
  "profiles": [
    {
      "direction": "Inbound",
      "protocol": "TCP",
      "source": "10.1.0.4",
      "destination": "12.11.12.14",
      "destinationPort": "12100"
    }
  ]
}

Sample Response

{
  "results": [
    {
      "profile": {
        "direction": "Inbound",
        "protocol": "TCP",
        "source": "10.1.0.4",
        "destination": "12.11.12.14",
        "destinationPort": "12100"
      },
      "networkSecurityGroupResult": {
        "securityRuleAccessResult": "Allow",
        "evaluatedNetworkSecurityGroups": [
          {
            "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1",
            "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet",
            "matchedRule": {
              "ruleName": "UserRule_fe_rule",
              "action": "Allow"
            },
            "rulesEvaluationResult": [
              {
                "name": "UserRule_Cleanuptool-Allow-100",
                "protocolMatched": true,
                "sourceMatched": false,
                "sourcePortMatched": true,
                "destinationMatched": true,
                "destinationPortMatched": false
              },
              {
                "name": "UserRule_Cleanuptool-Allow-101",
                "protocolMatched": true,
                "sourceMatched": true,
                "sourcePortMatched": true,
                "destinationMatched": true,
                "destinationPortMatched": false
              },
              {
                "name": "UserRule_Cleanuptool-Allow-102",
                "protocolMatched": true,
                "sourceMatched": false,
                "sourcePortMatched": true,
                "destinationMatched": true,
                "destinationPortMatched": false
              },
              {
                "name": "UserRule_Cleanuptool-Deny-103",
                "protocolMatched": true,
                "sourceMatched": true,
                "sourcePortMatched": true,
                "destinationMatched": true,
                "destinationPortMatched": false
              },
              {
                "name": "UserRule_fe_rule",
                "protocolMatched": true,
                "sourceMatched": true,
                "sourcePortMatched": true,
                "destinationMatched": true,
                "destinationPortMatched": true
              }
            ]
          },
          {
            "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG",
            "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic",
            "matchedRule": {
              "ruleName": "UserRule_fe_rule",
              "action": "Allow"
            },
            "rulesEvaluationResult": [
              {
                "name": "UserRule_fe_rule",
                "protocolMatched": true,
                "sourceMatched": true,
                "sourcePortMatched": true,
                "destinationMatched": true,
                "destinationPortMatched": true
              }
            ]
          }
        ]
      }
    }
  ]
}
{
  "results": [
    {
      "profile": {
        "direction": "Inbound",
        "protocol": "TCP",
        "source": "10.1.0.4",
        "destination": "12.11.12.14",
        "destinationPort": "12100"
      },
      "networkSecurityGroupResult": {
        "securityRuleAccessResult": "Allow",
        "evaluatedNetworkSecurityGroups": [
          {
            "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1",
            "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet",
            "matchedRule": {
              "ruleName": "UserRule_fe_rule",
              "action": "Allow"
            },
            "rulesEvaluationResult": [
              {
                "name": "UserRule_Cleanuptool-Allow-100",
                "protocolMatched": true,
                "sourceMatched": false,
                "sourcePortMatched": true,
                "destinationMatched": true,
                "destinationPortMatched": false
              },
              {
                "name": "UserRule_Cleanuptool-Allow-101",
                "protocolMatched": true,
                "sourceMatched": true,
                "sourcePortMatched": true,
                "destinationMatched": true,
                "destinationPortMatched": false
              },
              {
                "name": "UserRule_Cleanuptool-Allow-102",
                "protocolMatched": true,
                "sourceMatched": false,
                "sourcePortMatched": true,
                "destinationMatched": true,
                "destinationPortMatched": false
              },
              {
                "name": "UserRule_Cleanuptool-Deny-103",
                "protocolMatched": true,
                "sourceMatched": true,
                "sourcePortMatched": true,
                "destinationMatched": true,
                "destinationPortMatched": false
              },
              {
                "name": "UserRule_fe_rule",
                "protocolMatched": true,
                "sourceMatched": true,
                "sourcePortMatched": true,
                "destinationMatched": true,
                "destinationPortMatched": true
              }
            ]
          },
          {
            "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG",
            "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic",
            "matchedRule": {
              "ruleName": "UserRule_fe_rule",
              "action": "Allow"
            },
            "rulesEvaluationResult": [
              {
                "name": "UserRule_fe_rule",
                "protocolMatched": true,
                "sourceMatched": true,
                "sourcePortMatched": true,
                "destinationMatched": true,
                "destinationPortMatched": true
              }
            ]
          }
        ]
      }
    }
  ]
}

Definiciones

Direction

La dirección del tráfico.

ErrorDetails

Representación de detalles de error comunes.

ErrorResponse

Objeto de error.

EvaluatedNetworkSecurityGroup

Resultados de la evaluación del grupo de seguridad de red.

MatchedRule

Regla coincidente.

NetworkConfigurationDiagnosticParameters

Parámetros para obtener el diagnóstico de configuración de red.

NetworkConfigurationDiagnosticProfile

Parámetros que se comparan con la configuración de red.

NetworkConfigurationDiagnosticResponse

Resultados del diagnóstico de configuración de red en el recurso de destino.

NetworkConfigurationDiagnosticResult

El resultado de diagnóstico de configuración de red correspondía a la consulta de tráfico proporcionada.

NetworkSecurityGroupResult

El resultado de diagnóstico de configuración de red correspondió a la consulta de tráfico proporcionada.

NetworkSecurityRulesEvaluationResult

Resultado de evaluación de reglas de seguridad de red.

SecurityRuleAccess

Si se permite o deniega el tráfico de red.

VerbosityLevel

Nivel de detalle.

Direction

La dirección del tráfico.

Name Type Description
Inbound
  • string
Outbound
  • string

ErrorDetails

Representación de detalles de error comunes.

Name Type Description
code
  • string

Código de error.

message
  • string

Mensaje de error.

target
  • string

Destino del error.

ErrorResponse

Objeto de error.

Name Type Description
error

Error
Objeto de detalles del error.

EvaluatedNetworkSecurityGroup

Resultados de la evaluación del grupo de seguridad de red.

Name Type Description
appliedTo
  • string

Identificador de recurso de nic o subred a la que se aplica el grupo de seguridad de red.

matchedRule

Regla de seguridad de red coincidente.

networkSecurityGroupId
  • string

Identificador del grupo de seguridad de red.

rulesEvaluationResult

Lista de resultados de evaluación de reglas de seguridad de red.

MatchedRule

Regla coincidente.

Name Type Description
action
  • string

El tráfico de red se permite o se deniega. Los valores posibles son "Allow" y "Deny".

ruleName
  • string

Nombre de la regla de seguridad de red coincidente.

NetworkConfigurationDiagnosticParameters

Parámetros para obtener el diagnóstico de configuración de red.

Name Type Description
profiles

Lista de perfiles de diagnóstico de configuración de red.

targetResourceId
  • string

Identificador del recurso de destino para realizar el diagnóstico de configuración de red. Las opciones válidas son VM, NetworkInterface, VMSS/NetworkInterface y Application Gateway.

verbosityLevel

Nivel de detalle.

NetworkConfigurationDiagnosticProfile

Parámetros que se comparan con la configuración de red.

Name Type Description
destination
  • string

Destino del tráfico. Los valores aceptados son: '*', dirección IP/CIDR, etiqueta de servicio.

destinationPort
  • string

Puerto de destino del tráfico. Los valores aceptados son "*" y un único puerto en el intervalo (0 - 65535).

direction

La dirección del tráfico.

protocol
  • string

Protocolo en el que se va a comprobar. Los valores aceptados son '*', TCP y UDP.

source
  • string

Origen del tráfico. Los valores aceptados son '*', dirección IP/CIDR, etiqueta de servicio.

NetworkConfigurationDiagnosticResponse

Resultados del diagnóstico de configuración de red en el recurso de destino.

Name Type Description
results

Lista de resultados de diagnóstico de configuración de red.

NetworkConfigurationDiagnosticResult

El resultado de diagnóstico de configuración de red correspondía a la consulta de tráfico proporcionada.

Name Type Description
networkSecurityGroupResult

Resultado del grupo de seguridad de red.

profile

Perfil de diagnóstico de configuración de red.

NetworkSecurityGroupResult

El resultado de diagnóstico de configuración de red correspondió a la consulta de tráfico proporcionada.

Name Type Description
evaluatedNetworkSecurityGroups

Lista de resultados de diagnóstico de grupos de seguridad de red.

securityRuleAccessResult

El tráfico de red se permite o se deniega.

NetworkSecurityRulesEvaluationResult

Resultado de evaluación de reglas de seguridad de red.

Name Type Description
destinationMatched
  • boolean

Valor que indica si el destino coincide.

destinationPortMatched
  • boolean

Valor que indica si se coincide con el puerto de destino.

name
  • string

Nombre de la regla de seguridad de red.

protocolMatched
  • boolean

Valor que indica si el protocolo coincide.

sourceMatched
  • boolean

Valor que indica si el origen coincide.

sourcePortMatched
  • boolean

Valor que indica si se coincide con el puerto de origen.

SecurityRuleAccess

Si se permite o deniega el tráfico de red.

Name Type Description
Allow
  • string
Deny
  • string

VerbosityLevel

Nivel de detalle.

Name Type Description
Full
  • string
Minimum
  • string
Normal
  • string