Connection Monitors - Query

Referência

Service:: Network Watcher

API Version:: 2023-09-01

Consulte um instantâneo dos estados de conexão mais recentes.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
connectionMonitorName	path	True	string	O nome dado ao monitor de conexão.
networkWatcherName	path	True	string	O nome do recurso Observador de Rede.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém Observador de Rede.
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão de API do cliente.

Respostas

Nome	Tipo	Description
200 OK	ConnectionMonitorQueryResult	Consulta bem-sucedida de estados de conexão.
202 Accepted	ConnectionMonitorQueryResult	Consulta aceita de estados de conexão.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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-09-01


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

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

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

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

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

Definições

Nome	Description
ConnectionMonitorQueryResult	Lista de instantâneos de estados de conexão.
ConnectionMonitorSourceStatus	Status da origem do monitor de conexão.
ConnectionState	O estado da conexão.
ConnectionStateSnapshot	Estado de conexão instantâneo.
ConnectivityHop	Informações sobre um salto entre a origem e o destino.
ConnectivityIssue	Informações sobre um problema encontrado no processo de verificação de conectividade.
ErrorDetails	Representação de detalhes de erro comuns.
ErrorResponse	O objeto de erro.
EvaluationState	Estado de avaliação da análise de conectividade.
HopLink	Link de salto.
IssueType	O tipo de problema.
Origin	A origem do problema.
Severity	A gravidade do problema.

ConnectionMonitorQueryResult

Lista de instantâneos de estados de conexão.

Nome	Tipo	Description
sourceStatus	ConnectionMonitorSourceStatus	Status da origem do monitor de conexão.
states	ConnectionStateSnapshot[]	Informações sobre estados de conexão.

ConnectionMonitorSourceStatus

Status da origem do monitor de conexão.

Nome	Tipo	Description
Active	string
Inactive	string
Unknown	string

ConnectionState

O estado da conexão.

Nome	Tipo	Description
Reachable	string
Unknown	string
Unreachable	string

ConnectionStateSnapshot

Estado de conexão instantâneo.

Nome	Tipo	Description
avgLatencyInMs	integer	Latência média em ms.
connectionState	ConnectionState	O estado da conexão.
endTime	string	A hora de término da conexão instantâneo.
evaluationState	EvaluationState	Estado de avaliação da análise de conectividade.
hops	ConnectivityHop[]	Lista de saltos entre a origem e o destino.
maxLatencyInMs	integer	Latência máxima em ms.
minLatencyInMs	integer	Latência mínima em ms.
probesFailed	integer	O número de investigações com falha.
probesSent	integer	O número de investigações enviadas.
startTime	string	A hora de início da conexão instantâneo.

ConnectivityHop

Informações sobre um salto entre a origem e o destino.

Nome	Tipo	Description
address	string	O endereço IP do salto.
id	string	A ID do salto.
issues	ConnectivityIssue[]	Lista de problemas.
links	HopLink[]	Lista de links de salto.
nextHopIds	string[]	Lista de identificadores do próximo salto.
previousHopIds	string[]	Lista de identificadores de salto anteriores.
previousLinks	HopLink[]	Lista de links de salto anteriores.
resourceId	string	A ID do recurso correspondente a este salto.
type	string	O tipo do salto.

ConnectivityIssue

Informações sobre um problema encontrado no processo de verificação de conectividade.

Nome	Tipo	Description
context	object[]	Fornece contexto adicional sobre o problema.
origin	Origin	A origem do problema.
severity	Severity	A gravidade do problema.
type	IssueType	O tipo de problema.

ErrorDetails

Representação de detalhes de erro comuns.

Nome	Tipo	Description
code	string	Código do erro.
message	string	Mensagem de erro.
target	string	Destino de erro.

ErrorResponse

O objeto de erro.

Nome	Tipo	Description
error	ErrorDetails	Erro O objeto de detalhes do erro.

EvaluationState

Estado de avaliação da análise de conectividade.

Nome	Tipo	Description
Completed	string
InProgress	string
NotStarted	string

HopLink

Link de salto.

Nome	Tipo	Description
context	object	Fornece contexto adicional em links.
issues	ConnectivityIssue[]	Lista de problemas.
linkType	string	Tipo de link.
nextHopId	string	A ID do próximo salto.
properties.roundTripTimeAvg	integer	Tempo médio de ida e volta em milissegundos.
properties.roundTripTimeMax	integer	Tempo máximo de ida e volta em milissegundos.
properties.roundTripTimeMin	integer	Tempo mínimo de ida e volta em milissegundos.
resourceId	string	ID do recurso.

IssueType

O tipo de problema.

Nome	Tipo	Description
AgentStopped	string
DnsResolution	string
GuestFirewall	string
NetworkSecurityRule	string
Platform	string
PortThrottled	string
SocketBind	string
Unknown	string
UserDefinedRoute	string

Origin

A origem do problema.

Nome	Tipo	Description
Inbound	string
Local	string
Outbound	string

Severity

A gravidade do problema.

Nome	Tipo	Description
Error	string
Warning	string