Edit

Set-AzureRmNetworkWatcherConnectionMonitor

  • Reference
Module:
AzureRM.Network

Update a connection monitor.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Set-AzureRmNetworkWatcherConnectionMonitor
   -NetworkWatcherName <String>
   -ResourceGroupName <String>
   -Name <String>
   -SourceResourceId <String>
   [-MonitoringIntervalInSeconds <Int32>]
   [-SourcePort <Int32>]
   [-DestinationResourceId <String>]
   [-DestinationAddress <String>]
   [-DestinationPort <Int32>]
   [-ConfigureOnly]
   [-Tag <Hashtable>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmNetworkWatcherConnectionMonitor
   -NetworkWatcher <PSNetworkWatcher>
   -Name <String>
   -SourceResourceId <String>
   [-MonitoringIntervalInSeconds <Int32>]
   [-SourcePort <Int32>]
   [-DestinationResourceId <String>]
   [-DestinationAddress <String>]
   [-DestinationPort <Int32>]
   [-ConfigureOnly]
   [-Tag <Hashtable>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmNetworkWatcherConnectionMonitor
   -Location <String>
   -Name <String>
   -SourceResourceId <String>
   [-MonitoringIntervalInSeconds <Int32>]
   [-SourcePort <Int32>]
   [-DestinationResourceId <String>]
   [-DestinationAddress <String>]
   [-DestinationPort <Int32>]
   [-ConfigureOnly]
   [-Tag <Hashtable>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmNetworkWatcherConnectionMonitor
   -ResourceId <String>
   -SourceResourceId <String>
   [-MonitoringIntervalInSeconds <Int32>]
   [-SourcePort <Int32>]
   [-DestinationResourceId <String>]
   [-DestinationAddress <String>]
   [-DestinationPort <Int32>]
   [-ConfigureOnly]
   [-Tag <Hashtable>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmNetworkWatcherConnectionMonitor
   -InputObject <PSConnectionMonitorResult>
   -SourceResourceId <String>
   [-MonitoringIntervalInSeconds <Int32>]
   [-SourcePort <Int32>]
   [-DestinationResourceId <String>]
   [-DestinationAddress <String>]
   [-DestinationPort <Int32>]
   [-ConfigureOnly]
   [-Tag <Hashtable>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzureRmNetworkWatcherConnectionMonitor cmdlet updates the specified connection monitor.

Examples

Example 1: Update a connection monitor

PS C:\> Set-AzureRmNetworkWatcherConnectionMonitor -Location centraluseuap -Name cm -SourceResourceId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RgCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm 
-DestinationAddress google.com -DestinationPort 80 -Tag @{"key1" = "value1"}

Name                        : cm
Id                          : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGro
                              ups/NetworkWatcherRG/providers/Microsoft.Network/networkWatcher
                              s/NetworkWatcher_centraluseuap/connectionMonitors/cm
Etag                        : W/"5b2b20e8-0ce0-417e-9607-76208149bb67"
ProvisioningState           : Succeeded
Source                      : {
                                "ResourceId": "/subscriptions/00000000-0000-0000-0000-0000000
                                00000/RgCentralUSEUAP/providers/Microsoft.Compute/virtualMach
                                ines/vm",
                                "Port": 0
                              }
Destination                 : {
                                "Address": "google.com",
                                "Port": 80
                              }
MonitoringIntervalInSeconds : 60
AutoStart                   : True
StartTime                   : 1/12/2018 7:19:28 PM
MonitoringStatus            : Running
Location                    : centraluseuap
Type                        : Microsoft.Network/networkWatchers/connectionMonitors
Tags                        : {
                                "key1": "value1"
                              }

In this example we update existing connection monitor by changing destinationAddress and adding tags.

Parameters

-AsJob

Run cmdlet in the background

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConfigureOnly

Configure connection monitor, but do not start it

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DestinationAddress

The Ip address of the connection monitor destination.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DestinationPort

Destination port.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DestinationResourceId

The ID of the connection monitor destination.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Connection monitor object.

Type:PSConnectionMonitorResult
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Location

Location of the network watcher.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-MonitoringIntervalInSeconds

Monitoring interval in seconds.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

The connection monitor name.

Type:String
Aliases:ConnectionMonitorName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NetworkWatcher

The network watcher resource.

Type:PSNetworkWatcher
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NetworkWatcherName

The name of network watcher.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the network watcher resource group.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

Resource ID.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SourcePort

Source port.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SourceResourceId

The ID of the connection monitor source.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Tag

A hashtable which represents resource tags.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSNetworkWatcher

Parameters: NetworkWatcher (ByValue)

String

PSConnectionMonitorResult

Parameters: InputObject (ByValue)

Outputs

PSConnectionMonitorResult

Notes

Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor