Network Watchers - Get Flow Log Status

Référence

Service:: Network Watcher

Version d'API:: 2024-05-01

Interroge l’état du journal de flux et de l’analytique du trafic (facultatif) sur une ressource spécifiée.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
networkWatcherName	path	True	string	Nom de la ressource network watcher.
resourceGroupName	path	True	string	Nom du groupe de ressources network watcher.
subscriptionId	path	True	string	Informations d’identification de l’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Obligatoire	Type	Description
targetResourceId	True	string	Ressource cible où le journal de flux et l’état Traffic Analytics (facultatif) sont obtenu.

Réponses

Nom	Type	Description
200 OK	FlowLogInformation	Demande réussie pour le journal des flux de requête et l’état Traffic Analytics (facultatif).
202 Accepted	FlowLogInformation	Accepté et l’opération se termine de façon asynchrone.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de réponse

Code d’état:: 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"
      }
    }
  }
}

Code d’état:: 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"
      }
    }
  }
}

Définitions

Nom	Description
ErrorDetails	Représentation des détails d’erreur courants.
ErrorResponse	Objet d’erreur.
FlowLogFormatParameters	Paramètres qui définissent le format du journal de flux.
FlowLogFormatType	Type de fichier du journal de flux.
FlowLogInformation	Informations sur la configuration du journal de flux et de l’analytique du trafic (facultatif) .
FlowLogStatusParameters	Paramètres qui définissent une ressource pour interroger le journal de flux et l’état Traffic Analytics (facultatif).
ManagedServiceIdentity	Identité de la ressource.
ResourceIdentityType	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités de la machine virtuelle.
RetentionPolicyParameters	Paramètres qui définissent la stratégie de rétention pour le journal de flux.
TrafficAnalyticsConfigurationProperties	Paramètres qui définissent la configuration de l’analytique du trafic.
TrafficAnalyticsProperties	Paramètres qui définissent la configuration de l’analytique du trafic.
UserAssignedIdentities	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

ErrorDetails

Représentation des détails d’erreur courants.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d'erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet d’erreur.

Nom	Type	Description
error	ErrorDetails	Erreur Objet détails de l’erreur.

FlowLogFormatParameters

Paramètres qui définissent le format du journal de flux.

Nom	Type	Valeur par défaut	Description
type	FlowLogFormatType		Type de fichier du journal de flux.
version	integer	0	Version (révision) du journal des flux.

FlowLogFormatType

Type de fichier du journal de flux.

Nom	Type	Description
JSON	string

FlowLogInformation

Informations sur la configuration du journal de flux et de l’analytique du trafic (facultatif) .

Nom	Type	Description
flowAnalyticsConfiguration	TrafficAnalyticsProperties	Paramètres qui définissent la configuration de l’analytique du trafic.
identity	ManagedServiceIdentity	Identité managée des ressources FlowLog
properties.enabled	boolean	Indicateur pour activer/désactiver la journalisation des flux.
properties.enabledFilteringCriteria	string	Champ facultatif pour filtrer les journaux de trafic réseau en fonction de SrcIP, SrcPort, DstIP, DstPort, Protocole, Chiffrement, Direction et Action. S’il n’est pas spécifié, tout le trafic réseau est journalisé.
properties.format	FlowLogFormatParameters	Paramètres qui définissent le format du journal de flux.
properties.retentionPolicy	RetentionPolicyParameters	Paramètres qui définissent la stratégie de rétention pour le journal de flux.
properties.storageId	string	ID du compte de stockage utilisé pour stocker le journal de flux.
targetResourceId	string	ID de la ressource à configurer pour le journal de flux et l’analytique du trafic (facultatif).

FlowLogStatusParameters

Paramètres qui définissent une ressource pour interroger le journal de flux et l’état Traffic Analytics (facultatif).

Nom	Type	Description
targetResourceId	string	Ressource cible où le journal de flux et l’état Traffic Analytics (facultatif) sont obtenu.

ManagedServiceIdentity

Identité de la ressource.

Nom	Type	Description
principalId	string	ID principal de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
tenantId	string	ID de locataire de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
type	ResourceIdentityType	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités de la machine virtuelle.
userAssignedIdentities	UserAssignedIdentities	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

ResourceIdentityType

Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités de la machine virtuelle.

Nom	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RetentionPolicyParameters

Paramètres qui définissent la stratégie de rétention pour le journal de flux.

Nom	Type	Valeur par défaut	Description
days	integer	0	Nombre de jours pour conserver les enregistrements du journal de flux.
enabled	boolean	False	Indicateur pour activer/désactiver la rétention.

TrafficAnalyticsConfigurationProperties

Paramètres qui définissent la configuration de l’analytique du trafic.

Nom	Type	Description
enabled	boolean	Indicateur pour activer/désactiver l’analytique du trafic.
trafficAnalyticsInterval	integer	Intervalle en minutes qui déciderait de la fréquence à laquelle le service TA doit effectuer des analyses de flux.
workspaceId	string	Guid de ressource de l’espace de travail attaché.
workspaceRegion	string	Emplacement de l’espace de travail attaché.
workspaceResourceId	string	ID de ressource de l’espace de travail attaché.

TrafficAnalyticsProperties