ConnectionMonitorsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:connection_monitors> attribute.

Inheritance

builtins.object

ConnectionMonitorsOperations

Constructor

ConnectionMonitorsOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update a connection monitor.
begin_delete	Deletes the specified connection monitor.
begin_query	Query a snapshot of the most recent connection states.
begin_start	Starts the specified connection monitor.
begin_stop	Stops the specified connection monitor.
get	Gets a connection monitor by name.
list	Lists all connection monitors for the specified Network Watcher.
update_tags	Update tags of the specified connection monitor.

begin_create_or_update

Create or update a connection monitor.

begin_create_or_update(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, parameters: _models.ConnectionMonitor, *, migrate: str | None = None, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ConnectionMonitorResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group containing Network Watcher. Required.
network_watcher_name Required	str The name of the Network Watcher resource. Required.
connection_monitor_name Required	str The name of the connection monitor. Required.
parameters Required	ConnectionMonitor or IO[bytes] Parameters that define the operation to create a connection monitor. Is either a ConnectionMonitor type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
migrate	str Value indicating whether connection monitor V1 should be migrated to V2 format. Default value is None.

Returns

Type	Description
LROPoller[ConnectionMonitorResult]	An instance of LROPoller that returns either ConnectionMonitorResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified connection monitor.

begin_delete(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group containing Network Watcher. Required.
network_watcher_name Required	str The name of the Network Watcher resource. Required.
connection_monitor_name Required	str The name of the connection monitor. Required.

Keyword-Only Parameters

Name	Description
migrate	str Value indicating whether connection monitor V1 should be migrated to V2 format. Default value is None.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_query

Query a snapshot of the most recent connection states.

begin_query(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) -> LROPoller[ConnectionMonitorQueryResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group containing Network Watcher. Required.
network_watcher_name Required	str The name of the Network Watcher resource. Required.
connection_monitor_name Required	str The name given to the connection monitor. Required.

Keyword-Only Parameters

Name	Description
migrate	str Value indicating whether connection monitor V1 should be migrated to V2 format. Default value is None.

Returns

Type	Description
LROPoller[ConnectionMonitorQueryResult]	An instance of LROPoller that returns either ConnectionMonitorQueryResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_start

Starts the specified connection monitor.

begin_start(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group containing Network Watcher. Required.
network_watcher_name Required	str The name of the Network Watcher resource. Required.
connection_monitor_name Required	str The name of the connection monitor. Required.

Keyword-Only Parameters

Name	Description
migrate	str Value indicating whether connection monitor V1 should be migrated to V2 format. Default value is None.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_stop

Stops the specified connection monitor.

begin_stop(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group containing Network Watcher. Required.
network_watcher_name Required	str The name of the Network Watcher resource. Required.
connection_monitor_name Required	str The name of the connection monitor. Required.

Keyword-Only Parameters

Name	Description
migrate	str Value indicating whether connection monitor V1 should be migrated to V2 format. Default value is None.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a connection monitor by name.

get(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, **kwargs: Any) -> ConnectionMonitorResult

Parameters

Name	Description
resource_group_name Required	str The name of the resource group containing Network Watcher. Required.
network_watcher_name Required	str The name of the Network Watcher resource. Required.
connection_monitor_name Required	str The name of the connection monitor. Required.

Keyword-Only Parameters

Name	Description
migrate	str Value indicating whether connection monitor V1 should be migrated to V2 format. Default value is None.

Returns

Type	Description
ConnectionMonitorResult	ConnectionMonitorResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists all connection monitors for the specified Network Watcher.

list(resource_group_name: str, network_watcher_name: str, **kwargs: Any) -> Iterable[ConnectionMonitorResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group containing Network Watcher. Required.
network_watcher_name Required	str The name of the Network Watcher resource. Required.

Keyword-Only Parameters

Name	Description
migrate	str Value indicating whether connection monitor V1 should be migrated to V2 format. Default value is None.

Returns

Type	Description
ItemPaged[ConnectionMonitorResult]	An iterator like instance of either ConnectionMonitorResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_tags

Update tags of the specified connection monitor.

update_tags(resource_group_name: str, network_watcher_name: str, connection_monitor_name: str, parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ConnectionMonitorResult

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_watcher_name Required	str The name of the network watcher. Required.
connection_monitor_name Required	str The name of the connection monitor. Required.
parameters Required	TagsObject or IO[bytes] Parameters supplied to update connection monitor tags. Is either a TagsObject type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
migrate	str Value indicating whether connection monitor V1 should be migrated to V2 format. Default value is None.

Returns

Type	Description
ConnectionMonitorResult	ConnectionMonitorResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>