Network Watchers - Get Flow Log Status

Referencia

Servicio:: Network Watcher

Versión de la API:: 2024-05-01

Consulta el estado del registro de flujo y el análisis de tráfico (opcional) en un recurso especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
networkWatcherName	path	True	string	Nombre del recurso de Network Watcher.
resourceGroupName	path	True	string	Nombre del grupo de recursos de Network Watcher.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de la API de cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
targetResourceId	True	string	Recurso de destino en el que se obtiene el estado de análisis de tráfico y registro de flujo (opcional).

Respuestas

Nombre	Tipo	Description
200 OK	FlowLogInformation	Solicitud correcta del estado de análisis de tráfico y registro de flujo de consultas (opcional).
202 Accepted	FlowLogInformation	Aceptado y la operación se completará de forma asincrónica.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get flow log status

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryFlowLogStatus?api-version=2024-05-01

{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"
}

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherFlowLogStatusQuery.json
func ExampleWatchersClient_BeginGetFlowLogStatus() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWatchersClient().BeginGetFlowLogStatus(ctx, "rg1", "nw1", armnetwork.FlowLogStatusParameters{
		TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.FlowLogInformation = armnetwork.FlowLogInformation{
	// 	Identity: &armnetwork.ManagedServiceIdentity{
	// 		Type: to.Ptr(armnetwork.ResourceIdentityTypeUserAssigned),
	// 		UserAssignedIdentities: map[string]*armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 			"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 				ClientID: to.Ptr("c16d15e1-f60a-40e4-8a05-df3d3f655c14"),
	// 				PrincipalID: to.Ptr("e3858881-e40c-43bd-9cde-88da39c05023"),
	// 			},
	// 		},
	// 	},
	// 	Properties: &armnetwork.FlowLogProperties{
	// 		Enabled: to.Ptr(true),
	// 		StorageID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1"),
	// 	},
	// 	TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 200

{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
  "properties": {
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    "enabled": true
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14",
        "principalId": "e3858881-e40c-43bd-9cde-88da39c05023"
      }
    }
  }
}

status code:: 202

Location: https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryFlowLogStatus?api-version=2024-05-01

{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
  "properties": {
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    "enabled": true
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14",
        "principalId": "e3858881-e40c-43bd-9cde-88da39c05023"
      }
    }
  }
}

Definiciones

Nombre	Description
ErrorDetails	Representación de detalles de error comunes.
ErrorResponse	Objeto de error.
FlowLogFormatParameters	Parámetros que definen el formato del registro de flujo.
FlowLogFormatType	Tipo de archivo del registro de flujo.
FlowLogInformation	Información sobre la configuración del registro de flujo y el análisis de tráfico (opcional) .
FlowLogStatusParameters	Parámetros que definen un recurso para consultar el registro de flujo y el estado de análisis de tráfico (opcional).
ManagedServiceIdentity	Identidad del recurso.
ResourceIdentityType	Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades de la máquina virtual.
RetentionPolicyParameters	Parámetros que definen la directiva de retención para el registro de flujo.
TrafficAnalyticsConfigurationProperties	Parámetros que definen la configuración del análisis de tráfico.
TrafficAnalyticsProperties	Parámetros que definen la configuración del análisis de tráfico.
UserAssignedIdentities	Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ErrorDetails

Representación de detalles de error comunes.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error.
target	string	Destino de error.

ErrorResponse

Objeto de error.

Nombre	Tipo	Description
error	ErrorDetails	Error Objeto de detalles del error.

FlowLogFormatParameters

Parámetros que definen el formato del registro de flujo.

Nombre	Tipo	Valor predeterminado	Description
type	FlowLogFormatType		Tipo de archivo del registro de flujo.
version	integer	0	Versión (revisión) del registro de flujo.

FlowLogFormatType

Tipo de archivo del registro de flujo.

Nombre	Tipo	Description
JSON	string

FlowLogInformation

Información sobre la configuración del registro de flujo y el análisis de tráfico (opcional) .

Nombre	Tipo	Description
flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parámetros que definen la configuración del análisis de tráfico.
identity	ManagedServiceIdentity	Identidad administrada del recurso FlowLog
properties.enabled	boolean	Marca para habilitar o deshabilitar el registro de flujo.
properties.enabledFilteringCriteria	string	Campo opcional para filtrar los registros de tráfico de red en función de SrcIP, SrcPort, DstIP, DstPort, Protocolo, Cifrado, Dirección y Acción. Si no se especifica, se registrará todo el tráfico de red.
properties.format	FlowLogFormatParameters	Parámetros que definen el formato del registro de flujo.
properties.retentionPolicy	RetentionPolicyParameters	Parámetros que definen la directiva de retención para el registro de flujo.
properties.storageId	string	Identificador de la cuenta de almacenamiento que se usa para almacenar el registro de flujo.
targetResourceId	string	Identificador del recurso que se va a configurar para el registro de flujo y el análisis de tráfico (opcional).

FlowLogStatusParameters

Parámetros que definen un recurso para consultar el registro de flujo y el estado de análisis de tráfico (opcional).

Nombre	Tipo	Description
targetResourceId	string	Recurso de destino en el que se obtiene el estado de análisis de tráfico y registro de flujo (opcional).

ManagedServiceIdentity

Identidad del recurso.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string	Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	ResourceIdentityType	Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades de la máquina virtual.
userAssignedIdentities	UserAssignedIdentities	Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ResourceIdentityType

Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades de la máquina virtual.

Nombre	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RetentionPolicyParameters

Parámetros que definen la directiva de retención para el registro de flujo.

Nombre	Tipo	Valor predeterminado	Description
days	integer	0	Número de días para conservar los registros de flujo.
enabled	boolean	False	Marca para habilitar o deshabilitar la retención.

TrafficAnalyticsConfigurationProperties

Parámetros que definen la configuración del análisis de tráfico.

Nombre	Tipo	Description
enabled	boolean	Marca para habilitar o deshabilitar el análisis de tráfico.
trafficAnalyticsInterval	integer	Intervalo en minutos que decidiría la frecuencia con la que el servicio TA debería realizar análisis de flujo.
workspaceId	string	Guid de recurso del área de trabajo adjunta.
workspaceRegion	string	Ubicación del área de trabajo adjunta.
workspaceResourceId	string	Identificador de recurso del área de trabajo adjunta.

TrafficAnalyticsProperties