Connection Monitors - Query

Referenz

Service:: Network Watcher

API Version:: 2023-05-01

Fragen Sie einen Momentaufnahme der neuesten Verbindungszustände ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
connectionMonitorName	path	True	string	Der Name, der dem Verbindungsmonitor zugewiesen wird.
networkWatcherName	path	True	string	Der Name der Network Watcher Ressource.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die Network Watcher enthält.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ConnectionMonitorQueryResult	Erfolgreiche Abfrage der Verbindungszustände.
202 Accepted	ConnectionMonitorQueryResult	Akzeptierte Abfrage von Verbindungszuständen.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Annehmen der Identität Ihres Benutzerkontos

Beispiele

Query connection monitor

Sample Request

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

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/2023-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

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/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/80c21c17b4a7aa57f637ee594f7cfd653255a7e0/specification/network/resource-manager/Microsoft.Network/stable/2023-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.5265438Z"); 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.3387305Z"); 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

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/2023-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

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-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

Sample Response

Status code:: 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": []
        }
      ]
    }
  ]
}

Status code:: 202

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

Response Body

{
  "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": []
        }
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
ConnectionMonitorQueryResult	Liste der Verbindungsstatusmomentaufnahmen.
ConnectionMonitorSourceStatus	Status der Verbindungsüberwachungsquelle.
ConnectionState	Der Verbindungsstatus.
ConnectionStateSnapshot	Verbindungsstatus Momentaufnahme.
ConnectivityHop	Informationen zu einem Hop zwischen der Quelle und dem Ziel.
ConnectivityIssue	Informationen zu einem Problem, das bei der Überprüfung der Konnektivität aufgetreten ist.
ErrorDetails	Allgemeine Darstellung von Fehlerdetails.
ErrorResponse	Das Fehlerobjekt.
EvaluationState	Auswertungsstatus der Konnektivitätsanalyse.
HopLink	Hoplink.
IssueType	Der Typ des Problems.
Origin	Der Ursprung des Problems.
Severity	Der Schweregrad des Problems.

ConnectionMonitorQueryResult

Liste der Verbindungsstatusmomentaufnahmen.

Name	Typ	Beschreibung
sourceStatus	ConnectionMonitorSourceStatus	Status der Verbindungsüberwachungsquelle.
states	ConnectionStateSnapshot[]	Informationen zu Verbindungszuständen.

ConnectionMonitorSourceStatus

Status der Verbindungsüberwachungsquelle.

Name	Typ	Beschreibung
Active	string
Inactive	string
Unknown	string

ConnectionState

Der Verbindungsstatus.

Name	Typ	Beschreibung
Reachable	string
Unknown	string
Unreachable	string

ConnectionStateSnapshot

Verbindungsstatus Momentaufnahme.

Name	Typ	Beschreibung
avgLatencyInMs	integer	Durchschnittliche Latenz in ms.
connectionState	ConnectionState	Der Verbindungsstatus.
endTime	string	Die Endzeit der Verbindung Momentaufnahme.
evaluationState	EvaluationState	Auswertungsstatus der Konnektivitätsanalyse.
hops	ConnectivityHop[]	Liste der Hops zwischen der Quelle und dem Ziel.
maxLatencyInMs	integer	Maximale Latenz in ms.
minLatencyInMs	integer	Minimale Latenz in ms.
probesFailed	integer	Die Anzahl der fehlgeschlagenen Tests.
probesSent	integer	Die Anzahl der gesendeten Tests.
startTime	string	Die Startzeit der Verbindung Momentaufnahme.

ConnectivityHop

Informationen zu einem Hop zwischen der Quelle und dem Ziel.

Name	Typ	Beschreibung
address	string	Die IP-Adresse des Hops.
id	string	Die ID des Hops.
issues	ConnectivityIssue[]	Liste der Probleme.
links	HopLink[]	Liste der Hoplinks.
nextHopIds	string[]	Liste der Bezeichner des nächsten Hops.
previousHopIds	string[]	Liste der vorherigen Hopbezeichner.
previousLinks	HopLink[]	Liste der vorherigen Hoplinks.
resourceId	string	Die ID der Ressource, die diesem Hop entspricht.
type	string	Der Typ des Hops.

ConnectivityIssue

Informationen zu einem Problem, das bei der Überprüfung der Konnektivität aufgetreten ist.

Name	Typ	Beschreibung
context	object[]	Stellt zusätzlichen Kontext für das Problem bereit.
origin	Origin	Der Ursprung des Problems.
severity	Severity	Der Schweregrad des Problems.
type	IssueType	Der Typ des Problems.

ErrorDetails

Allgemeine Darstellung von Fehlerdetails.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung.
target	string	Fehlerziel.

ErrorResponse

Das Fehlerobjekt.

Name	Typ	Beschreibung
error	ErrorDetails	Fehler Das Fehlerdetailsobjekt.

EvaluationState

Auswertungsstatus der Konnektivitätsanalyse.

Name	Typ	Beschreibung
Completed	string
InProgress	string
NotStarted	string

HopLink

Hoplink.

Name	Typ	Beschreibung
context	object	Stellt zusätzlichen Kontext für Links bereit.
issues	ConnectivityIssue[]	Liste der Probleme.
linkType	string	Linktyp.
nextHopId	string	Die ID des nächsten Hops.
properties.roundTripTimeAvg	integer	Durchschnittliche Roundtripzeit in Millisekunden.
properties.roundTripTimeMax	integer	Maximale Roundtripzeit in Millisekunden.
properties.roundTripTimeMin	integer	Minimale Roundtripzeit in Millisekunden.
resourceId	string	Ressourcen-ID

IssueType

Der Typ des Problems.

Name	Typ	Beschreibung
AgentStopped	string
DnsResolution	string
GuestFirewall	string
NetworkSecurityRule	string
Platform	string
PortThrottled	string
SocketBind	string
Unknown	string
UserDefinedRoute	string

Origin

Der Ursprung des Problems.

Name	Typ	Beschreibung
Inbound	string
Local	string
Outbound	string

Severity

Der Schweregrad des Problems.

Name	Typ	Beschreibung
Error	string
Warning	string

Connection Monitors - Query

URI-Parameter

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

Query connection monitor

Sample Request

Sample Response

Definitionen

ConnectionMonitorQueryResult

ConnectionMonitorSourceStatus

ConnectionState

ConnectionStateSnapshot

ConnectivityHop

ConnectivityIssue

ErrorDetails

ErrorResponse

EvaluationState

HopLink

IssueType

Origin

Severity

Zusätzliche Ressourcen