Share via

az network watcher connection-monitor test-configuration

  • Preview
  • Reference

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

Edit
Preview

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=Edge

Add 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 4096

Required Parameters

--connection-monitor

Connection monitor name.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name --test-configuration-name -n

The name of the connection monitor test configuration.

--protocol

The protocol to use in test evaluation. Allowed values: Http, Icmp, Tcp.

Accepted values: Http, Icmp, Tcp
--test-groups

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

--frequency

The frequency of test evaluation, in seconds. Default: 60.

--http-method

The HTTP method to use. Allowed values: Get, Post.

Accepted values: Get, Post
--http-path

The path component of the URI. For instance, "/dir1/dir2".

--http-port

The port to connect to.

--http-prefer-https

Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--http-request-header

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-valid-status-codes

HTTP status codes to consider successful. For instance, "2xx,301-304,418". Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--icmp-disable-trace-route

Value indicating whether path evaluation with trace route should be disabled. false is default. Allowed values: false, true.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--preferred-ip-version

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.

Accepted values: IPv4, IPv6
--tcp-disable-trace-route

Value indicating whether path evaluation with trace route should be disabled. false is default. Allowed values: false, true.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--tcp-port

The port to connect to.

--tcp-port-behavior

Destination port behavior. Allowed values: ListenIfAvailable, None.

Accepted values: ListenIfAvailable, None
--threshold-failed-percent

The maximum percentage of failed checks permitted for a test to evaluate as successful.

--threshold-round-trip-time

The maximum round-trip time in milliseconds permitted for a test to evaluate as successful.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network watcher connection-monitor test-configuration list

Edit
Preview

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
                                                              --location

Examples

List all test configurations of a connection monitor.

az network watcher connection-monitor test-configuration list --connection-monitor MyConnectionMonitor --location westus2

Required Parameters

--connection-monitor

Connection monitor name.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network watcher connection-monitor test-configuration remove

Edit
Preview

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 MyTCPTestConfiguration

Remove 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 DefaultTestGroup

Required Parameters

--connection-monitor

Connection monitor name.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name --test-configuration-name -n

The name of the connection monitor test configuration.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--test-groups

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
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network watcher connection-monitor test-configuration show

Edit
Preview

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
                                                              --name

Examples

Show a test configuration from a connection monitor.

az network watcher connection-monitor test-configuration show --connection-monitor MyConnectionMonitor --location westus2 --name MyConnectionMonitorTestConfiguration

Required Parameters

--connection-monitor

Connection monitor name.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name --test-configuration-name -n

The name of the connection monitor test configuration.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network watcher connection-monitor test-configuration wait

Edit
Preview

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

Connection monitor name.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

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.

--interval

Polling interval in seconds.

Default value: 30
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
--watcher-name

The name of the Network Watcher resource.

--watcher-rg -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.