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

Request successful. The operation returns a connection monitor.

Name	Datatype	Description
id	string	ID of the connection monitor.
name	string	Name of the connection monitor.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Connection monitor location.
properties	object	Properties of the connection monitor result.
tags	object	Connection monitor tags.
type	string	Connection monitor type.

list

Successful connection monitor enumeration request.

Name	Datatype	Description
id	string	ID of the connection monitor.
name	string	Name of the connection monitor.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Connection monitor location.
properties	object	Properties of the connection monitor result.
tags	object	Connection monitor tags.
type	string	Connection monitor type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, networkWatcherName, connectionMonitorName, subscriptionId		Gets a connection monitor by name.
list	select	resourceGroupName, networkWatcherName, subscriptionId		Lists all connection monitors for the specified Network Watcher.
create_or_update	insert	resourceGroupName, networkWatcherName, connectionMonitorName, subscriptionId, data__properties	migrate	Create or update a connection monitor.
delete	delete	resourceGroupName, networkWatcherName, connectionMonitorName, subscriptionId		Deletes the specified connection monitor.
update_tags	exec	resourceGroupName, networkWatcherName, connectionMonitorName, subscriptionId		Update tags of the specified connection monitor.
stop	exec	resourceGroupName, networkWatcherName, connectionMonitorName, subscriptionId		Stops the specified connection monitor.
start	exec	resourceGroupName, networkWatcherName, connectionMonitorName, subscriptionId		Starts the specified connection monitor.
query	exec	resourceGroupName, networkWatcherName, connectionMonitorName, subscriptionId		Query a snapshot of the most recent connection states.

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
connectionMonitorName	string	The name given to the connection monitor.
networkWatcherName	string	The name of the Network Watcher resource.
resourceGroupName	string	The name of the resource group containing Network Watcher.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
migrate	string	Value indicating whether connection monitor V1 should be migrated to V2 format.

SELECT examples

get

Gets a connection monitor by name.

SELECT
id,
name,
etag,
location,
properties,
tags,
type
FROM azure.network.connection_monitors
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkWatcherName = '{{ networkWatcherName }}' -- required
AND connectionMonitorName = '{{ connectionMonitorName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all connection monitors for the specified Network Watcher.

SELECT
id,
name,
etag,
location,
properties,
tags,
type
FROM azure.network.connection_monitors
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkWatcherName = '{{ networkWatcherName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update a connection monitor.

INSERT INTO azure.network.connection_monitors (
data__location,
data__tags,
data__properties,
resourceGroupName,
networkWatcherName,
connectionMonitorName,
subscriptionId,
migrate
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ networkWatcherName }}',
'{{ connectionMonitorName }}',
'{{ subscriptionId }}',
'{{ migrate }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: connection_monitors
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the connection_monitors resource.
    - name: networkWatcherName
      value: string
      description: Required parameter for the connection_monitors resource.
    - name: connectionMonitorName
      value: string
      description: Required parameter for the connection_monitors resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the connection_monitors resource.
    - name: location
      value: string
      description: |
        Connection monitor location.
    - name: tags
      value: object
      description: |
        Connection monitor tags.
    - name: properties
      value: object
      description: |
        Properties of the connection monitor.
    - name: migrate
      value: string
      description: Value indicating whether connection monitor V1 should be migrated to V2 format.

DELETE examples

delete

Deletes the specified connection monitor.

DELETE FROM azure.network.connection_monitors
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND networkWatcherName = '{{ networkWatcherName }}' --required
AND connectionMonitorName = '{{ connectionMonitorName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Update tags of the specified connection monitor.

EXEC azure.network.connection_monitors.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkWatcherName='{{ networkWatcherName }}' --required, 
@connectionMonitorName='{{ connectionMonitorName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

stop

Stops the specified connection monitor.

EXEC azure.network.connection_monitors.stop 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkWatcherName='{{ networkWatcherName }}' --required, 
@connectionMonitorName='{{ connectionMonitorName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

start

Starts the specified connection monitor.

EXEC azure.network.connection_monitors.start 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkWatcherName='{{ networkWatcherName }}' --required, 
@connectionMonitorName='{{ connectionMonitorName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

query

Query a snapshot of the most recent connection states.

EXEC azure.network.connection_monitors.query 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkWatcherName='{{ networkWatcherName }}' --required, 
@connectionMonitorName='{{ connectionMonitorName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;