Connection Monitors - Get

Service:

Network Watcher

API Version:

2024-05-01

Gets a connection monitor by name.

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

URI Parameters

Name	In	Required	Type	Description
connectionMonitorName	path	True	string	The name of the connection monitor.
networkWatcherName	path	True	string	The name of the Network Watcher resource.
resourceGroupName	path	True	string	The name of the resource group containing Network Watcher.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	ConnectionMonitorResult	Request successful. The operation returns a connection monitor.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

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	impersonate your user account

Examples

Get connection monitor

Sample request

HTTP

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

Java

/**
 * Samples for ConnectionMonitors Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * NetworkWatcherConnectionMonitorGet.json
     */
    /**
     * Sample code: Get connection monitor.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getConnectionMonitor(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getConnectionMonitors().getWithResponse("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_get.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.get(
        resource_group_name="rg1",
        network_watcher_name="nw1",
        connection_monitor_name="cm1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherConnectionMonitorGet.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/NetworkWatcherConnectionMonitorGet.json
func ExampleConnectionMonitorsClient_Get() {
	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)
	}
	res, err := clientFactory.NewConnectionMonitorsClient().Get(ctx, "rg1", "nw1", "cm1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.ConnectionMonitorResult = armnetwork.ConnectionMonitorResult{
	// 	Name: to.Ptr("cm1"),
	// 	Type: to.Ptr("Microsoft.Network/networkWatchers/connectionMonitors"),
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armnetwork.ConnectionMonitorResultProperties{
	// 		Endpoints: []*armnetwork.ConnectionMonitorEndpoint{
	// 			{
	// 				Name: to.Ptr("source"),
	// 				ResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1"),
	// 			},
	// 			{
	// 				Name: to.Ptr("destination"),
	// 				Address: to.Ptr("bing.com"),
	// 		}},
	// 		TestConfigurations: []*armnetwork.ConnectionMonitorTestConfiguration{
	// 			{
	// 				Name: to.Ptr("tcp"),
	// 				TCPConfiguration: &armnetwork.ConnectionMonitorTCPConfiguration{
	// 					Port: to.Ptr[int32](80),
	// 				},
	// 				TestFrequencySec: to.Ptr[int32](60),
	// 				Protocol: to.Ptr(armnetwork.ConnectionMonitorTestConfigurationProtocolTCP),
	// 		}},
	// 		TestGroups: []*armnetwork.ConnectionMonitorTestGroup{
	// 			{
	// 				Name: to.Ptr("tg"),
	// 				Destinations: []*string{
	// 					to.Ptr("destination")},
	// 					Sources: []*string{
	// 						to.Ptr("source")},
	// 						TestConfigurations: []*string{
	// 							to.Ptr("tcp")},
	// 					}},
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				},
	// 			}
}

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 Gets a connection monitor by name.
 *
 * @summary Gets a connection monitor by name.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherConnectionMonitorGet.json
 */
async function getConnectionMonitor() {
  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.get(
    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/NetworkWatcherConnectionMonitorGet.json
// this example is just showing the usage of "ConnectionMonitors_Get" 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
ConnectionMonitorResource result = await connectionMonitor.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ConnectionMonitorData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "name": "cm1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "properties": {
    "provisioningState": "Succeeded",
    "endpoints": [
      {
        "name": "source",
        "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1"
      },
      {
        "name": "destination",
        "address": "bing.com"
      }
    ],
    "testConfigurations": [
      {
        "name": "tcp",
        "testFrequencySec": 60,
        "protocol": "Tcp",
        "tcpConfiguration": {
          "port": 80
        }
      }
    ],
    "testGroups": [
      {
        "name": "tg",
        "testConfigurations": [
          "tcp"
        ],
        "sources": [
          "source"
        ],
        "destinations": [
          "destination"
        ]
      }
    ]
  },
  "location": "eastus",
  "type": "Microsoft.Network/networkWatchers/connectionMonitors"
}

Definitions

Name	Description
ConnectionMonitorDestination	Describes the destination of connection monitor.
ConnectionMonitorEndpoint	Describes the connection monitor endpoint.
ConnectionMonitorEndpointFilter	Describes the connection monitor endpoint filter.
ConnectionMonitorEndpointFilterItem	Describes the connection monitor endpoint filter item.
ConnectionMonitorEndpointFilterItemType	The type of item included in the filter. Currently only 'AgentAddress' is supported.
ConnectionMonitorEndpointFilterType	The behavior of the endpoint filter. Currently only 'Include' is supported.
ConnectionMonitorEndpointLocationDetails	Connection monitor endpoint location details only being used for 'AzureArcNetwork' type endpoints, which contains the region details.
ConnectionMonitorEndpointScope	Describes the connection monitor endpoint scope.
ConnectionMonitorEndpointScopeItem	Describes the connection monitor endpoint scope item.
ConnectionMonitorHttpConfiguration	Describes the HTTP configuration.
ConnectionMonitorIcmpConfiguration	Describes the ICMP configuration.
ConnectionMonitorOutput	Describes a connection monitor output destination.
ConnectionMonitorResult	Information about the connection monitor.
ConnectionMonitorSource	Describes the source of connection monitor.
ConnectionMonitorSuccessThreshold	Describes the threshold for declaring a test successful.
ConnectionMonitorTcpConfiguration	Describes the TCP configuration.
ConnectionMonitorTestConfiguration	Describes a connection monitor test configuration.
ConnectionMonitorTestConfigurationProtocol	The protocol to use in test evaluation.
ConnectionMonitorTestGroup	Describes the connection monitor test group.
ConnectionMonitorType	Type of connection monitor.
ConnectionMonitorWorkspaceSettings	Describes the settings for producing output into a log analytics workspace.
CoverageLevel	Test coverage for the endpoint.
DestinationPortBehavior	Destination port behavior.
EndpointType	The endpoint type.
ErrorDetails	Common error details representation.
ErrorResponse	The error object.
HTTPConfigurationMethod	The HTTP method to use.
HTTPHeader	The HTTP header.
OutputType	Connection monitor output destination type. Currently, only "Workspace" is supported.
PreferredIPVersion	The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters.
ProvisioningState	The current provisioning state.

ConnectionMonitorDestination

Object

Describes the destination of connection monitor.

Name	Type	Description
address	string	Address of the connection monitor destination (IP or domain name).
port	integer (int32) minimum: 0 maximum: 65535	The destination port used by connection monitor.
resourceId	string	The ID of the resource used as the destination by connection monitor.

ConnectionMonitorEndpoint

Object

Describes the connection monitor endpoint.

Name	Type	Description
address	string	Address of the connection monitor endpoint. Supported for AzureVM, ExternalAddress, ArcMachine, MMAWorkspaceMachine endpoint type.
coverageLevel	CoverageLevel	Test coverage for the endpoint.
filter	ConnectionMonitorEndpointFilter	Filter field is getting deprecated and should not be used. Instead use Include/Exclude scope fields for it.
locationDetails	ConnectionMonitorEndpointLocationDetails	Location details is optional and only being used for 'AzureArcNetwork' type endpoints, which contains region details.
name	string	The name of the connection monitor endpoint.
resourceId	string	Resource ID of the connection monitor endpoint are supported for AzureVM, AzureVMSS, AzureVNet, AzureSubnet, MMAWorkspaceMachine, MMAWorkspaceNetwork, AzureArcVM endpoint type.
scope	ConnectionMonitorEndpointScope	Endpoint scope defines which target resource to monitor in case of compound resource endpoints like VMSS, AzureSubnet, AzureVNet, MMAWorkspaceNetwork, AzureArcNetwork.
subscriptionId	string	Subscription ID for connection monitor endpoint. It's an optional parameter which is being used for 'AzureArcNetwork' type endpoint.
type	EndpointType	The endpoint type.

ConnectionMonitorEndpointFilter

Object

Describes the connection monitor endpoint filter.

Name	Type	Description
items	ConnectionMonitorEndpointFilterItem[]	List of items in the filter.
type	ConnectionMonitorEndpointFilterType	The behavior of the endpoint filter. Currently only 'Include' is supported.

ConnectionMonitorEndpointFilterItem

Object

Describes the connection monitor endpoint filter item.

Name	Type	Description
address	string	The address of the filter item.
type	ConnectionMonitorEndpointFilterItemType	The type of item included in the filter. Currently only 'AgentAddress' is supported.

ConnectionMonitorEndpointFilterItemType

Enumeration

The type of item included in the filter. Currently only 'AgentAddress' is supported.

Value	Description
AgentAddress

ConnectionMonitorEndpointFilterType

Enumeration

The behavior of the endpoint filter. Currently only 'Include' is supported.

Value	Description
Include

ConnectionMonitorEndpointLocationDetails

Object

Connection monitor endpoint location details only being used for 'AzureArcNetwork' type endpoints, which contains the region details.

Name	Type	Description
region	string	Region for connection monitor endpoint.

ConnectionMonitorEndpointScope

Object

Describes the connection monitor endpoint scope.

Name	Type	Description
exclude	ConnectionMonitorEndpointScopeItem[]	List of items which needs to be excluded from the endpoint scope.
include	ConnectionMonitorEndpointScopeItem[]	List of items which needs to be included to the endpoint scope.

ConnectionMonitorEndpointScopeItem

Object

Describes the connection monitor endpoint scope item.

Name	Type	Description
address	string	The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address.

ConnectionMonitorHttpConfiguration

Object

Describes the HTTP configuration.

Name	Type	Description
method	HTTPConfigurationMethod	The HTTP method to use.
path	string	The path component of the URI. For instance, "/dir1/dir2".
port	integer (int32) minimum: 0 maximum: 65535	The port to connect to.
preferHTTPS	boolean	Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.
requestHeaders	HTTPHeader[]	The HTTP headers to transmit with the request.
validStatusCodeRanges	string[]	HTTP status codes to consider successful. For instance, "2xx,301-304,418".

ConnectionMonitorIcmpConfiguration

Object

Describes the ICMP configuration.

Name	Type	Description
disableTraceRoute	boolean	Value indicating whether path evaluation with trace route should be disabled.

ConnectionMonitorOutput

Object

Describes a connection monitor output destination.

Name	Type	Description
type	OutputType	Connection monitor output destination type. Currently, only "Workspace" is supported.
workspaceSettings	ConnectionMonitorWorkspaceSettings	Describes the settings for producing output into a log analytics workspace.

ConnectionMonitorResult

Object

Information about the connection monitor.

Name	Type	Default value	Description
etag	string		A unique read-only string that changes whenever the resource is updated.
id	string		ID of the connection monitor.
location	string		Connection monitor location.
name	string		Name of the connection monitor.
properties.autoStart	boolean	True	Determines if the connection monitor will start automatically once created.
properties.connectionMonitorType	ConnectionMonitorType		Type of connection monitor.
properties.destination	ConnectionMonitorDestination		Describes the destination of connection monitor.
properties.endpoints	ConnectionMonitorEndpoint[]		List of connection monitor endpoints.
properties.monitoringIntervalInSeconds	integer (int32) minimum: 30 maximum: 1800	60	Monitoring interval in seconds.
properties.monitoringStatus	string		The monitoring status of the connection monitor.
properties.notes	string		Optional notes to be associated with the connection monitor.
properties.outputs	ConnectionMonitorOutput[]		List of connection monitor outputs.
properties.provisioningState	ProvisioningState		The provisioning state of the connection monitor.
properties.source	ConnectionMonitorSource		Describes the source of connection monitor.
properties.startTime	string (date-time)		The date and time when the connection monitor was started.
properties.testConfigurations	ConnectionMonitorTestConfiguration[]		List of connection monitor test configurations.
properties.testGroups	ConnectionMonitorTestGroup[]		List of connection monitor test groups.
tags	object		Connection monitor tags.
type	string		Connection monitor type.

ConnectionMonitorSource

Object

Describes the source of connection monitor.

Name	Type	Description
port	integer (int32) minimum: 0 maximum: 65535	The source port used by connection monitor.
resourceId	string	The ID of the resource used as the source by connection monitor.

ConnectionMonitorSuccessThreshold

Object

Describes the threshold for declaring a test successful.

Name	Type	Description
checksFailedPercent	integer (int32)	The maximum percentage of failed checks permitted for a test to evaluate as successful.
roundTripTimeMs	number	The maximum round-trip time in milliseconds permitted for a test to evaluate as successful.

ConnectionMonitorTcpConfiguration

Object

Describes the TCP configuration.

Name	Type	Description
destinationPortBehavior	DestinationPortBehavior	Destination port behavior.
disableTraceRoute	boolean	Value indicating whether path evaluation with trace route should be disabled.
port	integer (int32) minimum: 0 maximum: 65535	The port to connect to.

ConnectionMonitorTestConfiguration

Object

Describes a connection monitor test configuration.

Name	Type	Description
httpConfiguration	ConnectionMonitorHttpConfiguration	The parameters used to perform test evaluation over HTTP.
icmpConfiguration	ConnectionMonitorIcmpConfiguration	The parameters used to perform test evaluation over ICMP.
name	string	The name of the connection monitor test configuration.
preferredIPVersion	PreferredIPVersion	The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters.
protocol	ConnectionMonitorTestConfigurationProtocol	The protocol to use in test evaluation.
successThreshold	ConnectionMonitorSuccessThreshold	The threshold for declaring a test successful.
tcpConfiguration	ConnectionMonitorTcpConfiguration	The parameters used to perform test evaluation over TCP.
testFrequencySec	integer (int32)	The frequency of test evaluation, in seconds.

ConnectionMonitorTestConfigurationProtocol

Enumeration

The protocol to use in test evaluation.

Value	Description
Tcp
Http
Icmp

ConnectionMonitorTestGroup

Object

Describes the connection monitor test group.

Name	Type	Description
destinations	string[]	List of destination endpoint names.
disable	boolean	Value indicating whether test group is disabled.
name	string	The name of the connection monitor test group.
sources	string[]	List of source endpoint names.
testConfigurations	string[]	List of test configuration names.

ConnectionMonitorType

Enumeration

Type of connection monitor.

Value	Description
MultiEndpoint
SingleSourceDestination

ConnectionMonitorWorkspaceSettings

Object

Describes the settings for producing output into a log analytics workspace.

Name	Type	Description
workspaceResourceId	string	Log analytics workspace resource ID.

CoverageLevel

Enumeration

Test coverage for the endpoint.

Value	Description
Default
Low
BelowAverage
Average
AboveAverage
Full

DestinationPortBehavior

Enumeration

Destination port behavior.

Value	Description
None
ListenIfAvailable

EndpointType

Enumeration

The endpoint type.

Value	Description
AzureVM
AzureVNet
AzureSubnet
ExternalAddress
MMAWorkspaceMachine
MMAWorkspaceNetwork
AzureArcVM
AzureVMSS
AzureArcNetwork

ErrorDetails

Object

Common error details representation.

Name	Type	Description
code	string	Error code.
message	string	Error message.
target	string	Error target.

ErrorResponse

Object

The error object.

Name	Type	Description
error	ErrorDetails	Error The error details object.

HTTPConfigurationMethod

Enumeration

The HTTP method to use.

Value	Description
Get
Post

HTTPHeader

Object

The HTTP header.

Name	Type	Description
name	string	The name in HTTP header.
value	string	The value in HTTP header.

OutputType

Enumeration

Connection monitor output destination type. Currently, only "Workspace" is supported.

Value	Description
Workspace

PreferredIPVersion

Enumeration

The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters.

Value	Description
IPv4
IPv6

ProvisioningState

Enumeration

The current provisioning state.

Value	Description
Succeeded
Updating
Deleting
Failed