az network watcher connection-monitor endpoint

  • Preview
  • Reference

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

Manage endpoint of a connection monitor.

Commands

Name Description Type Status
az network watcher connection-monitor endpoint add

Add an endpoint to a connection monitor.

 Core Preview
az network watcher connection-monitor endpoint list

List all endpoints from a connection monitor.

 Core Preview
az network watcher connection-monitor endpoint remove

Remove an endpoint from a connection monitor.

 Core Preview
az network watcher connection-monitor endpoint show

Show an endpoint from a connection monitor.

 Core Preview
az network watcher connection-monitor endpoint wait

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

 Core Preview

az network watcher connection-monitor endpoint add

Edit
Preview

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

Add an endpoint to a connection monitor.

az network watcher connection-monitor endpoint add --connection-monitor
                                                   --endpoint-name
                                                   --location
                                                   [--address]
                                                   [--address-exclude]
                                                   [--address-include]
                                                   [--coverage-level {AboveAverage, Average, BelowAverage, Default, Full, Low}]
                                                   [--dest-test-groups]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-id]
                                                   [--source-test-groups]
                                                   [--type {AzureArcVM, AzureSubnet, AzureVM, AzureVMSS, AzureVNet, ExternalAddress, MMAWorkspaceMachine, MMAWorkspaceNetwork}]

Examples

Add an external address as a destination endpoint

az network watcher connection-monitor endpoint add --connection-monitor MyConnectionMonitor --location westus --name MyExternalEndpoint --address "bing.com" --dest-test-groups DefaultTestGroup --type ExternalAddress

Add an Azure VM as a source endpoint

az network watcher connection-monitor endpoint add --connection-monitor MyConnectionMonitor --location westus --name MyVMEndpoint --resource-id MyVMResourceID --source-test-groups DefaultTestGroup --type AzureVM

Add a Subnet as a source endpoint with addresses excluded

az network watcher connection-monitor endpoint add --connection-monitor MyConnectionMonitor --location westus --name MySubnetEndpoint --resource-id MySubnetID --source-test-groups DefaultTestGroup --type AzureSubnet --address-exclude 10.0.0.25 10.0.0.30 --coverage-level BelowAverage

Required Parameters

--connection-monitor

Connection monitor name.

--endpoint-name --name -n

The name of the connection monitor endpoint.

--location -l

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

Optional Parameters

--address

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

--address-exclude

List of address of the endpoint item which needs to be excluded to the endpoint scope. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--address-include

List of address of the endpoint item which needs to be included to the endpoint scope. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--coverage-level

Test coverage for the endpoint. Allowed values: AboveAverage, Average, BelowAverage, Default, Full, Low.

accepted values: AboveAverage, Average, BelowAverage, Default, Full, Low
--dest-test-groups

Space-separated list of names for test group to reference as destination. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-id

Resource ID of the connection monitor endpoint.

--source-test-groups

Space-separated list of names for test group to reference as source. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--type

The endpoint type. Allowed values: AzureArcVM, AzureSubnet, AzureVM, AzureVMSS, AzureVNet, ExternalAddress, MMAWorkspaceMachine, MMAWorkspaceNetwork.

accepted values: AzureArcVM, AzureSubnet, AzureVM, AzureVMSS, AzureVNet, ExternalAddress, MMAWorkspaceMachine, MMAWorkspaceNetwork
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 endpoint list

Edit
Preview

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

List all endpoints from a connection monitor.

az network watcher connection-monitor endpoint list --connection-monitor
                                                    --location

Examples

List all endpoints from a connection monitor.

az network watcher connection-monitor endpoint 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 endpoint remove

Edit
Preview

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

Remove an endpoint from a connection monitor.

az network watcher connection-monitor endpoint remove --connection-monitor
                                                      --endpoint-name
                                                      --location
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--test-groups]

Examples

Remove endpoint from all test groups of a connection monitor

az network watcher connection-monitor endpoint remove --connection-monitor MyConnectionMonitor --location westus --name MyEndpoint

Remove endpoint from two test groups of a connection monitor

az network watcher connection-monitor endpoint remove --connection-monitor MyConnectionMonitor --location westus --name MyEndpoint --test-groups DefaultTestGroup HealthCheckTestGroup

Required Parameters

--connection-monitor

Connection monitor name.

--endpoint-name --name -n

Name of the connection monitor endpoint.

--location -l

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

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 endpoint show

Edit
Preview

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

Show an endpoint from a connection monitor.

az network watcher connection-monitor endpoint show --connection-monitor
                                                    --endpoint-name
                                                    --location

Examples

Show an endpoint from a connection monitor.

az network watcher connection-monitor endpoint show --connection-monitor MyConnectionMonitor --location westus2 --name myconnectionmonitorendpoint --subscription MySubscription

Required Parameters

--connection-monitor

Connection monitor name.

--endpoint-name --name -n

Name of the connection monitor endpoint.

--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 endpoint wait

Edit
Preview

Command group 'az network watcher connection-monitor endpoint' 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 endpoint 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

Name of the network watcher.

--watcher-rg -g

Name of the resource group the watcher is in.

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.