ConnectionMonitors interface

Package:

@azure/arm-network

Interface representing a ConnectionMonitors.

Methods

beginCreateOrUpdate(string, string, string, ConnectionMonitor, ConnectionMonitorsCreateOrUpdateOptionalParams)	Create or update a connection monitor.
beginCreateOrUpdateAndWait(string, string, string, ConnectionMonitor, ConnectionMonitorsCreateOrUpdateOptionalParams)	Create or update a connection monitor.
beginDelete(string, string, string, ConnectionMonitorsDeleteOptionalParams)	Deletes the specified connection monitor.
beginDeleteAndWait(string, string, string, ConnectionMonitorsDeleteOptionalParams)	Deletes the specified connection monitor.
beginQuery(string, string, string, ConnectionMonitorsQueryOptionalParams)	Query a snapshot of the most recent connection states.
beginQueryAndWait(string, string, string, ConnectionMonitorsQueryOptionalParams)	Query a snapshot of the most recent connection states.
beginStart(string, string, string, ConnectionMonitorsStartOptionalParams)	Starts the specified connection monitor.
beginStartAndWait(string, string, string, ConnectionMonitorsStartOptionalParams)	Starts the specified connection monitor.
beginStop(string, string, string, ConnectionMonitorsStopOptionalParams)	Stops the specified connection monitor.
beginStopAndWait(string, string, string, ConnectionMonitorsStopOptionalParams)	Stops the specified connection monitor.
get(string, string, string, ConnectionMonitorsGetOptionalParams)	Gets a connection monitor by name.
list(string, string, ConnectionMonitorsListOptionalParams)	Lists all connection monitors for the specified Network Watcher.
updateTags(string, string, string, TagsObject, ConnectionMonitorsUpdateTagsOptionalParams)	Update tags of the specified connection monitor.

Method Details

beginCreateOrUpdate(string, string, string, ConnectionMonitor, ConnectionMonitorsCreateOrUpdateOptionalParams)

Create or update a connection monitor.

function beginCreateOrUpdate(resourceGroupName: string, networkWatcherName: string, connectionMonitorName: string, parameters: ConnectionMonitor, options?: ConnectionMonitorsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ConnectionMonitorResult>, ConnectionMonitorResult>>

Parameters

resourceGroupName

string

The name of the resource group containing Network Watcher.

networkWatcherName

string

The name of the Network Watcher resource.

connectionMonitorName

string

The name of the connection monitor.

parameters

ConnectionMonitor

Parameters that define the operation to create a connection monitor.

options

ConnectionMonitorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ConnectionMonitorResult>, ConnectionMonitorResult>>

beginCreateOrUpdateAndWait(string, string, string, ConnectionMonitor, ConnectionMonitorsCreateOrUpdateOptionalParams)

Create or update a connection monitor.

function beginCreateOrUpdateAndWait(resourceGroupName: string, networkWatcherName: string, connectionMonitorName: string, parameters: ConnectionMonitor, options?: ConnectionMonitorsCreateOrUpdateOptionalParams): Promise<ConnectionMonitorResult>

Parameters

resourceGroupName

string

The name of the resource group containing Network Watcher.

networkWatcherName

string

The name of the Network Watcher resource.

connectionMonitorName

string

The name of the connection monitor.

parameters

ConnectionMonitor

Parameters that define the operation to create a connection monitor.

options

ConnectionMonitorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ConnectionMonitorResult>

beginDelete(string, string, string, ConnectionMonitorsDeleteOptionalParams)

Deletes the specified connection monitor.

function beginDelete(resourceGroupName: string, networkWatcherName: string, connectionMonitorName: string, options?: ConnectionMonitorsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group containing Network Watcher.

networkWatcherName

string

The name of the Network Watcher resource.

connectionMonitorName

string

The name of the connection monitor.

options

ConnectionMonitorsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, ConnectionMonitorsDeleteOptionalParams)

Deletes the specified connection monitor.

function beginDeleteAndWait(resourceGroupName: string, networkWatcherName: string, connectionMonitorName: string, options?: ConnectionMonitorsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group containing Network Watcher.

networkWatcherName

string

The name of the Network Watcher resource.

connectionMonitorName

string

The name of the connection monitor.

options

ConnectionMonitorsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginQuery(string, string, string, ConnectionMonitorsQueryOptionalParams)

Query a snapshot of the most recent connection states.

function beginQuery(resourceGroupName: string, networkWatcherName: string, connectionMonitorName: string, options?: ConnectionMonitorsQueryOptionalParams): Promise<SimplePollerLike<OperationState<ConnectionMonitorQueryResult>, ConnectionMonitorQueryResult>>

Parameters

resourceGroupName

string

The name of the resource group containing Network Watcher.

networkWatcherName

string

The name of the Network Watcher resource.

connectionMonitorName

string

The name given to the connection monitor.

options

ConnectionMonitorsQueryOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ConnectionMonitorQueryResult>, ConnectionMonitorQueryResult>>

beginQueryAndWait(string, string, string, ConnectionMonitorsQueryOptionalParams)

Query a snapshot of the most recent connection states.

function beginQueryAndWait(resourceGroupName: string, networkWatcherName: string, connectionMonitorName: string, options?: ConnectionMonitorsQueryOptionalParams): Promise<ConnectionMonitorQueryResult>

Parameters

resourceGroupName

string

The name of the resource group containing Network Watcher.

networkWatcherName

string

The name of the Network Watcher resource.

connectionMonitorName

string

The name given to the connection monitor.

options

ConnectionMonitorsQueryOptionalParams

The options parameters.

Returns

Promise<ConnectionMonitorQueryResult>

beginStart(string, string, string, ConnectionMonitorsStartOptionalParams)

Starts the specified connection monitor.

function beginStart(resourceGroupName: string, networkWatcherName: string, connectionMonitorName: string, options?: ConnectionMonitorsStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group containing Network Watcher.

networkWatcherName

string

The name of the Network Watcher resource.

connectionMonitorName

string

The name of the connection monitor.

options

ConnectionMonitorsStartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartAndWait(string, string, string, ConnectionMonitorsStartOptionalParams)

Starts the specified connection monitor.

function beginStartAndWait(resourceGroupName: string, networkWatcherName: string, connectionMonitorName: string, options?: ConnectionMonitorsStartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group containing Network Watcher.

networkWatcherName

string

The name of the Network Watcher resource.

connectionMonitorName

string

The name of the connection monitor.

options

ConnectionMonitorsStartOptionalParams

The options parameters.

Returns

Promise<void>

beginStop(string, string, string, ConnectionMonitorsStopOptionalParams)

Stops the specified connection monitor.

function beginStop(resourceGroupName: string, networkWatcherName: string, connectionMonitorName: string, options?: ConnectionMonitorsStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group containing Network Watcher.

networkWatcherName

string

The name of the Network Watcher resource.

connectionMonitorName

string

The name of the connection monitor.

options

ConnectionMonitorsStopOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStopAndWait(string, string, string, ConnectionMonitorsStopOptionalParams)

Stops the specified connection monitor.

function beginStopAndWait(resourceGroupName: string, networkWatcherName: string, connectionMonitorName: string, options?: ConnectionMonitorsStopOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group containing Network Watcher.

networkWatcherName

string

The name of the Network Watcher resource.

connectionMonitorName

string

The name of the connection monitor.

options

ConnectionMonitorsStopOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ConnectionMonitorsGetOptionalParams)

Gets a connection monitor by name.

function get(resourceGroupName: string, networkWatcherName: string, connectionMonitorName: string, options?: ConnectionMonitorsGetOptionalParams): Promise<ConnectionMonitorResult>

Parameters

resourceGroupName

string

The name of the resource group containing Network Watcher.

networkWatcherName

string

The name of the Network Watcher resource.

connectionMonitorName

string

The name of the connection monitor.

options

ConnectionMonitorsGetOptionalParams

The options parameters.

Returns

Promise<ConnectionMonitorResult>

list(string, string, ConnectionMonitorsListOptionalParams)

Lists all connection monitors for the specified Network Watcher.

function list(resourceGroupName: string, networkWatcherName: string, options?: ConnectionMonitorsListOptionalParams): PagedAsyncIterableIterator<ConnectionMonitorResult, ConnectionMonitorResult[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group containing Network Watcher.

networkWatcherName

string

The name of the Network Watcher resource.

options

ConnectionMonitorsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ConnectionMonitorResult, ConnectionMonitorResult[], PageSettings>

updateTags(string, string, string, TagsObject, ConnectionMonitorsUpdateTagsOptionalParams)

Update tags of the specified connection monitor.

function updateTags(resourceGroupName: string, networkWatcherName: string, connectionMonitorName: string, parameters: TagsObject, options?: ConnectionMonitorsUpdateTagsOptionalParams): Promise<ConnectionMonitorResult>

Parameters

resourceGroupName

string

The name of the resource group.

networkWatcherName

string

The name of the network watcher.

connectionMonitorName

string

The name of the connection monitor.

parameters

TagsObject

Parameters supplied to update connection monitor tags.

options

ConnectionMonitorsUpdateTagsOptionalParams

The options parameters.

Returns

Promise<ConnectionMonitorResult>