connection_monitors

Creates, updates, deletes, gets or lists a connection_monitors resource.

Overview

Name	connection_monitors
Type	Resource
Id	azure.network.connection_monitors

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	ID of the connection monitor.
name	string	Name of the connection monitor.
autoStart	boolean	Determines if the connection monitor will start automatically once created.
connectionMonitorType	string	Type of connection monitor. Known values are: "MultiEndpoint" and "SingleSourceDestination". (MultiEndpoint, SingleSourceDestination)
destination	object	Describes the destination of connection monitor.
endpoints	array	List of connection monitor endpoints.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Connection monitor location.
monitoringIntervalInSeconds	integer	Monitoring interval in seconds.
monitoringStatus	string	The monitoring status of the connection monitor.
notes	string	Optional notes to be associated with the connection monitor.
outputs	array	List of connection monitor outputs.
provisioningState	string	The provisioning state of the connection monitor. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
source	object	Describes the source of connection monitor.
startTime	string (date-time)	The date and time when the connection monitor was started.
tags	object	Connection monitor tags.
testConfigurations	array	List of connection monitor test configurations.
testGroups	array	List of connection monitor test groups.
type	string	Connection monitor type.

list

Name	Datatype	Description
id	string	ID of the connection monitor.
name	string	Name of the connection monitor.
autoStart	boolean	Determines if the connection monitor will start automatically once created.
connectionMonitorType	string	Type of connection monitor. Known values are: "MultiEndpoint" and "SingleSourceDestination". (MultiEndpoint, SingleSourceDestination)
destination	object	Describes the destination of connection monitor.
endpoints	array	List of connection monitor endpoints.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Connection monitor location.
monitoringIntervalInSeconds	integer	Monitoring interval in seconds.
monitoringStatus	string	The monitoring status of the connection monitor.
notes	string	Optional notes to be associated with the connection monitor.
outputs	array	List of connection monitor outputs.
provisioningState	string	The provisioning state of the connection monitor. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
source	object	Describes the source of connection monitor.
startTime	string (date-time)	The date and time when the connection monitor was started.
tags	object	Connection monitor tags.
testConfigurations	array	List of connection monitor test configurations.
testGroups	array	List of connection monitor test groups.
type	string	Connection monitor type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_watcher_name, connection_monitor_name, subscription_id		Gets a connection monitor by name.
list	select	resource_group_name, network_watcher_name, subscription_id		Lists all connection monitors for the specified Network Watcher.
create_or_update	insert	resource_group_name, network_watcher_name, connection_monitor_name, subscription_id, properties	migrate	Create or update a connection monitor.
update_tags	update	resource_group_name, network_watcher_name, connection_monitor_name, subscription_id		Update tags of the specified connection monitor.
create_or_update	replace	resource_group_name, network_watcher_name, connection_monitor_name, subscription_id, properties	migrate	Create or update a connection monitor.
delete	delete	resource_group_name, network_watcher_name, connection_monitor_name, subscription_id		Deletes the specified connection monitor.
stop	exec	resource_group_name, network_watcher_name, connection_monitor_name, subscription_id		Stops the specified connection monitor.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
connection_monitor_name	string	The name of the connection monitor. Required.
network_watcher_name	string	The name of the network watcher. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
migrate	string	Value indicating whether connection monitor V1 should be migrated to V2 format. Default value is None.

SELECT examples

get

Gets a connection monitor by name.

SELECT
id,
name,
autoStart,
connectionMonitorType,
destination,
endpoints,
etag,
location,
monitoringIntervalInSeconds,
monitoringStatus,
notes,
outputs,
provisioningState,
source,
startTime,
tags,
testConfigurations,
testGroups,
type
FROM azure.network.connection_monitors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_watcher_name = '{{ network_watcher_name }}' -- required
AND connection_monitor_name = '{{ connection_monitor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all connection monitors for the specified Network Watcher.

SELECT
id,
name,
autoStart,
connectionMonitorType,
destination,
endpoints,
etag,
location,
monitoringIntervalInSeconds,
monitoringStatus,
notes,
outputs,
provisioningState,
source,
startTime,
tags,
testConfigurations,
testGroups,
type
FROM azure.network.connection_monitors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_watcher_name = '{{ network_watcher_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a connection monitor.

INSERT INTO azure.network.connection_monitors (
location,
tags,
properties,
resource_group_name,
network_watcher_name,
connection_monitor_name,
subscription_id,
migrate
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ network_watcher_name }}',
'{{ connection_monitor_name }}',
'{{ subscription_id }}',
'{{ migrate }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: connection_monitors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the connection_monitors resource.
  - name: network_watcher_name
    value: "{{ network_watcher_name }}"
    description: Required parameter for the connection_monitors resource.
  - name: connection_monitor_name
    value: "{{ connection_monitor_name }}"
    description: Required parameter for the connection_monitors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the connection_monitors resource.
  - name: location
    value: "{{ location }}"
    description: |
      Connection monitor location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Connection monitor tags.
  - name: properties
    description: |
      Properties of the connection monitor. Required.
    value:
      source:
        resourceId: "{{ resourceId }}"
        port: {{ port }}
      destination:
        resourceId: "{{ resourceId }}"
        address: "{{ address }}"
        port: {{ port }}
      autoStart: {{ autoStart }}
      monitoringIntervalInSeconds: {{ monitoringIntervalInSeconds }}
      endpoints:
        - name: "{{ name }}"
          type: "{{ type }}"
          resourceId: "{{ resourceId }}"
          address: "{{ address }}"
          filter:
            type: "{{ type }}"
            items_:
              - type: "{{ type }}"
                address: "{{ address }}"
          scope:
            include:
              - address: "{{ address }}"
            exclude:
              - address: "{{ address }}"
          coverageLevel: "{{ coverageLevel }}"
          locationDetails:
            region: "{{ region }}"
          subscriptionId: "{{ subscriptionId }}"
      testConfigurations:
        - name: "{{ name }}"
          testFrequencySec: {{ testFrequencySec }}
          protocol: "{{ protocol }}"
          preferredIPVersion: "{{ preferredIPVersion }}"
          httpConfiguration:
            port: {{ port }}
            method: "{{ method }}"
            path: "{{ path }}"
            requestHeaders:
              - name: "{{ name }}"
                value: "{{ value }}"
            validStatusCodeRanges:
              - "{{ validStatusCodeRanges }}"
            preferHTTPS: {{ preferHTTPS }}
          tcpConfiguration:
            port: {{ port }}
            disableTraceRoute: {{ disableTraceRoute }}
            destinationPortBehavior: "{{ destinationPortBehavior }}"
          icmpConfiguration:
            disableTraceRoute: {{ disableTraceRoute }}
          successThreshold:
            checksFailedPercent: {{ checksFailedPercent }}
            roundTripTimeMs: {{ roundTripTimeMs }}
      testGroups:
        - name: "{{ name }}"
          disable: {{ disable }}
          testConfigurations: "{{ testConfigurations }}"
          sources: "{{ sources }}"
          destinations: "{{ destinations }}"
      outputs:
        - type: "{{ type }}"
          workspaceSettings:
            workspaceResourceId: "{{ workspaceResourceId }}"
      notes: "{{ notes }}"
  - name: migrate
    value: "{{ migrate }}"
    description: Value indicating whether connection monitor V1 should be migrated to V2 format. Default value is None.
    description: Value indicating whether connection monitor V1 should be migrated to V2 format. Default value is None.

UPDATE examples

update_tags

Update tags of the specified connection monitor.

UPDATE azure.network.connection_monitors
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_watcher_name = '{{ network_watcher_name }}' --required
AND connection_monitor_name = '{{ connection_monitor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Create or update a connection monitor.

REPLACE azure.network.connection_monitors
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_watcher_name = '{{ network_watcher_name }}' --required
AND connection_monitor_name = '{{ connection_monitor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
AND migrate = '{{ migrate}}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified connection monitor.

DELETE FROM azure.network.connection_monitors
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_watcher_name = '{{ network_watcher_name }}' --required
AND connection_monitor_name = '{{ connection_monitor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

stop

Stops the specified connection monitor.

EXEC azure.network.connection_monitors.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_watcher_name='{{ network_watcher_name }}' --required, 
@connection_monitor_name='{{ connection_monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;