Connection Monitors - Query

Service:

Network Watcher

API Version:

2023-09-01

가장 최근 연결 상태의 스냅샷 쿼리합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
connectionMonitorName	path	True	string	연결 모니터에 지정된 이름입니다.
networkWatcherName	path	True	string	Network Watcher 리소스의 이름입니다.
resourceGroupName	path	True	string	Network Watcher 포함하는 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 API 버전입니다.

응답

Name	형식	Description
200 OK	ConnectionMonitorQueryResult	연결 상태 쿼리에 성공했습니다.
202 Accepted	ConnectionMonitorQueryResult	연결 상태의 허용된 쿼리입니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

Query connection monitor

Sample Request

HTTP

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

Java

/**
 * Samples for ConnectionMonitors Query.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-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/2023-09-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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-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/2023-09-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 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-09-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-09-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": []
        }
      ]
    }
  ]
}

정의

Name	Description
ConnectionMonitorQueryResult	연결 상태 스냅샷 목록입니다.
ConnectionMonitorSourceStatus	연결 모니터 원본의 상태입니다.
ConnectionState	연결 상태입니다.
ConnectionStateSnapshot	연결 상태 스냅샷.
ConnectivityHop	원본과 대상 간의 홉에 대한 정보입니다.
ConnectivityIssue	연결을 확인하는 과정에서 발생한 문제에 대한 정보입니다.
ErrorDetails	일반적인 오류 세부 정보 표현입니다.
ErrorResponse	Error 개체.
EvaluationState	연결 분석 평가 상태입니다.
HopLink	홉 링크.
IssueType	문제의 유형입니다.
Origin	문제의 원본입니다.
Severity	문제의 심각도입니다.

ConnectionMonitorQueryResult

연결 상태 스냅샷 목록입니다.

Name	형식	Description
sourceStatus	ConnectionMonitorSourceStatus	연결 모니터 원본의 상태입니다.
states	ConnectionStateSnapshot[]	연결 상태에 대한 정보입니다.

ConnectionMonitorSourceStatus

연결 모니터 원본의 상태입니다.

Name	형식	Description
Active	string
Inactive	string
Unknown	string

ConnectionState

연결 상태입니다.

Name	형식	Description
Reachable	string
Unknown	string
Unreachable	string

ConnectionStateSnapshot

연결 상태 스냅샷.

Name	형식	Description
avgLatencyInMs	integer	ms의 평균 대기 시간.
connectionState	ConnectionState	연결 상태입니다.
endTime	string	연결의 종료 시간이 스냅샷.
evaluationState	EvaluationState	연결 분석 평가 상태입니다.
hops	ConnectivityHop[]	원본과 대상 간의 홉 목록입니다.
maxLatencyInMs	integer	최대 대기 시간(ms)입니다.
minLatencyInMs	integer	최소 대기 시간(ms)입니다.
probesFailed	integer	실패한 프로브의 수입니다.
probesSent	integer	전송된 프로브의 수입니다.
startTime	string	연결 스냅샷 시작 시간입니다.

ConnectivityHop

원본과 대상 간의 홉에 대한 정보입니다.

Name	형식	Description
address	string	홉의 IP 주소입니다.
id	string	홉의 ID입니다.
issues	ConnectivityIssue[]	문제 목록입니다.
links	HopLink[]	홉 링크 목록입니다.
nextHopIds	string[]	다음 홉 식별자 목록입니다.
previousHopIds	string[]	이전 홉 식별자 목록입니다.
previousLinks	HopLink[]	이전 홉 링크 목록입니다.
resourceId	string	이 홉에 해당하는 리소스의 ID입니다.
type	string	홉의 형식입니다.

ConnectivityIssue

연결을 확인하는 과정에서 발생한 문제에 대한 정보입니다.

Name	형식	Description
context	object[]	문제에 대한 추가 컨텍스트를 제공합니다.
origin	Origin	문제의 원본입니다.
severity	Severity	문제의 심각도입니다.
type	IssueType	문제의 유형입니다.

ErrorDetails

일반적인 오류 세부 정보 표현입니다.

Name	형식	Description
code	string	오류 코드
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Error 개체.

Name	형식	Description
error	ErrorDetails	오류 오류 세부 정보 개체입니다.

EvaluationState

연결 분석 평가 상태입니다.

Name	형식	Description
Completed	string
InProgress	string
NotStarted	string

HopLink

홉 링크.

Name	형식	Description
context	object	링크에 대한 추가 컨텍스트를 제공합니다.
issues	ConnectivityIssue[]	문제 목록입니다.
linkType	string	링크 유형입니다.
nextHopId	string	다음 홉의 ID입니다.
properties.roundTripTimeAvg	integer	평균 왕복 시간(밀리초)입니다.
properties.roundTripTimeMax	integer	최대 왕복 시간(밀리초)입니다.
properties.roundTripTimeMin	integer	최소 왕복 시간(밀리초)입니다.
resourceId	string	리소스 ID입니다.

IssueType

문제의 유형입니다.

Name	형식	Description
AgentStopped	string
DnsResolution	string
GuestFirewall	string
NetworkSecurityRule	string
Platform	string
PortThrottled	string
SocketBind	string
Unknown	string
UserDefinedRoute	string

Origin

문제의 원본입니다.

Name	형식	Description
Inbound	string
Local	string
Outbound	string

Severity

문제의 심각도입니다.

Name	형식	Description
Error	string
Warning	string