1. Packages
  2. Azure Native
  3. API Docs
  4. peering
  5. ConnectionMonitorTest
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.peering.ConnectionMonitorTest

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

The Connection Monitor Test class.

Uses Azure REST API version 2022-10-01. In version 2.x of the Azure Native provider, it used API version 2022-10-01.

Example Usage

Create or Update Connection Monitor Test

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var connectionMonitorTest = new AzureNative.Peering.ConnectionMonitorTest("connectionMonitorTest", new()
    {
        ConnectionMonitorTestName = "connectionMonitorTestName",
        Destination = "Example Destination",
        DestinationPort = 443,
        PeeringServiceName = "peeringServiceName",
        ResourceGroupName = "rgName",
        SourceAgent = "Example Source Agent",
        TestFrequencyInSec = 30,
    });

});
Copy
package main

import (
	peering "github.com/pulumi/pulumi-azure-native-sdk/peering/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := peering.NewConnectionMonitorTest(ctx, "connectionMonitorTest", &peering.ConnectionMonitorTestArgs{
			ConnectionMonitorTestName: pulumi.String("connectionMonitorTestName"),
			Destination:               pulumi.String("Example Destination"),
			DestinationPort:           pulumi.Int(443),
			PeeringServiceName:        pulumi.String("peeringServiceName"),
			ResourceGroupName:         pulumi.String("rgName"),
			SourceAgent:               pulumi.String("Example Source Agent"),
			TestFrequencyInSec:        pulumi.Int(30),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.peering.ConnectionMonitorTest;
import com.pulumi.azurenative.peering.ConnectionMonitorTestArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var connectionMonitorTest = new ConnectionMonitorTest("connectionMonitorTest", ConnectionMonitorTestArgs.builder()
            .connectionMonitorTestName("connectionMonitorTestName")
            .destination("Example Destination")
            .destinationPort(443)
            .peeringServiceName("peeringServiceName")
            .resourceGroupName("rgName")
            .sourceAgent("Example Source Agent")
            .testFrequencyInSec(30)
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const connectionMonitorTest = new azure_native.peering.ConnectionMonitorTest("connectionMonitorTest", {
    connectionMonitorTestName: "connectionMonitorTestName",
    destination: "Example Destination",
    destinationPort: 443,
    peeringServiceName: "peeringServiceName",
    resourceGroupName: "rgName",
    sourceAgent: "Example Source Agent",
    testFrequencyInSec: 30,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

connection_monitor_test = azure_native.peering.ConnectionMonitorTest("connectionMonitorTest",
    connection_monitor_test_name="connectionMonitorTestName",
    destination="Example Destination",
    destination_port=443,
    peering_service_name="peeringServiceName",
    resource_group_name="rgName",
    source_agent="Example Source Agent",
    test_frequency_in_sec=30)
Copy
resources:
  connectionMonitorTest:
    type: azure-native:peering:ConnectionMonitorTest
    properties:
      connectionMonitorTestName: connectionMonitorTestName
      destination: Example Destination
      destinationPort: 443
      peeringServiceName: peeringServiceName
      resourceGroupName: rgName
      sourceAgent: Example Source Agent
      testFrequencyInSec: 30
Copy

Create ConnectionMonitorTest Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ConnectionMonitorTest(name: string, args: ConnectionMonitorTestArgs, opts?: CustomResourceOptions);
@overload
def ConnectionMonitorTest(resource_name: str,
                          args: ConnectionMonitorTestArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def ConnectionMonitorTest(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          peering_service_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          connection_monitor_test_name: Optional[str] = None,
                          destination: Optional[str] = None,
                          destination_port: Optional[int] = None,
                          source_agent: Optional[str] = None,
                          test_frequency_in_sec: Optional[int] = None)
func NewConnectionMonitorTest(ctx *Context, name string, args ConnectionMonitorTestArgs, opts ...ResourceOption) (*ConnectionMonitorTest, error)
public ConnectionMonitorTest(string name, ConnectionMonitorTestArgs args, CustomResourceOptions? opts = null)
public ConnectionMonitorTest(String name, ConnectionMonitorTestArgs args)
public ConnectionMonitorTest(String name, ConnectionMonitorTestArgs args, CustomResourceOptions options)
type: azure-native:peering:ConnectionMonitorTest
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ConnectionMonitorTestArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ConnectionMonitorTestArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ConnectionMonitorTestArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ConnectionMonitorTestArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ConnectionMonitorTestArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var connectionMonitorTestResource = new AzureNative.Peering.ConnectionMonitorTest("connectionMonitorTestResource", new()
{
    PeeringServiceName = "string",
    ResourceGroupName = "string",
    ConnectionMonitorTestName = "string",
    Destination = "string",
    DestinationPort = 0,
    SourceAgent = "string",
    TestFrequencyInSec = 0,
});
Copy
example, err := peering.NewConnectionMonitorTest(ctx, "connectionMonitorTestResource", &peering.ConnectionMonitorTestArgs{
	PeeringServiceName:        pulumi.String("string"),
	ResourceGroupName:         pulumi.String("string"),
	ConnectionMonitorTestName: pulumi.String("string"),
	Destination:               pulumi.String("string"),
	DestinationPort:           pulumi.Int(0),
	SourceAgent:               pulumi.String("string"),
	TestFrequencyInSec:        pulumi.Int(0),
})
Copy
var connectionMonitorTestResource = new ConnectionMonitorTest("connectionMonitorTestResource", ConnectionMonitorTestArgs.builder()
    .peeringServiceName("string")
    .resourceGroupName("string")
    .connectionMonitorTestName("string")
    .destination("string")
    .destinationPort(0)
    .sourceAgent("string")
    .testFrequencyInSec(0)
    .build());
Copy
connection_monitor_test_resource = azure_native.peering.ConnectionMonitorTest("connectionMonitorTestResource",
    peering_service_name="string",
    resource_group_name="string",
    connection_monitor_test_name="string",
    destination="string",
    destination_port=0,
    source_agent="string",
    test_frequency_in_sec=0)
Copy
const connectionMonitorTestResource = new azure_native.peering.ConnectionMonitorTest("connectionMonitorTestResource", {
    peeringServiceName: "string",
    resourceGroupName: "string",
    connectionMonitorTestName: "string",
    destination: "string",
    destinationPort: 0,
    sourceAgent: "string",
    testFrequencyInSec: 0,
});
Copy
type: azure-native:peering:ConnectionMonitorTest
properties:
    connectionMonitorTestName: string
    destination: string
    destinationPort: 0
    peeringServiceName: string
    resourceGroupName: string
    sourceAgent: string
    testFrequencyInSec: 0
Copy

ConnectionMonitorTest Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ConnectionMonitorTest resource accepts the following input properties:

PeeringServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the peering service.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ConnectionMonitorTestName Changes to this property will trigger replacement. string
The name of the connection monitor test
Destination string
The Connection Monitor test destination
DestinationPort int
The Connection Monitor test destination port
SourceAgent string
The Connection Monitor test source agent
TestFrequencyInSec int
The Connection Monitor test frequency in seconds
PeeringServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the peering service.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ConnectionMonitorTestName Changes to this property will trigger replacement. string
The name of the connection monitor test
Destination string
The Connection Monitor test destination
DestinationPort int
The Connection Monitor test destination port
SourceAgent string
The Connection Monitor test source agent
TestFrequencyInSec int
The Connection Monitor test frequency in seconds
peeringServiceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the peering service.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
connectionMonitorTestName Changes to this property will trigger replacement. String
The name of the connection monitor test
destination String
The Connection Monitor test destination
destinationPort Integer
The Connection Monitor test destination port
sourceAgent String
The Connection Monitor test source agent
testFrequencyInSec Integer
The Connection Monitor test frequency in seconds
peeringServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the peering service.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
connectionMonitorTestName Changes to this property will trigger replacement. string
The name of the connection monitor test
destination string
The Connection Monitor test destination
destinationPort number
The Connection Monitor test destination port
sourceAgent string
The Connection Monitor test source agent
testFrequencyInSec number
The Connection Monitor test frequency in seconds
peering_service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the peering service.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
connection_monitor_test_name Changes to this property will trigger replacement. str
The name of the connection monitor test
destination str
The Connection Monitor test destination
destination_port int
The Connection Monitor test destination port
source_agent str
The Connection Monitor test source agent
test_frequency_in_sec int
The Connection Monitor test frequency in seconds
peeringServiceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the peering service.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
connectionMonitorTestName Changes to this property will trigger replacement. String
The name of the connection monitor test
destination String
The Connection Monitor test destination
destinationPort Number
The Connection Monitor test destination port
sourceAgent String
The Connection Monitor test source agent
testFrequencyInSec Number
The Connection Monitor test frequency in seconds

Outputs

All input properties are implicitly available as output properties. Additionally, the ConnectionMonitorTest resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
IsTestSuccessful bool
The flag that indicates if the Connection Monitor test is successful or not.
Name string
The name of the resource.
Path List<string>
The path representing the Connection Monitor test.
ProvisioningState string
The provisioning state of the resource.
Type string
The type of the resource.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
IsTestSuccessful bool
The flag that indicates if the Connection Monitor test is successful or not.
Name string
The name of the resource.
Path []string
The path representing the Connection Monitor test.
ProvisioningState string
The provisioning state of the resource.
Type string
The type of the resource.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
isTestSuccessful Boolean
The flag that indicates if the Connection Monitor test is successful or not.
name String
The name of the resource.
path List<String>
The path representing the Connection Monitor test.
provisioningState String
The provisioning state of the resource.
type String
The type of the resource.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
isTestSuccessful boolean
The flag that indicates if the Connection Monitor test is successful or not.
name string
The name of the resource.
path string[]
The path representing the Connection Monitor test.
provisioningState string
The provisioning state of the resource.
type string
The type of the resource.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
is_test_successful bool
The flag that indicates if the Connection Monitor test is successful or not.
name str
The name of the resource.
path Sequence[str]
The path representing the Connection Monitor test.
provisioning_state str
The provisioning state of the resource.
type str
The type of the resource.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
isTestSuccessful Boolean
The flag that indicates if the Connection Monitor test is successful or not.
name String
The name of the resource.
path List<String>
The path representing the Connection Monitor test.
provisioningState String
The provisioning state of the resource.
type String
The type of the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:peering:ConnectionMonitorTest connectionMonitorTestName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/connectionMonitorTests/{connectionMonitorTestName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi