Share via

az network watcher connection-monitor test-group

  • Preview

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage a test group of a connection monitor.

Commands

Name Description Type Status
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.

 Core Preview
az network watcher connection-monitor test-group list

List all test groups of a connection monitor.

 Core Preview
az network watcher connection-monitor test-group remove

Remove test group from a connection monitor.

 Core Preview
az network watcher connection-monitor test-group show

Show a test group of a connection monitor.

 Core Preview
az network watcher connection-monitor test-group wait

Place the CLI in a waiting state until a condition is met.

 Core Preview

az network watcher connection-monitor test-group add

Edit
Preview

Command group 'network watcher connection-monitor test-group' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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-group-name
                                                     --test-config-name
                                                     [--disable {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--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 {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--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}]
                                                     [--protocol {Http, Icmp, Tcp}]
                                                     [--tcp-disable-trace-route {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--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.

Property Value
Parameter group: V2 Endpoint Arguments
--endpoint-source-name

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

Property Value
Parameter group: V2 Endpoint Arguments
--location -l

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

--name --test-group-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.

Property Value
Parameter group: V2 Test Configuration Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable

Value indicating whether test group is disabled. false is default. Allowed values: false, true.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--endpoint-dest-address

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

Property Value
Parameter group: V2 Endpoint Arguments
--endpoint-dest-resource-id

Resource ID of the destination of connection monitor endpoint.

Property Value
Parameter group: V2 Endpoint Arguments
--endpoint-source-address

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

Property Value
Parameter group: V2 Endpoint Arguments
--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.

Property Value
Parameter group: V2 Endpoint Arguments
--frequency

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

Property Value
Parameter group: V2 Test Configuration Arguments
--http-method

The HTTP method to use.

Property Value
Parameter group: V2 Test Configuration Arguments
Accepted values: Get, Post
--http-path

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

Property Value
Parameter group: V2 Test Configuration Arguments
--http-port

The port to connect to.

Property Value
Parameter group: V2 Test Configuration Arguments
--http-valid-status-codes

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

Property Value
Parameter group: V2 Test Configuration Arguments
--https-prefer

Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. Allowed values: false, true.

Property Value
Parameter group: V2 Test Configuration Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--icmp-disable-trace-route

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

Property Value
Parameter group: V2 Test Configuration Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--no-wait

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

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

Property Value
Parameter group: V2 Test Configuration Arguments
Accepted values: IPv4, IPv6
--protocol

The protocol to use in test evaluation.

Property Value
Parameter group: V2 Test Configuration Arguments
Accepted values: Http, Icmp, Tcp
--tcp-disable-trace-route

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

Property Value
Parameter group: V2 Test Configuration Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--tcp-port

The port to connect to.

Property Value
Parameter group: V2 Test Configuration Arguments
--threshold-failed-percent

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

Property Value
Parameter group: V2 Test Configuration Arguments
--threshold-round-trip-time

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

Property Value
Parameter group: V2 Test Configuration Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network watcher connection-monitor test-group list

Edit
Preview

Command group 'network watcher connection-monitor test-group' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all test groups of a connection monitor.

az network watcher connection-monitor test-group list --connection-monitor
                                                      --location

Examples

List all test groups of a connection monitor.

az network watcher connection-monitor test-group 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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network watcher connection-monitor test-group remove

Edit
Preview

Command group 'network watcher connection-monitor test-group' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove test group from a connection monitor.

az network watcher connection-monitor test-group remove --connection-monitor
                                                        --location
                                                        --name

Examples

Remove test group from a connection monitor.

az network watcher connection-monitor test-group remove --connection-monitor MyConnectionMonitor --location westus2 --name MyConnectionMonitorTestGroup

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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network watcher connection-monitor test-group show

Edit
Preview

Command group 'network watcher connection-monitor test-group' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show a test group of a connection monitor.

az network watcher connection-monitor test-group show --connection-monitor
                                                      --location
                                                      --name --test-group-name

Examples

Show a test group of a connection monitor.

az network watcher connection-monitor test-group show --connection-monitor MyConnectionMonitor --location westus2 --name MyConnectionMonitorTestGroup --subscription MySubscription

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

The name of the connection monitor test group.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network watcher connection-monitor test-group wait

Edit
Preview

Command group 'network watcher connection-monitor test-group' 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-group wait [--connection-monitor]
                                                      [--created]
                                                      [--custom]
                                                      [--deleted]
                                                      [--exists]
                                                      [--ids]
                                                      [--interval]
                                                      [--subscription]
                                                      [--timeout]
                                                      [--updated]
                                                      [--watcher-name]
                                                      [--watcher-rg]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-monitor

Connection monitor name.

Property Value
Parameter group: Resource Id Arguments
--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--watcher-name

The name of the Network Watcher resource.

Property Value
Parameter group: Resource Id Arguments
--watcher-rg -g

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False