Connection Monitors - Query

Service:

Network Watcher

API-versie:

2024-05-01

Voer een query uit op een momentopname van de meest recente verbindingsstatussen.

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

URI-parameters

Name	In	Vereist	Type	Description
connectionMonitorName	path	True	string	De naam die is opgegeven voor de verbindingsmonitor.
networkWatcherName	path	True	string	De naam van de Network Watcher-resource.
resourceGroupName	path	True	string	De naam van de resourcegroep met Network Watcher.
subscriptionId	path	True	string	De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	ConnectionMonitorQueryResult	Geslaagde query met verbindingsstatussen.
202 Accepted	ConnectionMonitorQueryResult	Geaccepteerde query met verbindingsstatussen.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Query connection monitor

Voorbeeldaanvraag

HTTP

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

Java

/**
 * Samples for ConnectionMonitors Query.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * NetworkWatcherConnectionMonitorQuery.json
     */
    /**
     * Sample code: Query connection monitor.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void queryConnectionMonitor(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getConnectionMonitors().query("rg1", "nw1", "cm1",
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_watcher_connection_monitor_query.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.connection_monitors.begin_query(
        resource_group_name="rg1",
        network_watcher_name="nw1",
        connection_monitor_name="cm1",
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherConnectionMonitorQuery.json
if __name__ == "__main__":
    main()

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

Go

package armnetwork_test

import (
	"context"
	"log"

	"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/NetworkWatcherConnectionMonitorQuery.json
func ExampleConnectionMonitorsClient_BeginQuery() {
	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.NewConnectionMonitorsClient().BeginQuery(ctx, "rg1", "nw1", "cm1", 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.ConnectionMonitorQueryResult = armnetwork.ConnectionMonitorQueryResult{
	// 	SourceStatus: to.Ptr(armnetwork.ConnectionMonitorSourceStatusActive),
	// 	States: []*armnetwork.ConnectionStateSnapshot{
	// 		{
	// 			ConnectionState: to.Ptr(armnetwork.ConnectionStateReachable),
	// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-08T05:12:41.526Z"); return t}()),
	// 			EvaluationState: to.Ptr(armnetwork.EvaluationStateCompleted),
	// 			Hops: []*armnetwork.ConnectivityHop{
	// 				{
	// 					Type: to.Ptr("Source"),
	// 					Address: to.Ptr("10.1.1.4"),
	// 					ID: to.Ptr("7dbbe7aa-60ba-4650-831e-63d775d38e9e"),
	// 					Issues: []*armnetwork.ConnectivityIssue{
	// 					},
	// 					NextHopIDs: []*string{
	// 						to.Ptr("75c8d819-b208-4584-a311-1aa45ce753f9")},
	// 						ResourceID: to.Ptr("subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1"),
	// 					},
	// 					{
	// 						Type: to.Ptr("VirtualNetwork"),
	// 						Address: to.Ptr("192.168.100.4"),
	// 						ID: to.Ptr("75c8d819-b208-4584-a311-1aa45ce753f9"),
	// 						Issues: []*armnetwork.ConnectivityIssue{
	// 						},
	// 						NextHopIDs: []*string{
	// 						},
	// 						ResourceID: to.Ptr("subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1"),
	// 				}},
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-08T03:42:33.338Z"); return t}()),
	// 		}},
	// 	}
}

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

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Query a snapshot of the most recent connection states.
 *
 * @summary Query a snapshot of the most recent connection states.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherConnectionMonitorQuery.json
 */
async function queryConnectionMonitor() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkWatcherName = "nw1";
  const connectionMonitorName = "cm1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.connectionMonitors.beginQueryAndWait(
    resourceGroupName,
    networkWatcherName,
    connectionMonitorName,
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherConnectionMonitorQuery.json
// this example is just showing the usage of "ConnectionMonitors_Query" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ConnectionMonitorResource created on azure
// for more information of creating ConnectionMonitorResource, please refer to the document of ConnectionMonitorResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkWatcherName = "nw1";
string connectionMonitorName = "cm1";
ResourceIdentifier connectionMonitorResourceId = ConnectionMonitorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkWatcherName, connectionMonitorName);
ConnectionMonitorResource connectionMonitor = client.GetConnectionMonitorResource(connectionMonitorResourceId);

// invoke the operation
ArmOperation<ConnectionMonitorQueryResult> lro = await connectionMonitor.QueryAsync(WaitUntil.Completed);
ConnectionMonitorQueryResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

Voorbeeldrespons

Statuscode:

200

{
  "sourceStatus": "Active",
  "states": [
    {
      "connectionState": "Reachable",
      "startTime": "2018-01-08T03:42:33.3387305Z",
      "endTime": "2018-01-08T05:12:41.5265438Z",
      "evaluationState": "Completed",
      "hops": [
        {
          "type": "Source",
          "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e",
          "address": "10.1.1.4",
          "resourceId": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1",
          "nextHopIds": [
            "75c8d819-b208-4584-a311-1aa45ce753f9"
          ],
          "issues": []
        },
        {
          "type": "VirtualNetwork",
          "id": "75c8d819-b208-4584-a311-1aa45ce753f9",
          "address": "192.168.100.4",
          "resourceId": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1",
          "nextHopIds": [],
          "issues": []
        }
      ]
    }
  ]
}

Statuscode:

202

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

{
  "sourceStatus": "Active",
  "states": [
    {
      "connectionState": "Reachable",
      "startTime": "2018-01-08T03:42:33.3387305Z",
      "endTime": "2018-01-08T05:12:41.5265438Z",
      "evaluationState": "Completed",
      "hops": [
        {
          "type": "Source",
          "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e",
          "address": "10.1.1.4",
          "resourceId": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1",
          "nextHopIds": [
            "75c8d819-b208-4584-a311-1aa45ce753f9"
          ],
          "issues": []
        },
        {
          "type": "VirtualNetwork",
          "id": "75c8d819-b208-4584-a311-1aa45ce753f9",
          "address": "192.168.100.4",
          "resourceId": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1",
          "nextHopIds": [],
          "issues": []
        }
      ]
    }
  ]
}

Definities

Name	Description
ConnectionMonitorQueryResult	Lijst met momentopnamen van verbindingsstatussen.
ConnectionMonitorSourceStatus	Status van verbindingsmonitorbron.
ConnectionState	De verbindingsstatus.
ConnectionStateSnapshot	Momentopname van verbindingsstatus.
ConnectivityHop	Informatie over een hop tussen de bron en de bestemming.
ConnectivityIssue	Informatie over een probleem dat is opgetreden tijdens het controleren op connectiviteit.
ErrorDetails	Algemene weergave van foutdetails.
ErrorResponse	Het foutobject.
EvaluationState	Evaluatiestatus van connectiviteitsanalyse.
HopLink	Hopkoppeling.
IssueType	Het type probleem.
Origin	De oorsprong van het probleem.
Severity	De ernst van het probleem.

ConnectionMonitorQueryResult

Object

Lijst met momentopnamen van verbindingsstatussen.

Name	Type	Description
sourceStatus	ConnectionMonitorSourceStatus	Status van verbindingsmonitorbron.
states	ConnectionStateSnapshot[]	Informatie over verbindingsstatussen.

ConnectionMonitorSourceStatus

Inventarisatie

Status van verbindingsmonitorbron.

Waarde	Description
Active
Inactive
Unknown

ConnectionState

Inventarisatie

De verbindingsstatus.

Waarde	Description
Reachable
Unknown
Unreachable

ConnectionStateSnapshot

Object

Momentopname van verbindingsstatus.

Name	Type	Description
avgLatencyInMs	integer (int64) minimum: 0 maximum: 4294967295	Gemiddelde latentie in ms.
connectionState	ConnectionState	De verbindingsstatus.
endTime	string (date-time)	De eindtijd van de momentopname van de verbinding.
evaluationState	EvaluationState	Evaluatiestatus van connectiviteitsanalyse.
hops	ConnectivityHop[]	Lijst met hops tussen de bron en de bestemming.
maxLatencyInMs	integer (int64) minimum: 0 maximum: 4294967295	Maximale latentie in ms.
minLatencyInMs	integer (int64) minimum: 0 maximum: 4294967295	Minimale latentie in ms.
probesFailed	integer (int64) minimum: 0 maximum: 4294967295	Het aantal mislukte tests.
probesSent	integer (int64) minimum: 0 maximum: 4294967295	Het aantal verzonden tests.
startTime	string (date-time)	De begintijd van de momentopname van de verbinding.

ConnectivityHop

Object

Informatie over een hop tussen de bron en de bestemming.

Name	Type	Description
address	string	Het IP-adres van de hop.
id	string	De id van de hop.
issues	ConnectivityIssue[]	Lijst met problemen.
links	HopLink[]	Lijst met hopkoppelingen.
nextHopIds	string[]	Lijst met volgende hop-id's.
previousHopIds	string[]	Lijst met vorige hop-id's.
previousLinks	HopLink[]	Lijst met eerdere hopkoppelingen.
resourceId	string	De id van de resource die overeenkomt met deze hop.
type	string	Het type hop.

ConnectivityIssue

Object

Informatie over een probleem dat is opgetreden tijdens het controleren op connectiviteit.

Name	Type	Description
context	object[]	Biedt aanvullende context over het probleem.
origin	Origin	De oorsprong van het probleem.
severity	Severity	De ernst van het probleem.
type	IssueType	Het type probleem.

ErrorDetails

Object

Algemene weergave van foutdetails.

Name	Type	Description
code	string	Foutcode.
message	string	Foutmelding.
target	string	Foutdoel.

ErrorResponse

Object

Het foutobject.

Name	Type	Description
error	ErrorDetails	Fout Het object met foutdetails.

EvaluationState

Inventarisatie

Evaluatiestatus van connectiviteitsanalyse.

Waarde	Description
Completed
InProgress
NotStarted

HopLink

Object

Hopkoppeling.

Name	Type	Description
context	object	Biedt aanvullende context voor koppelingen.
issues	ConnectivityIssue[]	Lijst met problemen.
linkType	string	Koppelingstype.
nextHopId	string	De id van de volgende hop.
properties.roundTripTimeAvg	integer (int64) minimum: 0 maximum: 4294967295	Gemiddelde retourtijd in milliseconden.
properties.roundTripTimeMax	integer (int64) minimum: 0 maximum: 4294967295	Maximale retourtijd in milliseconden.
properties.roundTripTimeMin	integer (int64) minimum: 0 maximum: 4294967295	Minimale retourtijd in milliseconden.
resourceId	string	Resource-id.

IssueType

Inventarisatie

Het type probleem.

Waarde	Description
AgentStopped
DnsResolution
GuestFirewall
NetworkSecurityRule
Platform
PortThrottled
SocketBind
Unknown
UserDefinedRoute

Origin

Inventarisatie

De oorsprong van het probleem.

Waarde	Description
Inbound
Local
Outbound

Severity

Inventarisatie

De ernst van het probleem.

Waarde	Description
Error
Warning