NetworkWatchersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:network_watchers> attribute.

Inheritance

builtins.object

NetworkWatchersOperations

Constructor

NetworkWatchersOperations(*args, **kwargs)

Methods

begin_check_connectivity	Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.
begin_delete	Deletes the specified network watcher resource.
begin_get_azure_reachability_report	NOTE: This feature is currently in preview and still being tested for stability. Gets the relative latency score for internet service providers from a specified location to Azure regions.
begin_get_flow_log_status	Queries status of flow log and traffic analytics (optional) on a specified resource.
begin_get_network_configuration_diagnostic	Gets Network Configuration Diagnostic data to help customers understand and debug network behavior. It provides detailed information on what security rules were applied to a specified traffic flow and the result of evaluating these rules. Customers must provide details of a flow like source, destination, protocol, etc. The API returns whether traffic was allowed or denied, the rules evaluated for the specified flow and the evaluation results.
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_list_available_providers	NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region.
begin_set_flow_log_configuration	Configures flow log and traffic analytics (optional) 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.
update_tags	Updates a network watcher tags.

begin_check_connectivity

Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.

begin_check_connectivity(resource_group_name: str, network_watcher_name: str, parameters: _models.ConnectivityParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ConnectivityInformation]

Parameters

Name	Description
resource_group_name Required	str The name of the network watcher resource group. Required.
network_watcher_name Required	str The name of the network watcher resource. Required.
parameters Required	ConnectivityParameters or IO[bytes] Parameters that determine how the connectivity check will be performed. Is either a ConnectivityParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified network watcher resource.

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

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.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_get_azure_reachability_report

NOTE: This feature is currently in preview and still being tested for stability. Gets the relative latency score for internet service providers from a specified location to Azure regions.

begin_get_azure_reachability_report(resource_group_name: str, network_watcher_name: str, parameters: _models.AzureReachabilityReportParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AzureReachabilityReport]

Parameters

Name	Description
resource_group_name Required	str The name of the network watcher resource group. Required.
network_watcher_name Required	str The name of the network watcher resource. Required.
parameters Required	AzureReachabilityReportParameters or IO[bytes] Parameters that determine Azure reachability report configuration. Is either a AzureReachabilityReportParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_get_flow_log_status

Queries status of flow log and traffic analytics (optional) on a specified resource.

begin_get_flow_log_status(resource_group_name: str, network_watcher_name: str, parameters: _models.FlowLogStatusParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.FlowLogInformation]

Parameters

Name	Description
resource_group_name Required	str The name of the network watcher resource group. Required.
network_watcher_name Required	str The name of the network watcher resource. Required.
parameters Required	FlowLogStatusParameters or IO[bytes] Parameters that define a resource to query flow log and traffic analytics (optional) status. Is either a FlowLogStatusParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_get_network_configuration_diagnostic

Gets Network Configuration Diagnostic data to help customers understand and debug network behavior. It provides detailed information on what security rules were applied to a specified traffic flow and the result of evaluating these rules. Customers must provide details of a flow like source, destination, protocol, etc. The API returns whether traffic was allowed or denied, the rules evaluated for the specified flow and the evaluation results.

begin_get_network_configuration_diagnostic(resource_group_name: str, network_watcher_name: str, parameters: _models.NetworkConfigurationDiagnosticParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.NetworkConfigurationDiagnosticResponse]

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.
parameters Required	NetworkConfigurationDiagnosticParameters or IO[bytes] Parameters to get network configuration diagnostic. Is either a NetworkConfigurationDiagnosticParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
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: _models.NextHopParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.NextHopResult]

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.
parameters Required	NextHopParameters or IO[bytes] Parameters that define the source and destination endpoint. Is either a NextHopParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_get_troubleshooting

Initiate troubleshooting on a specified resource.

begin_get_troubleshooting(resource_group_name: str, network_watcher_name: str, parameters: _models.TroubleshootingParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.TroubleshootingResult]

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 resource. Required.
parameters Required	TroubleshootingParameters or IO[bytes] Parameters that define the resource to troubleshoot. Is either a TroubleshootingParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
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: _models.QueryTroubleshootingParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.TroubleshootingResult]

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 resource. Required.
parameters Required	QueryTroubleshootingParameters or IO[bytes] Parameters that define the resource to query the troubleshooting result. Is either a QueryTroubleshootingParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
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: _models.SecurityGroupViewParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.SecurityGroupViewResult]

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.
parameters Required	SecurityGroupViewParameters or IO[bytes] Parameters that define the VM to check security groups for. Is either a SecurityGroupViewParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_list_available_providers

NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region.

begin_list_available_providers(resource_group_name: str, network_watcher_name: str, parameters: _models.AvailableProvidersListParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AvailableProvidersList]

Parameters

Name	Description
resource_group_name Required	str The name of the network watcher resource group. Required.
network_watcher_name Required	str The name of the network watcher resource. Required.
parameters Required	AvailableProvidersListParameters or IO[bytes] Parameters that scope the list of available providers. Is either a AvailableProvidersListParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_set_flow_log_configuration

Configures flow log and traffic analytics (optional) on a specified resource.

begin_set_flow_log_configuration(resource_group_name: str, network_watcher_name: str, parameters: _models.FlowLogInformation, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.FlowLogInformation]

Parameters

Name	Description
resource_group_name Required	str The name of the network watcher resource group. Required.
network_watcher_name Required	str The name of the network watcher resource. Required.
parameters Required	FlowLogInformation or IO[bytes] Parameters that define the configuration of flow log. Is either a FlowLogInformation type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
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: _models.VerificationIPFlowParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VerificationIPFlowResult]

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.
parameters Required	VerificationIPFlowParameters or IO[bytes] Parameters that define the IP flow to be verified. Is either a VerificationIPFlowParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
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: _models.NetworkWatcher, *, content_type: str = 'application/json', **kwargs: Any) -> _models.NetworkWatcher

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.
parameters Required	NetworkWatcher or IO[bytes] Parameters that define the network watcher resource. Is either a NetworkWatcher type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets the specified network watcher by resource group.

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

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.

Returns

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

Exceptions

Type	Description
HttpResponseError

get_topology

Gets the current network topology by resource group.

get_topology(resource_group_name: str, network_watcher_name: str, parameters: _models.TopologyParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Topology

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.
parameters Required	TopologyParameters or IO[bytes] Parameters that define the representation of topology. Is either a TopologyParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Gets all network watchers by resource group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_all

Gets all network watchers by subscription.

list_all(**kwargs: Any) -> Iterable[NetworkWatcher]

Returns

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

Exceptions

Type	Description
HttpResponseError

update_tags

Updates a network watcher tags.

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

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.
parameters Required	TagsObject or IO[bytes] Parameters supplied to update network watcher tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type	Description
NetworkWatcher	NetworkWatcher 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'>