connection_monitors

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

Overview

Name	connection_monitors
Type	Resource
Id	azure.network.connection_monitors

Fields

vw_connection_monitors

Name	Datatype	Description
id	text	ID of the connection monitor.
name	text	Name of the connection monitor.
auto_start	text	field from the properties object
connectionMonitorName	text	field from the properties object
connection_monitor_type	text	field from the properties object
destination	text	field from the properties object
endpoints	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
location	text	Connection monitor location.
monitoring_interval_in_seconds	text	field from the properties object
monitoring_status	text	field from the properties object
networkWatcherName	text	field from the properties object
notes	text	field from the properties object
outputs	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
source	text	field from the properties object
start_time	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Connection monitor tags.
test_configurations	text	field from the properties object
test_groups	text	field from the properties object
type	text	Connection monitor type.

connection_monitors

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	Describes the properties of a connection monitor.
tags	object	Connection monitor tags.
type	string	Connection monitor type.

Methods

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

SELECT examples

Lists all connection monitors for the specified Network Watcher.

vw_connection_monitors

SELECT
id,
name,
auto_start,
connectionMonitorName,
connection_monitor_type,
destination,
endpoints,
etag,
location,
monitoring_interval_in_seconds,
monitoring_status,
networkWatcherName,
notes,
outputs,
provisioning_state,
resourceGroupName,
source,
start_time,
subscriptionId,
tags,
test_configurations,
test_groups,
type
FROM azure.network.vw_connection_monitors
WHERE networkWatcherName = '{{ networkWatcherName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

connection_monitors

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

INSERT example

Use the following StackQL query and manifest file to create a new connection_monitors resource.

All Properties

/*+ create */
INSERT INTO azure.network.connection_monitors (
connectionMonitorName,
networkWatcherName,
resourceGroupName,
subscriptionId,
data__properties,
location,
tags,
properties
)
SELECT 
'{{ connectionMonitorName }}',
'{{ networkWatcherName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: source
          value:
            - name: resourceId
              value: string
            - name: port
              value: integer
        - name: destination
          value:
            - name: resourceId
              value: string
            - name: address
              value: string
            - name: port
              value: integer
        - name: autoStart
          value: boolean
        - name: monitoringIntervalInSeconds
          value: integer
        - name: endpoints
          value:
            - - name: name
                value: string
              - name: type
                value: string
              - name: resourceId
                value: string
              - name: address
                value: string
              - name: filter
                value:
                  - name: type
                    value: string
                  - name: items
                    value:
                      - - name: type
                          value: string
                        - name: address
                          value: string
              - name: scope
                value:
                  - name: include
                    value:
                      - - name: address
                          value: string
                  - name: exclude
                    value:
                      - - name: address
                          value: string
              - name: coverageLevel
                value: string
              - name: locationDetails
                value:
                  - name: region
                    value: string
              - name: subscriptionId
                value: string
        - name: testConfigurations
          value:
            - - name: name
                value: string
              - name: testFrequencySec
                value: integer
              - name: protocol
                value: string
              - name: preferredIPVersion
                value: string
              - name: httpConfiguration
                value:
                  - name: port
                    value: integer
                  - name: method
                    value: string
                  - name: path
                    value: string
                  - name: requestHeaders
                    value:
                      - - name: name
                          value: string
                        - name: value
                          value: string
                  - name: validStatusCodeRanges
                    value:
                      - string
                  - name: preferHTTPS
                    value: boolean
              - name: tcpConfiguration
                value:
                  - name: port
                    value: integer
                  - name: disableTraceRoute
                    value: boolean
                  - name: destinationPortBehavior
                    value: string
              - name: icmpConfiguration
                value:
                  - name: disableTraceRoute
                    value: boolean
              - name: successThreshold
                value:
                  - name: checksFailedPercent
                    value: integer
                  - name: roundTripTimeMs
                    value: number
        - name: testGroups
          value:
            - - name: name
                value: string
              - name: disable
                value: boolean
              - name: testConfigurations
                value:
                  - string
              - name: sources
                value:
                  - string
              - name: destinations
                value:
                  - string
        - name: outputs
          value:
            - - name: type
                value: string
              - name: workspaceSettings
                value:
                  - name: workspaceResourceId
                    value: string
        - name: notes
          value: string

DELETE example

Deletes the specified connection_monitors resource.

/*+ delete */
DELETE FROM azure.network.connection_monitors
WHERE connectionMonitorName = '{{ connectionMonitorName }}'
AND networkWatcherName = '{{ networkWatcherName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';