az network watcher connection-monitor endpoint

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage endpoint of a connection monitor.

Commands

az network watcher connection-monitor endpoint add	Add an endpoint to a connection monitor.
az network watcher connection-monitor endpoint list	List all endpoints form a connection monitor.
az network watcher connection-monitor endpoint remove	Remove an endpoint from a connection monitor.
az network watcher connection-monitor endpoint show	Show an endpoint from a connection monitor.

az network watcher connection-monitor endpoint add

Add an endpoint to a connection monitor.

az network watcher connection-monitor endpoint add --connection-monitor
                                                   --location
                                                   --name
                                                   [--address]
                                                   [--address-exclude]
                                                   [--address-include]
                                                   [--coverage-level {AboveAverage, Average, BelowAverage, Default, Full, Low}]
                                                   [--dest-test-groups]
                                                   [--filter-item]
                                                   [--filter-type {Include}]
                                                   [--resource-id]
                                                   [--source-test-groups]
                                                   [--type {AzureSubnet, AzureVM, 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.

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

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 included to the endpoint scope.

--address-include

List of address of the endpoint item which needs to be included to the endpoint scope.

--coverage-level

Test coverage for the endpoint.

accepted values: AboveAverage, Average, BelowAverage, Default, Full, Low

--dest-test-groups

Space-separated list of names for test group to reference as destination.

--filter-item

List of property=value pairs to define filter items. Property currently include: type, address. Property value of type supports 'AgentAddress' only now.

--filter-type

The behavior of the endpoint filter. Currently only 'Include' is supported.

accepted values: Include

--resource-id

Resource ID of the connection monitor endpoint.

--source-test-groups

Space-separated list of names for test group to reference as source.

--type

The endpoint type.

accepted values: AzureSubnet, AzureVM, 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.

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

List all endpoints form a connection monitor.

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

Examples

List all endpoints form a connection monitor. (autogenerated)

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.

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

Remove an endpoint from a connection monitor.

az network watcher connection-monitor endpoint remove --connection-monitor
                                                      --location
                                                      --name
                                                      [--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.

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

Optional Parameters

--test-groups

Space-separated list of names of test group which only need to be affected if specified.

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.

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

Show an endpoint from a connection monitor.

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

Examples

Show an endpoint from a connection monitor. (autogenerated)

az network watcher connection-monitor endpoint show --connection-monitor MyConnectionMonitor --location westus2 --name myconnectionmonitorendpoint --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 -n

The name of the connection monitor endpoint.

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.

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