az network watcher connection-monitor test-configuration
This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage test configuration of a connection monitor.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az network watcher connection-monitor test-configuration add |
Add a test configuration to a connection monitor. |
Core | Preview |
| az network watcher connection-monitor test-configuration list |
List all test configurations of a connection monitor. |
Core | Preview |
| az network watcher connection-monitor test-configuration remove |
Remove a test configuration from a connection monitor. |
Core | Preview |
| az network watcher connection-monitor test-configuration show |
Show a test configuration from a connection monitor. |
Core | Preview |
| az network watcher connection-monitor test-configuration wait |
Place the CLI in a waiting state until a condition is met. |
Core | Preview |
az network watcher connection-monitor test-configuration add
Command group 'az network watcher connection-monitor test-configuration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Add a test configuration to a connection monitor.
az network watcher connection-monitor test-configuration add --connection-monitor
--location
--name
--protocol {Http, Icmp, Tcp}
--test-groups
[--frequency]
[--http-method {Get, Post}]
[--http-path]
[--http-port]
[--http-prefer-https {0, 1, f, false, n, no, t, true, y, yes}]
[--http-request-header]
[--http-valid-status-codes]
[--icmp-disable-trace-route {0, 1, f, false, n, no, t, true, y, yes}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--preferred-ip-version {IPv4, IPv6}]
[--tcp-disable-trace-route {0, 1, f, false, n, no, t, true, y, yes}]
[--tcp-port]
[--tcp-port-behavior {ListenIfAvailable, None}]
[--threshold-failed-percent]
[--threshold-round-trip-time]Examples
Add a test configuration with HTTP supported
az network watcher connection-monitor test-configuration add --connection-monitor MyConnectionMonitor --location westus --name MyHTTPTestConfiguration --test-groups DefaultTestGroup --protocol Http --http-request-header name=Host value=bing.com --http- request-header name=UserAgent value=EdgeAdd a test configuration with TCP supported
az network watcher connection-monitor test-configuration add --connection-monitor MyConnectionMonitor --location westus --name MyHTTPTestConfiguration --test-groups TCPTestGroup DefaultTestGroup --protocol Tcp --tcp-port 4096Required Parameters
Connection monitor name.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
The name of the connection monitor test configuration.
The protocol to use in test evaluation. Allowed values: Http, Icmp, Tcp.
Space-separated list of names of test group which only need to be affected if specified. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Optional Parameters
The frequency of test evaluation, in seconds. Default: 60.
The HTTP method to use. Allowed values: Get, Post.
The path component of the URI. For instance, "/dir1/dir2".
The port to connect to.
Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.
The HTTP headers to transmit with the request. List of property=value pairs to define HTTP headers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
HTTP status codes to consider successful. For instance, "2xx,301-304,418". Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Value indicating whether path evaluation with trace route should be disabled. false is default. Allowed values: false, true.
Do not wait for the long-running operation to finish.
The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. Allowed values: IPv4, IPv6.
Value indicating whether path evaluation with trace route should be disabled. false is default. Allowed values: false, true.
The port to connect to.
Destination port behavior. Allowed values: ListenIfAvailable, None.
The maximum percentage of failed checks permitted for a test to evaluate as successful.
The maximum round-trip time in milliseconds permitted for a test to evaluate as successful.
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 watcher connection-monitor test-configuration list
Command group 'az network watcher connection-monitor test-configuration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List all test configurations of a connection monitor.
az network watcher connection-monitor test-configuration list --connection-monitor
--locationExamples
List all test configurations of a connection monitor.
az network watcher connection-monitor test-configuration list --connection-monitor MyConnectionMonitor --location westus2Required Parameters
Connection monitor name.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
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 watcher connection-monitor test-configuration remove
Command group 'az network watcher connection-monitor test-configuration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Remove a test configuration from a connection monitor.
az network watcher connection-monitor test-configuration remove --connection-monitor
--location
--name
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--test-groups]Examples
Remove a test configuration from all test groups of a connection monitor
az network watcher connection-monitor test-configuration remove --connection-monitor MyConnectionMonitor --location westus --name MyTCPTestConfigurationRemove a test configuration from two test groups of a connection monitor
az network watcher connection-monitor test-configuration remove --connection-monitor MyConnectionMonitor --location westus --name MyHTTPTestConfiguration --test-groups HTTPTestGroup DefaultTestGroupRequired Parameters
Connection monitor name.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
The name of the connection monitor test configuration.
Optional Parameters
Do not wait for the long-running operation to finish.
Space-separated list of names of test group which only need to be affected if specified. 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 watcher connection-monitor test-configuration show
Command group 'az network watcher connection-monitor test-configuration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show a test configuration from a connection monitor.
az network watcher connection-monitor test-configuration show --connection-monitor
--location
--nameExamples
Show a test configuration from a connection monitor.
az network watcher connection-monitor test-configuration show --connection-monitor MyConnectionMonitor --location westus2 --name MyConnectionMonitorTestConfigurationRequired Parameters
Connection monitor name.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
The name of the connection monitor test configuration.
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 watcher connection-monitor test-configuration wait
Command group 'az network watcher connection-monitor test-configuration' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition is met.
az network watcher connection-monitor test-configuration wait [--connection-monitor]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--subscription]
[--timeout]
[--updated]
[--watcher-name]
[--watcher-rg]Optional Parameters
Connection monitor name.
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.
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'.
The name of the Network Watcher resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for