NetworkConnectionMonitor

Configures a Network Connection Monitor to monitor communication between a Virtual Machine and an endpoint using a Network Watcher.

Create a NetworkConnectionMonitor Resource

new NetworkConnectionMonitor(name: string, args: NetworkConnectionMonitorArgs, opts?: CustomResourceOptions);

def NetworkConnectionMonitor(resource_name, opts=None, auto_start=None, destination=None, interval_in_seconds=None, location=None, name=None, network_watcher_name=None, resource_group_name=None, source=None, tags=None, __props__=None);

func NewNetworkConnectionMonitor(ctx *Context, name string, args NetworkConnectionMonitorArgs, opts ...ResourceOption) (*NetworkConnectionMonitor, error)

public NetworkConnectionMonitor(string name, NetworkConnectionMonitorArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args NetworkConnectionMonitorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NetworkConnectionMonitorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NetworkConnectionMonitorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

NetworkConnectionMonitor Resource Properties

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

Inputs

The NetworkConnectionMonitor resource accepts the following input properties:

Destination NetworkConnectionMonitorDestinationArgs: A destination block as defined below.
NetworkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Connection Monitor. Changing this forces a new resource to be created.
Source NetworkConnectionMonitorSourceArgs: A source block as defined below.
AutoStart bool: Specifies whether the connection monitor will start automatically once created. Defaults to true. Changing this forces a new resource to be created.
IntervalInSeconds int: Monitoring interval in seconds. Defaults to 60.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the Network Connection Monitor. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

Destination NetworkConnectionMonitorDestination: A destination block as defined below.
NetworkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Connection Monitor. Changing this forces a new resource to be created.
Source NetworkConnectionMonitorSource: A source block as defined below.
AutoStart bool: Specifies whether the connection monitor will start automatically once created. Defaults to true. Changing this forces a new resource to be created.
IntervalInSeconds int: Monitoring interval in seconds. Defaults to 60.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the Network Connection Monitor. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

destination NetworkConnectionMonitorDestination: A destination block as defined below.
networkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which to create the Connection Monitor. Changing this forces a new resource to be created.
source NetworkConnectionMonitorSource: A source block as defined below.
autoStart boolean: Specifies whether the connection monitor will start automatically once created. Defaults to true. Changing this forces a new resource to be created.
intervalInSeconds number: Monitoring interval in seconds. Defaults to 60.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: The name of the Network Connection Monitor. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

destination Dict[NetworkConnectionMonitorDestination]: A destination block as defined below.
network_watcher_name str: The name of the Network Watcher. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which to create the Connection Monitor. Changing this forces a new resource to be created.
source Dict[NetworkConnectionMonitorSource]: A source block as defined below.
auto_start bool: Specifies whether the connection monitor will start automatically once created. Defaults to true. Changing this forces a new resource to be created.
interval_in_seconds float: Monitoring interval in seconds. Defaults to 60.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: The name of the Network Connection Monitor. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing NetworkConnectionMonitor Resource

Get an existing NetworkConnectionMonitor resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NetworkConnectionMonitorState, opts?: CustomResourceOptions): NetworkConnectionMonitor

static get(resource_name, id, opts=None, auto_start=None, destination=None, interval_in_seconds=None, location=None, name=None, network_watcher_name=None, resource_group_name=None, source=None, tags=None, __props__=None);

func GetNetworkConnectionMonitor(ctx *Context, name string, id IDInput, state *NetworkConnectionMonitorState, opts ...ResourceOption) (*NetworkConnectionMonitor, error)

public static NetworkConnectionMonitor Get(string name, Input<string> id, NetworkConnectionMonitorState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoStart bool: Specifies whether the connection monitor will start automatically once created. Defaults to true. Changing this forces a new resource to be created.
Destination NetworkConnectionMonitorDestinationArgs: A destination block as defined below.
IntervalInSeconds int: Monitoring interval in seconds. Defaults to 60.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the Network Connection Monitor. Changing this forces a new resource to be created.
NetworkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Connection Monitor. Changing this forces a new resource to be created.
Source NetworkConnectionMonitorSourceArgs: A source block as defined below.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

AutoStart bool: Specifies whether the connection monitor will start automatically once created. Defaults to true. Changing this forces a new resource to be created.
Destination NetworkConnectionMonitorDestination: A destination block as defined below.
IntervalInSeconds int: Monitoring interval in seconds. Defaults to 60.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the Network Connection Monitor. Changing this forces a new resource to be created.
NetworkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Connection Monitor. Changing this forces a new resource to be created.
Source NetworkConnectionMonitorSource: A source block as defined below.
Tags map[string]string: A mapping of tags to assign to the resource.

autoStart boolean: Specifies whether the connection monitor will start automatically once created. Defaults to true. Changing this forces a new resource to be created.
destination NetworkConnectionMonitorDestination: A destination block as defined below.
intervalInSeconds number: Monitoring interval in seconds. Defaults to 60.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: The name of the Network Connection Monitor. Changing this forces a new resource to be created.
networkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which to create the Connection Monitor. Changing this forces a new resource to be created.
source NetworkConnectionMonitorSource: A source block as defined below.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

auto_start bool: Specifies whether the connection monitor will start automatically once created. Defaults to true. Changing this forces a new resource to be created.
destination Dict[NetworkConnectionMonitorDestination]: A destination block as defined below.
interval_in_seconds float: Monitoring interval in seconds. Defaults to 60.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: The name of the Network Connection Monitor. Changing this forces a new resource to be created.
network_watcher_name str: The name of the Network Watcher. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which to create the Connection Monitor. Changing this forces a new resource to be created.
source Dict[NetworkConnectionMonitorSource]: A source block as defined below.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

NetworkConnectionMonitorDestination

See the input and output API doc for this type.

Port int: The port on the destination to monitor connectivity to.
Address string: IP address or domain name to monitor connectivity to.
VirtualMachineId string: The ID of the Virtual Machine to monitor connectivity to.

Port int: The port on the destination to monitor connectivity to.
Address string: IP address or domain name to monitor connectivity to.
VirtualMachineId string: The ID of the Virtual Machine to monitor connectivity to.

port number: The port on the destination to monitor connectivity to.
address string: IP address or domain name to monitor connectivity to.
virtualMachineId string: The ID of the Virtual Machine to monitor connectivity to.

port float: The port on the destination to monitor connectivity to.
address str: IP address or domain name to monitor connectivity to.
virtual_machine_id str: The ID of the Virtual Machine to monitor connectivity to.

NetworkConnectionMonitorSource

See the input and output API doc for this type.

VirtualMachineId string: The ID of the Virtual Machine to monitor connectivity to.
Port int: The port on the destination to monitor connectivity to.

VirtualMachineId string: The ID of the Virtual Machine to monitor connectivity to.
Port int: The port on the destination to monitor connectivity to.

virtualMachineId string: The ID of the Virtual Machine to monitor connectivity to.
port number: The port on the destination to monitor connectivity to.

virtual_machine_id str: The ID of the Virtual Machine to monitor connectivity to.
port float: The port on the destination to monitor connectivity to.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud