Network Watchers - Get Flow Log Status

Referência

Serviço:: Network Watcher

Versão da API:: 2024-05-01

Consulta o status do log de fluxo e da análise de tráfego (opcional) em um recurso especificado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
networkWatcherName	path	True	string	O nome do recurso do inspetor de rede.
resourceGroupName	path	True	string	O nome do grupo de recursos do inspetor de rede.
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
targetResourceId	True	string	O recurso de destino onde obter o log de fluxo e o status de análise de tráfego (opcional).

Respostas

Name	Tipo	Description
200 OK	FlowLogInformation	Solicitação bem-sucedida de log de fluxo de consulta e status de análise de tráfego (opcional).
202 Accepted	FlowLogInformation	Aceito e a operação será concluída de forma assíncrona.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

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

Resposta da amostra

Código de estado:: 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"
      }
    }
  }
}

Código de estado:: 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"
      }
    }
  }
}

Definições

Name	Description
ErrorDetails	Representação de detalhes de erro comum.
ErrorResponse	O objeto de erro.
FlowLogFormatParameters	Parâmetros que definem o formato do log de fluxo.
FlowLogFormatType	O tipo de arquivo do log de fluxo.
FlowLogInformation	Informações sobre a configuração do flow log e análise de tráfego (opcional) .
FlowLogStatusParameters	Parâmetros que definem um recurso para consultar o log de fluxo e o status da análise de tráfego (opcional).
ManagedServiceIdentity	Identidade do recurso.
ResourceIdentityType	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades da máquina virtual.
RetentionPolicyParameters	Parâmetros que definem a política de retenção para o log de fluxo.
TrafficAnalyticsConfigurationProperties	Parâmetros que definem a configuração da análise de tráfego.
TrafficAnalyticsProperties	Parâmetros que definem a configuração da análise de tráfego.
UserAssignedIdentities	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ErrorDetails

Representação de detalhes de erro comum.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro.
target	string	Alvo de erro.

ErrorResponse

O objeto de erro.

Name	Tipo	Description
error	ErrorDetails	Erro O objeto error details.

FlowLogFormatParameters

Parâmetros que definem o formato do log de fluxo.

Name	Tipo	Default value	Description
type	FlowLogFormatType		O tipo de arquivo do log de fluxo.
version	integer	0	A versão (revisão) do log de fluxo.

FlowLogFormatType

O tipo de arquivo do log de fluxo.

Name	Tipo	Description
JSON	string

FlowLogInformation

Informações sobre a configuração do flow log e análise de tráfego (opcional) .

Name	Tipo	Description
flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parâmetros que definem a configuração da análise de tráfego.
identity	ManagedServiceIdentity	Identidade gerenciada do recurso FlowLog
properties.enabled	boolean	Sinalizar para ativar/desativar o registro de fluxo.
properties.enabledFilteringCriteria	string	Campo opcional para filtrar logs de tráfego de rede com base em SrcIP, SrcPort, DstIP, DstPort, Protocolo, Criptografia, Direção e Ação. Se não for especificado, todo o tráfego de rede será registado.
properties.format	FlowLogFormatParameters	Parâmetros que definem o formato do log de fluxo.
properties.retentionPolicy	RetentionPolicyParameters	Parâmetros que definem a política de retenção para o log de fluxo.
properties.storageId	string	ID da conta de armazenamento que é usada para armazenar o log de fluxo.
targetResourceId	string	A ID do recurso a ser configurado para log de fluxo e análise de tráfego (opcional) .

FlowLogStatusParameters

Parâmetros que definem um recurso para consultar o log de fluxo e o status da análise de tráfego (opcional).

Name	Tipo	Description
targetResourceId	string	O recurso de destino onde obter o log de fluxo e o status de análise de tráfego (opcional).

ManagedServiceIdentity

Identidade do recurso.

Name	Tipo	Description
principalId	string	O id principal da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
tenantId	string	A ID do locatário da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
type	ResourceIdentityType	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades da máquina virtual.
userAssignedIdentities	UserAssignedIdentities	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ResourceIdentityType

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades da máquina virtual.

Name	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RetentionPolicyParameters

Parâmetros que definem a política de retenção para o log de fluxo.

Name	Tipo	Default value	Description
days	integer	0	Número de dias para reter registros de registro de fluxo.
enabled	boolean	False	Sinalizar para ativar/desativar a retenção.

TrafficAnalyticsConfigurationProperties

Parâmetros que definem a configuração da análise de tráfego.

Name	Tipo	Description
enabled	boolean	Sinalizar para ativar/desativar a análise de tráfego.
trafficAnalyticsInterval	integer	O intervalo em minutos que decidiria com que frequência o serviço de TA deveria fazer análises de fluxo.
workspaceId	string	O guid de recurso do espaço de trabalho anexado.
workspaceRegion	string	O local do espaço de trabalho anexado.
workspaceResourceId	string	ID do recurso do espaço de trabalho anexado.

TrafficAnalyticsProperties