az network network-watcher connection-monitor
Manage connection monitor.
Connection monitor provides unified, end-to-end connection monitoring in Network Watcher. The Connection monitor feature supports hybrid and Azure cloud deployments.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az network network-watcher connection-monitor create |
Create a connection monitor. |
Core | GA |
| az network network-watcher connection-monitor delete |
Delete the specified connection monitor. |
Core | GA |
| az network network-watcher connection-monitor list |
List all connection monitors for the specified Network Watcher. |
Core | GA |
| az network network-watcher connection-monitor show |
Get a connection monitor by name. |
Core | GA |
| az network network-watcher connection-monitor wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network network-watcher connection-monitor create
Create a connection monitor.
az network network-watcher connection-monitor create --connection-monitor-name
--network-watcher-name
--resource-group
[--auto-start {0, 1, f, false, n, no, t, true, y, yes}]
[--endpoints]
[--location]
[--migrate]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--notes]
[--outputs]
[--tags]
[--test-configurations]
[--test-groups]Examples
Create connection monitor
az network network-watcher connection-monitor create --name cm12 --network-watcher-name networkwatcher_eastus --resource-group networkwatcherrg --location eastus --endpoints "[{name:vmName,type:AzureVM,resourceId:/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Compute/virtualMachines/TESTVM-LINUX},{address:8.8.8.8,name:google,type:ExternalAddress}]" --test-configurations "[{name:TestConfiguration04,protocol:Tcp,successThreshold:{},tcpConfiguration:{disableTraceRoute:false,port:53},testFrequencySec:30}]" --test-groups "[{destinations:[google],disable:false,name:TestingGroup04,sources:[vmName],testConfigurations:[TestConfiguration04]}]"Create Connection Monitor
az network network-watcher connection-monitor create --name cm12 --network-watcher-name networkwatcher_eastus --resource-group networkwatcherrg --location eastus --endpoints "[{name:vmName,type:AzureVM,resourceId:/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Compute/virtualMachines/TESTVM-LINUX},{address:8.8.8.8,name:google,type:ExternalAddress}]" --test-configurations "[{name:TestConfiguration04,protocol:Tcp,successThreshold:{},tcpConfiguration:{disableTraceRoute:false,port:53},testFrequencySec:30}]" --test-groups "[{destinations:[google],disable:false,name:TestingGroup04,sources:[vmName],testConfigurations:[TestConfiguration04]}]" --outputs "[{type:Workspace,workspaceSettings:{workspaceResourceId:/subscriptions/subid/resourceGroups/DefaultResourceGroup-EUS/providers/Microsoft.OperationalInsights/workspaces/DefaultWorkspace-sub-id-region}}]"Required Parameters
The name of the connection monitor.
The name of the Network Watcher resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Determines if the connection monitor will start automatically once created.
List of connection monitor endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Connection monitor location.
Value indicating whether connection monitor V1 should be migrated to V2 format.
Do not wait for the long-running operation to finish.
Optional notes to be associated with the connection monitor.
List of connection monitor outputs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Connection monitor tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of connection monitor test configurations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of connection monitor test groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network network-watcher connection-monitor delete
Delete the specified connection monitor.
az network network-watcher connection-monitor delete [--connection-monitor-name]
[--ids]
[--network-watcher-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]Examples
Required Parameters
Optional Parameters
The name of the connection monitor.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the Network Watcher resource.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network network-watcher connection-monitor list
List all connection monitors for the specified Network Watcher.
az network network-watcher connection-monitor list --network-watcher-name
--resource-groupExamples
Required Parameters
The name of the Network Watcher resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network network-watcher connection-monitor show
Get a connection monitor by name.
az network network-watcher connection-monitor show [--connection-monitor-name]
[--ids]
[--network-watcher-name]
[--resource-group]
[--subscription]Examples
Required Parameters
Optional Parameters
The name of the connection monitor.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the Network Watcher resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network network-watcher connection-monitor wait
Place the CLI in a waiting state until a condition is met.
az network network-watcher connection-monitor wait [--connection-monitor-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--network-watcher-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Examples
Required Parameters
Optional Parameters
The name of the connection monitor.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
The name of the Network Watcher resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
