NetworkWatchersOperations Class

Reference

NetworkWatchersOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance: builtins.object

NetworkWatchersOperations

Constructor

NetworkWatchersOperations(client, config, serializer, deserializer) -> None

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_delete	Deletes the specified network watcher resource.
begin_get_flow_log_status	Queries status of flow log on a specified resource.
begin_get_next_hop	Gets the next hop from the specified VM.
begin_get_troubleshooting	Initiate troubleshooting on a specified resource.
begin_get_troubleshooting_result	Get the last completed troubleshooting result on a specified resource.
begin_get_vm_security_rules	Gets the configured and effective security group rules on the specified VM.
begin_set_flow_log_configuration	Configures flow log on a specified resource.
begin_verify_ip_flow	Verify IP flow from the specified VM to a location given the currently configured NSG rules.
create_or_update	Creates or updates a network watcher in the specified resource group.
get	Gets the specified network watcher by resource group.
get_topology	Gets the current network topology by resource group.
list	Gets all network watchers by resource group.
list_all	Gets all network watchers by subscription.

begin_delete

Deletes the specified network watcher resource.

begin_delete(resource_group_name: str, network_watcher_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name: str

Required

The name of the resource group.

network_watcher_name: str

Required

The name of the network watcher.

cls: callable

Required

A custom type or function that will be passed the direct response

continuation_token: str

Required

A continuation token to restart a poller from a saved state.

polling: bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval: int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_get_flow_log_status

Queries status of flow log on a specified resource.

begin_get_flow_log_status(resource_group_name: str, network_watcher_name: str, parameters: azure.mgmt.network.v2016_09_01.models._models_py3.FlowLogStatusParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.FlowLogInformation')]

Parameters

resource_group_name: str

Required

The name of the network watcher resource group.

network_watcher_name: str

Required

The name of the network watcher resource.

parameters: FlowLogStatusParameters

Required

Parameters that define a resource to query flow log status.

cls: callable

Required

A custom type or function that will be passed the direct response

continuation_token: str

Required

A continuation token to restart a poller from a saved state.

polling: bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval: int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either FlowLogInformation or the result of cls(response)

Return type

AsyncLROPoller[FlowLogInformation]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_get_next_hop

Gets the next hop from the specified VM.

begin_get_next_hop(resource_group_name: str, network_watcher_name: str, parameters: azure.mgmt.network.v2016_09_01.models._models_py3.NextHopParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.NextHopResult')]

Parameters

resource_group_name: str

Required

The name of the resource group.

network_watcher_name: str

Required

The name of the network watcher.

parameters: NextHopParameters

Required

Parameters that define the source and destination endpoint.

cls: callable

Required

A custom type or function that will be passed the direct response

continuation_token: str

Required

A continuation token to restart a poller from a saved state.

polling: bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval: int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either NextHopResult or the result of cls(response)

Return type

AsyncLROPoller[NextHopResult]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_get_troubleshooting

Initiate troubleshooting on a specified resource.

begin_get_troubleshooting(resource_group_name: str, network_watcher_name: str, parameters: azure.mgmt.network.v2016_09_01.models._models_py3.TroubleshootingParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.TroubleshootingResult')]

Parameters

resource_group_name: str

Required

The name of the resource group.

network_watcher_name: str

Required

The name of the network watcher resource.

parameters: TroubleshootingParameters

Required

Parameters that define the resource to troubleshoot.

cls: callable

Required

A custom type or function that will be passed the direct response

continuation_token: str

Required

A continuation token to restart a poller from a saved state.

polling: bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval: int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either TroubleshootingResult or the result of cls(response)

Return type

AsyncLROPoller[TroubleshootingResult]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_get_troubleshooting_result

Get the last completed troubleshooting result on a specified resource.

begin_get_troubleshooting_result(resource_group_name: str, network_watcher_name: str, parameters: azure.mgmt.network.v2016_09_01.models._models_py3.QueryTroubleshootingParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.TroubleshootingResult')]

Parameters

resource_group_name: str

Required

The name of the resource group.

network_watcher_name: str

Required

The name of the network watcher resource.

parameters: QueryTroubleshootingParameters

Required

Parameters that define the resource to query the troubleshooting result.

cls: callable

Required

A custom type or function that will be passed the direct response

continuation_token: str

Required

A continuation token to restart a poller from a saved state.

polling: bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval: int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either TroubleshootingResult or the result of cls(response)

Return type

AsyncLROPoller[TroubleshootingResult]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_get_vm_security_rules

Gets the configured and effective security group rules on the specified VM.

begin_get_vm_security_rules(resource_group_name: str, network_watcher_name: str, parameters: azure.mgmt.network.v2016_09_01.models._models_py3.SecurityGroupViewParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.SecurityGroupViewResult')]

Parameters

resource_group_name: str

Required

The name of the resource group.

network_watcher_name: str

Required

The name of the network watcher.

parameters: SecurityGroupViewParameters

Required

Parameters that define the VM to check security groups for.

cls: callable

Required

A custom type or function that will be passed the direct response

continuation_token: str

Required

A continuation token to restart a poller from a saved state.

polling: bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval: int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either SecurityGroupViewResult or the result of cls(response)

Return type

AsyncLROPoller[SecurityGroupViewResult]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_set_flow_log_configuration

Configures flow log on a specified resource.

begin_set_flow_log_configuration(resource_group_name: str, network_watcher_name: str, parameters: azure.mgmt.network.v2016_09_01.models._models_py3.FlowLogInformation, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.FlowLogInformation')]

Parameters

resource_group_name: str

Required

The name of the network watcher resource group.

network_watcher_name: str

Required

The name of the network watcher resource.

parameters: FlowLogInformation

Required

Parameters that define the configuration of flow log.

cls: callable

Required

A custom type or function that will be passed the direct response

continuation_token: str

Required

A continuation token to restart a poller from a saved state.

polling: bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval: int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either FlowLogInformation or the result of cls(response)

Return type

AsyncLROPoller[FlowLogInformation]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_verify_ip_flow

Verify IP flow from the specified VM to a location given the currently configured NSG rules.

begin_verify_ip_flow(resource_group_name: str, network_watcher_name: str, parameters: azure.mgmt.network.v2016_09_01.models._models_py3.VerificationIPFlowParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VerificationIPFlowResult')]

Parameters

resource_group_name: str

Required

The name of the resource group.

network_watcher_name: str

Required

The name of the network watcher.

parameters: VerificationIPFlowParameters

Required

Parameters that define the IP flow to be verified.

cls: callable

Required

A custom type or function that will be passed the direct response

continuation_token: str

Required

A continuation token to restart a poller from a saved state.

polling: bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval: int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either VerificationIPFlowResult or the result of cls(response)

Return type

AsyncLROPoller[VerificationIPFlowResult]

Exceptions

~azure.core.exceptions.HttpResponseError

create_or_update

Creates or updates a network watcher in the specified resource group.

create_or_update(resource_group_name: str, network_watcher_name: str, parameters: azure.mgmt.network.v2016_09_01.models._models_py3.NetworkWatcher, **kwargs) -> azure.mgmt.network.v2016_09_01.models._models_py3.NetworkWatcher

Parameters

resource_group_name: str

Required

The name of the resource group.

network_watcher_name: str

Required

The name of the network watcher.

parameters: NetworkWatcher

Required

Parameters that define the network watcher resource.

cls: callable

Required

A custom type or function that will be passed the direct response

Returns

NetworkWatcher, or the result of cls(response)

Return type

NetworkWatcher

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets the specified network watcher by resource group.

get(resource_group_name: str, network_watcher_name: str, **kwargs) -> azure.mgmt.network.v2016_09_01.models._models_py3.NetworkWatcher

Parameters

resource_group_name: str

Required

The name of the resource group.

network_watcher_name: str

Required

The name of the network watcher.

cls: callable

Required

A custom type or function that will be passed the direct response

Returns

NetworkWatcher, or the result of cls(response)

Return type

NetworkWatcher

Exceptions

~azure.core.exceptions.HttpResponseError

get_topology

Gets the current network topology by resource group.

get_topology(resource_group_name: str, network_watcher_name: str, parameters: azure.mgmt.network.v2016_09_01.models._models_py3.TopologyParameters, **kwargs) -> azure.mgmt.network.v2016_09_01.models._models_py3.Topology

Parameters

resource_group_name: str

Required

The name of the resource group.

network_watcher_name: str

Required

The name of the network watcher.

parameters: TopologyParameters

Required

Parameters that define the representation of topology.

cls: callable

Required

A custom type or function that will be passed the direct response

Returns

Topology, or the result of cls(response)

Return type

Topology

Exceptions

~azure.core.exceptions.HttpResponseError

list

Gets all network watchers by resource group.

list(resource_group_name: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.NetworkWatcherListResult')]

Parameters

resource_group_name: str

Required

The name of the resource group.

cls: callable

Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either NetworkWatcherListResult or the result of cls(response)

Return type

AsyncItemPaged[NetworkWatcherListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_all

Gets all network watchers by subscription.

list_all(**kwargs) -> typing.AsyncIterable[_ForwardRef('models.NetworkWatcherListResult')]

Parameters

cls: callable

Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either NetworkWatcherListResult or the result of cls(response)

Return type

AsyncItemPaged[NetworkWatcherListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.v2016_09_01.models' from 'c:\\repo\\venv\\lib\\site-packages\\azure\\mgmt\\network\\v2016_09_01\\models\\__init__.py'>

NetworkWatchersOperations Class

Constructor

Parameters

Variables

Methods

begin_delete

Parameters

Returns

Return type

Exceptions

begin_get_flow_log_status

Parameters

Returns

Return type

Exceptions

begin_get_next_hop

Parameters

Returns

Return type

Exceptions

begin_get_troubleshooting

Parameters

Returns

Return type

Exceptions

begin_get_troubleshooting_result

Parameters

Returns

Return type

Exceptions

begin_get_vm_security_rules

Parameters

Returns

Return type

Exceptions

begin_set_flow_log_configuration

Parameters

Returns

Return type

Exceptions

begin_verify_ip_flow

Parameters

Returns

Return type

Exceptions

create_or_update

Parameters

Returns

Return type

Exceptions

get

Parameters

Returns

Return type

Exceptions

get_topology

Parameters

Returns

Return type

Exceptions

list

Parameters

Returns

Return type

Exceptions

list_all

Parameters

Returns

Return type

Exceptions

Attributes

models

Feedback