Microsoft.Network networkWatchers/connectionMonitors 2019-12-01

• Latest
• 2024-07-01
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01
• 2018-06-01
• 2018-04-01
• 2018-02-01
• 2018-01-01
• 2017-11-01
• 2017-10-01

Bicep resource definition

The networkWatchers/connectionMonitors resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/networkWatchers/connectionMonitors resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/networkWatchers/connectionMonitors@2019-12-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    autoStart: bool
    destination: {
      address: 'string'
      port: int
      resourceId: 'string'
    }
    endpoints: [
      {
        address: 'string'
        filter: {
          items: [
            {
              address: 'string'
              type: 'string'
            }
          ]
          type: 'string'
        }
        name: 'string'
        resourceId: 'string'
      }
    ]
    monitoringIntervalInSeconds: int
    notes: 'string'
    outputs: [
      {
        type: 'string'
        workspaceSettings: {
          workspaceResourceId: 'string'
        }
      }
    ]
    source: {
      port: int
      resourceId: 'string'
    }
    testConfigurations: [
      {
        httpConfiguration: {
          method: 'string'
          path: 'string'
          port: int
          preferHTTPS: bool
          requestHeaders: [
            {
              name: 'string'
              value: 'string'
            }
          ]
          validStatusCodeRanges: [
            'string'
          ]
        }
        icmpConfiguration: {
          disableTraceRoute: bool
        }
        name: 'string'
        preferredIPVersion: 'string'
        protocol: 'string'
        successThreshold: {
          checksFailedPercent: int
          roundTripTimeMs: int
        }
        tcpConfiguration: {
          disableTraceRoute: bool
          port: int
        }
        testFrequencySec: int
      }
    ]
    testGroups: [
      {
        destinations: [
          'string'
        ]
        disable: bool
        name: 'string'
        sources: [
          'string'
        ]
        testConfigurations: [
          'string'
        ]
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Network/networkWatchers/connectionMonitors

Name	Description	Value
location	Connection monitor location.	string
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: networkWatchers
properties	Properties of the connection monitor.	ConnectionMonitorParametersOrConnectionMonitorResultProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ConnectionMonitorDestination

Name	Description	Value
address	Address of the connection monitor destination (IP or domain name).	string
port	The destination port used by connection monitor.	int
resourceId	The ID of the resource used as the destination by connection monitor.	string

ConnectionMonitorEndpoint

Name	Description	Value
address	Address of the connection monitor endpoint (IP or domain name).	string
filter	Filter for sub-items within the endpoint.	ConnectionMonitorEndpointFilter
name	The name of the connection monitor endpoint.	string (required)
resourceId	Resource ID of the connection monitor endpoint.	string

ConnectionMonitorEndpointFilter

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

ConnectionMonitorEndpointFilterItem

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

ConnectionMonitorHttpConfiguration

Name	Description	Value
method	The HTTP method to use.	'Get' 'Post'
path	The path component of the URI. For instance, "/dir1/dir2".	string
port	The port to connect to.	int
preferHTTPS	Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.	bool
requestHeaders	The HTTP headers to transmit with the request.	HttpHeader[]
validStatusCodeRanges	HTTP status codes to consider successful. For instance, "2xx,301-304,418".	string[]

ConnectionMonitorIcmpConfiguration

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

ConnectionMonitorOutput

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

ConnectionMonitorParametersOrConnectionMonitorResultProperties

Name	Description	Value
autoStart	Determines if the connection monitor will start automatically once created.	bool
destination	Describes the destination of connection monitor.	ConnectionMonitorDestination
endpoints	List of connection monitor endpoints.	ConnectionMonitorEndpoint[]
monitoringIntervalInSeconds	Monitoring interval in seconds.	int
notes	Optional notes to be associated with the connection monitor.	string
outputs	List of connection monitor outputs.	ConnectionMonitorOutput[]
source	Describes the source of connection monitor.	ConnectionMonitorSource
testConfigurations	List of connection monitor test configurations.	ConnectionMonitorTestConfiguration[]
testGroups	List of connection monitor test groups.	ConnectionMonitorTestGroup[]

ConnectionMonitorSource

Name	Description	Value
port	The source port used by connection monitor.	int
resourceId	The ID of the resource used as the source by connection monitor.	string (required)

ConnectionMonitorSuccessThreshold

Name	Description	Value
checksFailedPercent	The maximum percentage of failed checks permitted for a test to evaluate as successful.	int
roundTripTimeMs	The maximum round-trip time in milliseconds permitted for a test to evaluate as successful.	int

ConnectionMonitorTags

Name	Description	Value

ConnectionMonitorTcpConfiguration

Name	Description	Value
disableTraceRoute	Value indicating whether path evaluation with trace route should be disabled.	bool
port	The port to connect to.	int

ConnectionMonitorTestConfiguration

Name	Description	Value
httpConfiguration	The parameters used to perform test evaluation over HTTP.	ConnectionMonitorHttpConfiguration
icmpConfiguration	The parameters used to perform test evaluation over ICMP.	ConnectionMonitorIcmpConfiguration
name	The name of the connection monitor test configuration.	string (required)
preferredIPVersion	The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters.	'IPv4' 'IPv6'
protocol	The protocol to use in test evaluation.	'Http' 'Icmp' 'Tcp' (required)
successThreshold	The threshold for declaring a test successful.	ConnectionMonitorSuccessThreshold
tcpConfiguration	The parameters used to perform test evaluation over TCP.	ConnectionMonitorTcpConfiguration
testFrequencySec	The frequency of test evaluation, in seconds.	int

ConnectionMonitorTestGroup

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

ConnectionMonitorWorkspaceSettings

Name	Description	Value
workspaceResourceId	Log analytics workspace resource ID.	string

HttpHeader

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

ARM template resource definition

The networkWatchers/connectionMonitors resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/networkWatchers/connectionMonitors resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/networkWatchers/connectionMonitors",
  "apiVersion": "2019-12-01",
  "name": "string",
  "location": "string",
  "properties": {
    "autoStart": "bool",
    "destination": {
      "address": "string",
      "port": "int",
      "resourceId": "string"
    },
    "endpoints": [
      {
        "address": "string",
        "filter": {
          "items": [
            {
              "address": "string",
              "type": "string"
            }
          ],
          "type": "string"
        },
        "name": "string",
        "resourceId": "string"
      }
    ],
    "monitoringIntervalInSeconds": "int",
    "notes": "string",
    "outputs": [
      {
        "type": "string",
        "workspaceSettings": {
          "workspaceResourceId": "string"
        }
      }
    ],
    "source": {
      "port": "int",
      "resourceId": "string"
    },
    "testConfigurations": [
      {
        "httpConfiguration": {
          "method": "string",
          "path": "string",
          "port": "int",
          "preferHTTPS": "bool",
          "requestHeaders": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "validStatusCodeRanges": [ "string" ]
        },
        "icmpConfiguration": {
          "disableTraceRoute": "bool"
        },
        "name": "string",
        "preferredIPVersion": "string",
        "protocol": "string",
        "successThreshold": {
          "checksFailedPercent": "int",
          "roundTripTimeMs": "int"
        },
        "tcpConfiguration": {
          "disableTraceRoute": "bool",
          "port": "int"
        },
        "testFrequencySec": "int"
      }
    ],
    "testGroups": [
      {
        "destinations": [ "string" ],
        "disable": "bool",
        "name": "string",
        "sources": [ "string" ],
        "testConfigurations": [ "string" ]
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/networkWatchers/connectionMonitors

Name	Description	Value
apiVersion	The api version	'2019-12-01'
location	Connection monitor location.	string
name	The resource name	string (required)
properties	Properties of the connection monitor.	ConnectionMonitorParametersOrConnectionMonitorResultProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Network/networkWatchers/connectionMonitors'

ConnectionMonitorDestination

Name	Description	Value
address	Address of the connection monitor destination (IP or domain name).	string
port	The destination port used by connection monitor.	int
resourceId	The ID of the resource used as the destination by connection monitor.	string

ConnectionMonitorEndpoint

Name	Description	Value
address	Address of the connection monitor endpoint (IP or domain name).	string
filter	Filter for sub-items within the endpoint.	ConnectionMonitorEndpointFilter
name	The name of the connection monitor endpoint.	string (required)
resourceId	Resource ID of the connection monitor endpoint.	string

ConnectionMonitorEndpointFilter

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

ConnectionMonitorEndpointFilterItem

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

ConnectionMonitorHttpConfiguration

Name	Description	Value
method	The HTTP method to use.	'Get' 'Post'
path	The path component of the URI. For instance, "/dir1/dir2".	string
port	The port to connect to.	int
preferHTTPS	Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.	bool
requestHeaders	The HTTP headers to transmit with the request.	HttpHeader[]
validStatusCodeRanges	HTTP status codes to consider successful. For instance, "2xx,301-304,418".	string[]

ConnectionMonitorIcmpConfiguration

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

ConnectionMonitorOutput

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

ConnectionMonitorParametersOrConnectionMonitorResultProperties

Name	Description	Value
autoStart	Determines if the connection monitor will start automatically once created.	bool
destination	Describes the destination of connection monitor.	ConnectionMonitorDestination
endpoints	List of connection monitor endpoints.	ConnectionMonitorEndpoint[]
monitoringIntervalInSeconds	Monitoring interval in seconds.	int
notes	Optional notes to be associated with the connection monitor.	string
outputs	List of connection monitor outputs.	ConnectionMonitorOutput[]
source	Describes the source of connection monitor.	ConnectionMonitorSource
testConfigurations	List of connection monitor test configurations.	ConnectionMonitorTestConfiguration[]
testGroups	List of connection monitor test groups.	ConnectionMonitorTestGroup[]

ConnectionMonitorSource

Name	Description	Value
port	The source port used by connection monitor.	int
resourceId	The ID of the resource used as the source by connection monitor.	string (required)

ConnectionMonitorSuccessThreshold

Name	Description	Value
checksFailedPercent	The maximum percentage of failed checks permitted for a test to evaluate as successful.	int
roundTripTimeMs	The maximum round-trip time in milliseconds permitted for a test to evaluate as successful.	int

ConnectionMonitorTags

Name	Description	Value

ConnectionMonitorTcpConfiguration

Name	Description	Value
disableTraceRoute	Value indicating whether path evaluation with trace route should be disabled.	bool
port	The port to connect to.	int

ConnectionMonitorTestConfiguration

Name	Description	Value
httpConfiguration	The parameters used to perform test evaluation over HTTP.	ConnectionMonitorHttpConfiguration
icmpConfiguration	The parameters used to perform test evaluation over ICMP.	ConnectionMonitorIcmpConfiguration
name	The name of the connection monitor test configuration.	string (required)
preferredIPVersion	The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters.	'IPv4' 'IPv6'
protocol	The protocol to use in test evaluation.	'Http' 'Icmp' 'Tcp' (required)
successThreshold	The threshold for declaring a test successful.	ConnectionMonitorSuccessThreshold
tcpConfiguration	The parameters used to perform test evaluation over TCP.	ConnectionMonitorTcpConfiguration
testFrequencySec	The frequency of test evaluation, in seconds.	int

ConnectionMonitorTestGroup

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

ConnectionMonitorWorkspaceSettings

Name	Description	Value
workspaceResourceId	Log analytics workspace resource ID.	string

HttpHeader

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

Usage Examples

Terraform (AzAPI provider) resource definition

The networkWatchers/connectionMonitors resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/networkWatchers/connectionMonitors resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkWatchers/connectionMonitors@2019-12-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      autoStart = bool
      destination = {
        address = "string"
        port = int
        resourceId = "string"
      }
      endpoints = [
        {
          address = "string"
          filter = {
            items = [
              {
                address = "string"
                type = "string"
              }
            ]
            type = "string"
          }
          name = "string"
          resourceId = "string"
        }
      ]
      monitoringIntervalInSeconds = int
      notes = "string"
      outputs = [
        {
          type = "string"
          workspaceSettings = {
            workspaceResourceId = "string"
          }
        }
      ]
      source = {
        port = int
        resourceId = "string"
      }
      testConfigurations = [
        {
          httpConfiguration = {
            method = "string"
            path = "string"
            port = int
            preferHTTPS = bool
            requestHeaders = [
              {
                name = "string"
                value = "string"
              }
            ]
            validStatusCodeRanges = [
              "string"
            ]
          }
          icmpConfiguration = {
            disableTraceRoute = bool
          }
          name = "string"
          preferredIPVersion = "string"
          protocol = "string"
          successThreshold = {
            checksFailedPercent = int
            roundTripTimeMs = int
          }
          tcpConfiguration = {
            disableTraceRoute = bool
            port = int
          }
          testFrequencySec = int
        }
      ]
      testGroups = [
        {
          destinations = [
            "string"
          ]
          disable = bool
          name = "string"
          sources = [
            "string"
          ]
          testConfigurations = [
            "string"
          ]
        }
      ]
    }
  }
}

Property Values

Microsoft.Network/networkWatchers/connectionMonitors

Name	Description	Value
location	Connection monitor location.	string
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: networkWatchers
properties	Properties of the connection monitor.	ConnectionMonitorParametersOrConnectionMonitorResultProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Network/networkWatchers/connectionMonitors@2019-12-01"

ConnectionMonitorDestination

Name	Description	Value
address	Address of the connection monitor destination (IP or domain name).	string
port	The destination port used by connection monitor.	int
resourceId	The ID of the resource used as the destination by connection monitor.	string

ConnectionMonitorEndpoint

Name	Description	Value
address	Address of the connection monitor endpoint (IP or domain name).	string
filter	Filter for sub-items within the endpoint.	ConnectionMonitorEndpointFilter
name	The name of the connection monitor endpoint.	string (required)
resourceId	Resource ID of the connection monitor endpoint.	string

ConnectionMonitorEndpointFilter

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

ConnectionMonitorEndpointFilterItem

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

ConnectionMonitorHttpConfiguration

Name	Description	Value
method	The HTTP method to use.	'Get' 'Post'
path	The path component of the URI. For instance, "/dir1/dir2".	string
port	The port to connect to.	int
preferHTTPS	Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.	bool
requestHeaders	The HTTP headers to transmit with the request.	HttpHeader[]
validStatusCodeRanges	HTTP status codes to consider successful. For instance, "2xx,301-304,418".	string[]

ConnectionMonitorIcmpConfiguration

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

ConnectionMonitorOutput

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

ConnectionMonitorParametersOrConnectionMonitorResultProperties

Name	Description	Value
autoStart	Determines if the connection monitor will start automatically once created.	bool
destination	Describes the destination of connection monitor.	ConnectionMonitorDestination
endpoints	List of connection monitor endpoints.	ConnectionMonitorEndpoint[]
monitoringIntervalInSeconds	Monitoring interval in seconds.	int
notes	Optional notes to be associated with the connection monitor.	string
outputs	List of connection monitor outputs.	ConnectionMonitorOutput[]
source	Describes the source of connection monitor.	ConnectionMonitorSource
testConfigurations	List of connection monitor test configurations.	ConnectionMonitorTestConfiguration[]
testGroups	List of connection monitor test groups.	ConnectionMonitorTestGroup[]

ConnectionMonitorSource

Name	Description	Value
port	The source port used by connection monitor.	int
resourceId	The ID of the resource used as the source by connection monitor.	string (required)

ConnectionMonitorSuccessThreshold

Name	Description	Value
checksFailedPercent	The maximum percentage of failed checks permitted for a test to evaluate as successful.	int
roundTripTimeMs	The maximum round-trip time in milliseconds permitted for a test to evaluate as successful.	int

ConnectionMonitorTags

Name	Description	Value

ConnectionMonitorTcpConfiguration

Name	Description	Value
disableTraceRoute	Value indicating whether path evaluation with trace route should be disabled.	bool
port	The port to connect to.	int

ConnectionMonitorTestConfiguration

Name	Description	Value
httpConfiguration	The parameters used to perform test evaluation over HTTP.	ConnectionMonitorHttpConfiguration
icmpConfiguration	The parameters used to perform test evaluation over ICMP.	ConnectionMonitorIcmpConfiguration
name	The name of the connection monitor test configuration.	string (required)
preferredIPVersion	The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters.	'IPv4' 'IPv6'
protocol	The protocol to use in test evaluation.	'Http' 'Icmp' 'Tcp' (required)
successThreshold	The threshold for declaring a test successful.	ConnectionMonitorSuccessThreshold
tcpConfiguration	The parameters used to perform test evaluation over TCP.	ConnectionMonitorTcpConfiguration
testFrequencySec	The frequency of test evaluation, in seconds.	int

ConnectionMonitorTestGroup

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

ConnectionMonitorWorkspaceSettings

Name	Description	Value
workspaceResourceId	Log analytics workspace resource ID.	string

HttpHeader

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