connection_monitor_tests

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

Overview

Name	connection_monitor_tests
Type	Resource
Id	azure.peering.connection_monitor_tests

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
properties	object	The properties that define a Connection Monitor Test.
type	string	The type of the resource.

list_by_peering_service

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
properties	object	The properties that define a Connection Monitor Test.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, peeringServiceName, connectionMonitorTestName, subscriptionId		Gets an existing connection monitor test with the specified name under the given subscription, resource group and peering service.
list_by_peering_service	select	resourceGroupName, peeringServiceName, subscriptionId		Lists all connection monitor tests under the given subscription, resource group and peering service.
create_or_update	insert	resourceGroupName, peeringServiceName, connectionMonitorTestName, subscriptionId		Creates or updates a connection monitor test with the specified name under the given subscription, resource group and peering service.
delete	delete	resourceGroupName, peeringServiceName, connectionMonitorTestName, subscriptionId		Deletes an existing connection monitor test with the specified name under the given subscription, resource group and peering service.

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
connectionMonitorTestName	string	The name of the connection monitor test
peeringServiceName	string	The name of the peering service.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The Azure subscription ID.

SELECT examples

get

Gets an existing connection monitor test with the specified name under the given subscription, resource group and peering service.

SELECT
id,
name,
properties,
type
FROM azure.peering.connection_monitor_tests
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND peeringServiceName = '{{ peeringServiceName }}' -- required
AND connectionMonitorTestName = '{{ connectionMonitorTestName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_peering_service

Lists all connection monitor tests under the given subscription, resource group and peering service.

SELECT
id,
name,
properties,
type
FROM azure.peering.connection_monitor_tests
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND peeringServiceName = '{{ peeringServiceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a connection monitor test with the specified name under the given subscription, resource group and peering service.

INSERT INTO azure.peering.connection_monitor_tests (
data__properties,
resourceGroupName,
peeringServiceName,
connectionMonitorTestName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ peeringServiceName }}',
'{{ connectionMonitorTestName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: connection_monitor_tests
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the connection_monitor_tests resource.
    - name: peeringServiceName
      value: string
      description: Required parameter for the connection_monitor_tests resource.
    - name: connectionMonitorTestName
      value: string
      description: Required parameter for the connection_monitor_tests resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the connection_monitor_tests resource.
    - name: properties
      value: object
      description: |
        The properties that define a Connection Monitor Test.

DELETE examples

delete

Deletes an existing connection monitor test with the specified name under the given subscription, resource group and peering service.

DELETE FROM azure.peering.connection_monitor_tests
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND peeringServiceName = '{{ peeringServiceName }}' --required
AND connectionMonitorTestName = '{{ connectionMonitorTestName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;