az network watcher connection-monitor test-group

Manage a test group of a connection monitor.

Commands

az network watcher connection-monitor test-group add

Add a test group along with new-added/existing endpoint and test configuration to a connection monitor.

az network watcher connection-monitor test-group list

List all test groups of a connection monitor.

az network watcher connection-monitor test-group remove

Remove test group from a connection monitor.

az network watcher connection-monitor test-group show

Show a test group of a connection monitor.

az network watcher connection-monitor test-group add

Add a test group along with new-added/existing endpoint and test configuration to a connection monitor.

az network watcher connection-monitor test-group add --connection-monitor
                                                     --endpoint-dest-name
                                                     --endpoint-source-name
                                                     --location
                                                     --name
                                                     --test-config-name
                                                     [--disable {false, true}]
                                                     [--endpoint-dest-address]
                                                     [--endpoint-dest-resource-id]
                                                     [--endpoint-source-address]
                                                     [--endpoint-source-resource-id]
                                                     [--frequency]
                                                     [--http-method {Get, Post}]
                                                     [--http-path]
                                                     [--http-port]
                                                     [--http-valid-status-codes]
                                                     [--https-prefer {false, true}]
                                                     [--icmp-disable-trace-route {false, true}]
                                                     [--preferred-ip-version {IPv4, IPv6}]
                                                     [--protocol {Http, Icmp, Tcp}]
                                                     [--subscription]
                                                     [--tcp-disable-trace-route {false, true}]
                                                     [--tcp-port]
                                                     [--threshold-failed-percent]
                                                     [--threshold-round-trip-time]

Examples

Add a test group along with existing endpoint and test configuration via their names

az network watcher connection-monitor test-group add --connection-monitor MyConnectionMonitor --location westus --name MyHTTPTestGroup --endpoint-source-name MySourceEndpoint --endpoint-dest-name MyDestinationEndpoint --test-config-name MyTestConfiguration

Add a test group long with new-added source endpoint and existing test configuration via its name

az network watcher connection-monitor test-group add --connection-monitor MyConnectionMonitor --location westus --name MyAccessibilityTestGroup --endpoint-source-name MySourceEndpoint --endpoint-source-resource-id MyLogAnalysisWorkspaceID --endpoint-dest-name MyExistingDestinationEndpoint --test-config-name MyExistingTestConfiguration

Add a test group along with new-added endpoints and test configuration

az network watcher connection-monitor test-group add --connection-monitor MyConnectionMonitor --location westus --name MyAccessibilityTestGroup --endpoint-source-name MySourceEndpoint --endpoint-source-resource-id MyVMResourceID --endpoint-dest-name bing --endpoint-dest-address bing.com --test-config-name MyNewTestConfiguration --protocol Tcp --tcp-port 4096

Required Parameters

--connection-monitor

Connection monitor name.

--endpoint-dest-name

The name of the destination of connection monitor endpoint. If you are creating a V2 Connection Monitor, it's required.

--endpoint-source-name

The name of the source of connection monitor endpoint. If you are creating a V2 Connection Monitor, it's required.

--location -l

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

--name -n

The name of the connection monitor test group.

--test-config-name

The name of the connection monitor test configuration. If you are creating a V2 Connection Monitor, it's required.

Optional Parameters

--disable

Value indicating whether test group is disabled. false is default.

accepted values: false, true
--endpoint-dest-address

Address of the destination of connection monitor endpoint (IP or domain name).

--endpoint-dest-resource-id

Resource ID of the destination of connection monitor endpoint.

--endpoint-source-address

Address of the source of connection monitor endpoint (IP or domain name).

--endpoint-source-resource-id

Resource ID of the source of connection monitor endpoint. If endpoint is intended to used as source, this option is required.

--frequency

The frequency of test evaluation, in seconds.

default value: 60
--http-method

The HTTP method to use.

accepted values: Get, Post
--http-path

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

--http-port

The port to connect to.

--http-valid-status-codes

Space-separated list of HTTP status codes to consider successful. For instance, "2xx 301-304 418".

--https-prefer

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

accepted values: false, true
--icmp-disable-trace-route

Value indicating whether path evaluation with trace route should be disabled. false is default.

accepted values: false, true
--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.

accepted values: IPv4, IPv6
--protocol

The protocol to use in test evaluation.

accepted values: Http, Icmp, Tcp
--subscription

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

--tcp-disable-trace-route

Value indicating whether path evaluation with trace route should be disabled. false is default.

accepted values: false, true
--tcp-port

The port to connect to.

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

az network watcher connection-monitor test-group list

List all test groups of a connection monitor.

az network watcher connection-monitor test-group list --connection-monitor
                                                      --location
                                                      [--query-examples]
                                                      [--subscription]

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az network watcher connection-monitor test-group remove

Remove test group from a connection monitor.

az network watcher connection-monitor test-group remove --connection-monitor
                                                        --location
                                                        --name
                                                        [--subscription]

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

The name of the connection monitor test group.

Optional Parameters

--subscription

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

az network watcher connection-monitor test-group show

Show a test group of a connection monitor.

az network watcher connection-monitor test-group show --connection-monitor
                                                      --location
                                                      --name
                                                      [--query-examples]
                                                      [--subscription]

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

The name of the connection monitor test group.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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