Get-AzureRmNetworkWatcherConnectionMonitor
Returns connection monitor with specified name or the list of connection monitors
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
Get-AzureRmNetworkWatcherConnectionMonitor
-NetworkWatcherName <String>
-ResourceGroupName <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmNetworkWatcherConnectionMonitor
-NetworkWatcher <PSNetworkWatcher>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmNetworkWatcherConnectionMonitor
-Location <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmNetworkWatcherConnectionMonitor
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzureRmNetworkWatcherConnectionMonitor cmdlet returns the connection monitor with the specified name / resourceId or the list of connection monitors corresponding to the specified network watcher / location.
Examples
Example 1: Get connection monitor by name in the specified location
PS C:\> Get-AzureRmNetworkWatcherConnectionMonitor -Location centraluseuap -Name cm
Name : cm
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGro
ups/NetworkWatcherRG/providers/Microsoft.Network/networkWatcher
s/NetworkWatcher_centraluseuap/connectionMonitors/cm
Etag : W/"40961b58-e379-4204-a47b-0c477739b095"
ProvisioningState : Succeeded
Source : {
"ResourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6
a1f99/resourceGroups/VarunRgCentralUSEUAP/providers/Microsoft.C
ompute/virtualMachines/irinavm",
"Port": 0
}
Destination : {
"Address": "google.com",
"Port": 80
}
MonitoringIntervalInSeconds : 60
AutoStart : True
StartTime : 1/12/2018 7:19:28 PM
MonitoringStatus : Stopped
Location : centraluseuap
Type : Microsoft.Network/networkWatchers/connectionMonitors
Tags : {
"key1": "value1"
}
In this example we get connection monitor by name in the specified location.
Parameters
-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 |
-Location
Location of the network watcher.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The connection monitor name.
Type: | String |
Aliases: | ConnectionMonitorName |
Position: | Named |
Default value: | None |
Required: | False |
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 of the connection monitor.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Parameters: NetworkWatcher (ByValue)
Outputs
Notes
Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor