Share via

Microsoft.Network networkWatchers/connectionMonitors 2019-07-01

Bicep resource definition

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

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-07-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    autoStart: bool
    destination: {
      address: 'string'
      port: int
      resourceId: 'string'
    }
    monitoringIntervalInSeconds: int
    source: {
      port: int
      resourceId: '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

ConnectionMonitorParametersOrConnectionMonitorResultProperties

Name Description Value
autoStart Determines if the connection monitor will start automatically once created. bool
destination Describes the destination of connection monitor. ConnectionMonitorDestination (required)
monitoringIntervalInSeconds Monitoring interval in seconds. int
source Describes the source of connection monitor. ConnectionMonitorSource (required)

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)

ConnectionMonitorTags

Name Description Value

ARM template resource definition

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

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-07-01",
  "name": "string",
  "location": "string",
  "properties": {
    "autoStart": "bool",
    "destination": {
      "address": "string",
      "port": "int",
      "resourceId": "string"
    },
    "monitoringIntervalInSeconds": "int",
    "source": {
      "port": "int",
      "resourceId": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/networkWatchers/connectionMonitors

Name Description Value
apiVersion The api version '2019-07-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

ConnectionMonitorParametersOrConnectionMonitorResultProperties

Name Description Value
autoStart Determines if the connection monitor will start automatically once created. bool
destination Describes the destination of connection monitor. ConnectionMonitorDestination (required)
monitoringIntervalInSeconds Monitoring interval in seconds. int
source Describes the source of connection monitor. ConnectionMonitorSource (required)

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)

ConnectionMonitorTags

Name Description Value

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-07-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      autoStart = bool
      destination = {
        address = "string"
        port = int
        resourceId = "string"
      }
      monitoringIntervalInSeconds = int
      source = {
        port = int
        resourceId = "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-07-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

ConnectionMonitorParametersOrConnectionMonitorResultProperties

Name Description Value
autoStart Determines if the connection monitor will start automatically once created. bool
destination Describes the destination of connection monitor. ConnectionMonitorDestination (required)
monitoringIntervalInSeconds Monitoring interval in seconds. int
source Describes the source of connection monitor. ConnectionMonitorSource (required)

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)

ConnectionMonitorTags

Name Description Value