NetworkWatchers interface
Interface representing a NetworkWatchers.
Methods
| begin |
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 |
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 |
Deletes the specified network watcher resource. |
| begin |
Deletes the specified network watcher resource. |
| begin |
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 |
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 |
Queries status of flow log and traffic analytics (optional) on a specified resource. |
| begin |
Queries status of flow log and traffic analytics (optional) on a specified resource. |
| begin |
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 |
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 |
Gets the next hop from the specified VM. |
| begin |
Gets the next hop from the specified VM. |
| begin |
Initiate troubleshooting on a specified resource. |
| begin |
Initiate troubleshooting on a specified resource. |
| begin |
Get the last completed troubleshooting result on a specified resource. |
| begin |
Get the last completed troubleshooting result on a specified resource. |
| begin |
Gets the configured and effective security group rules on the specified VM. |
| begin |
Gets the configured and effective security group rules on the specified VM. |
| begin |
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 |
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 |
Configures flow log and traffic analytics (optional) on a specified resource. |
| begin |
Configures flow log and traffic analytics (optional) on a specified resource. |
| begin |
Verify IP flow from the specified VM to a location given the currently configured NSG rules. |
| begin |
Verify IP flow from the specified VM to a location given the currently configured NSG rules. |
| create |
Creates or updates a network watcher in the specified resource group. |
| get(string, string, Network |
Gets the specified network watcher by resource group. |
| get |
Gets the current network topology by resource group. |
| list(string, Network |
Gets all network watchers by resource group. |
| list |
Gets all network watchers by subscription. |
| update |
Updates a network watcher tags. |
Method Details
beginCheckConnectivity(string, string, ConnectivityParameters, NetworkWatchersCheckConnectivityOptionalParams)
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.
function beginCheckConnectivity(resourceGroupName: string, networkWatcherName: string, parameters: ConnectivityParameters, options?: NetworkWatchersCheckConnectivityOptionalParams): Promise<SimplePollerLike<OperationState<ConnectivityInformation>, ConnectivityInformation>>Parameters
- resourceGroupName
-
string
The name of the network watcher resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- ConnectivityParameters
Parameters that determine how the connectivity check will be performed.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ConnectivityInformation>, ConnectivityInformation>>
beginCheckConnectivityAndWait(string, string, ConnectivityParameters, NetworkWatchersCheckConnectivityOptionalParams)
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.
function beginCheckConnectivityAndWait(resourceGroupName: string, networkWatcherName: string, parameters: ConnectivityParameters, options?: NetworkWatchersCheckConnectivityOptionalParams): Promise<ConnectivityInformation>Parameters
- resourceGroupName
-
string
The name of the network watcher resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- ConnectivityParameters
Parameters that determine how the connectivity check will be performed.
The options parameters.
Returns
Promise<ConnectivityInformation>
beginDelete(string, string, NetworkWatchersDeleteOptionalParams)
Deletes the specified network watcher resource.
function beginDelete(resourceGroupName: string, networkWatcherName: string, options?: NetworkWatchersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, NetworkWatchersDeleteOptionalParams)
Deletes the specified network watcher resource.
function beginDeleteAndWait(resourceGroupName: string, networkWatcherName: string, options?: NetworkWatchersDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
The options parameters.
Returns
Promise<void>
beginGetAzureReachabilityReport(string, string, AzureReachabilityReportParameters, NetworkWatchersGetAzureReachabilityReportOptionalParams)
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.
function beginGetAzureReachabilityReport(resourceGroupName: string, networkWatcherName: string, parameters: AzureReachabilityReportParameters, options?: NetworkWatchersGetAzureReachabilityReportOptionalParams): Promise<SimplePollerLike<OperationState<AzureReachabilityReport>, AzureReachabilityReport>>Parameters
- resourceGroupName
-
string
The name of the network watcher resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- AzureReachabilityReportParameters
Parameters that determine Azure reachability report configuration.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AzureReachabilityReport>, AzureReachabilityReport>>
beginGetAzureReachabilityReportAndWait(string, string, AzureReachabilityReportParameters, NetworkWatchersGetAzureReachabilityReportOptionalParams)
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.
function beginGetAzureReachabilityReportAndWait(resourceGroupName: string, networkWatcherName: string, parameters: AzureReachabilityReportParameters, options?: NetworkWatchersGetAzureReachabilityReportOptionalParams): Promise<AzureReachabilityReport>Parameters
- resourceGroupName
-
string
The name of the network watcher resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- AzureReachabilityReportParameters
Parameters that determine Azure reachability report configuration.
The options parameters.
Returns
Promise<AzureReachabilityReport>
beginGetFlowLogStatus(string, string, FlowLogStatusParameters, NetworkWatchersGetFlowLogStatusOptionalParams)
Queries status of flow log and traffic analytics (optional) on a specified resource.
function beginGetFlowLogStatus(resourceGroupName: string, networkWatcherName: string, parameters: FlowLogStatusParameters, options?: NetworkWatchersGetFlowLogStatusOptionalParams): Promise<SimplePollerLike<OperationState<FlowLogInformation>, FlowLogInformation>>Parameters
- resourceGroupName
-
string
The name of the network watcher resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- FlowLogStatusParameters
Parameters that define a resource to query flow log and traffic analytics (optional) status.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<FlowLogInformation>, FlowLogInformation>>
beginGetFlowLogStatusAndWait(string, string, FlowLogStatusParameters, NetworkWatchersGetFlowLogStatusOptionalParams)
Queries status of flow log and traffic analytics (optional) on a specified resource.
function beginGetFlowLogStatusAndWait(resourceGroupName: string, networkWatcherName: string, parameters: FlowLogStatusParameters, options?: NetworkWatchersGetFlowLogStatusOptionalParams): Promise<FlowLogInformation>Parameters
- resourceGroupName
-
string
The name of the network watcher resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- FlowLogStatusParameters
Parameters that define a resource to query flow log and traffic analytics (optional) status.
The options parameters.
Returns
Promise<FlowLogInformation>
beginGetNetworkConfigurationDiagnostic(string, string, NetworkConfigurationDiagnosticParameters, NetworkWatchersGetNetworkConfigurationDiagnosticOptionalParams)
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.
function beginGetNetworkConfigurationDiagnostic(resourceGroupName: string, networkWatcherName: string, parameters: NetworkConfigurationDiagnosticParameters, options?: NetworkWatchersGetNetworkConfigurationDiagnosticOptionalParams): Promise<SimplePollerLike<OperationState<NetworkConfigurationDiagnosticResponse>, NetworkConfigurationDiagnosticResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
- parameters
- NetworkConfigurationDiagnosticParameters
Parameters to get network configuration diagnostic.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<NetworkConfigurationDiagnosticResponse>, NetworkConfigurationDiagnosticResponse>>
beginGetNetworkConfigurationDiagnosticAndWait(string, string, NetworkConfigurationDiagnosticParameters, NetworkWatchersGetNetworkConfigurationDiagnosticOptionalParams)
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.
function beginGetNetworkConfigurationDiagnosticAndWait(resourceGroupName: string, networkWatcherName: string, parameters: NetworkConfigurationDiagnosticParameters, options?: NetworkWatchersGetNetworkConfigurationDiagnosticOptionalParams): Promise<NetworkConfigurationDiagnosticResponse>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
- parameters
- NetworkConfigurationDiagnosticParameters
Parameters to get network configuration diagnostic.
The options parameters.
Returns
beginGetNextHop(string, string, NextHopParameters, NetworkWatchersGetNextHopOptionalParams)
Gets the next hop from the specified VM.
function beginGetNextHop(resourceGroupName: string, networkWatcherName: string, parameters: NextHopParameters, options?: NetworkWatchersGetNextHopOptionalParams): Promise<SimplePollerLike<OperationState<NextHopResult>, NextHopResult>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
- parameters
- NextHopParameters
Parameters that define the source and destination endpoint.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<NextHopResult>, NextHopResult>>
beginGetNextHopAndWait(string, string, NextHopParameters, NetworkWatchersGetNextHopOptionalParams)
Gets the next hop from the specified VM.
function beginGetNextHopAndWait(resourceGroupName: string, networkWatcherName: string, parameters: NextHopParameters, options?: NetworkWatchersGetNextHopOptionalParams): Promise<NextHopResult>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
- parameters
- NextHopParameters
Parameters that define the source and destination endpoint.
The options parameters.
Returns
Promise<NextHopResult>
beginGetTroubleshooting(string, string, TroubleshootingParameters, NetworkWatchersGetTroubleshootingOptionalParams)
Initiate troubleshooting on a specified resource.
function beginGetTroubleshooting(resourceGroupName: string, networkWatcherName: string, parameters: TroubleshootingParameters, options?: NetworkWatchersGetTroubleshootingOptionalParams): Promise<SimplePollerLike<OperationState<TroubleshootingResult>, TroubleshootingResult>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- TroubleshootingParameters
Parameters that define the resource to troubleshoot.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<TroubleshootingResult>, TroubleshootingResult>>
beginGetTroubleshootingAndWait(string, string, TroubleshootingParameters, NetworkWatchersGetTroubleshootingOptionalParams)
Initiate troubleshooting on a specified resource.
function beginGetTroubleshootingAndWait(resourceGroupName: string, networkWatcherName: string, parameters: TroubleshootingParameters, options?: NetworkWatchersGetTroubleshootingOptionalParams): Promise<TroubleshootingResult>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- TroubleshootingParameters
Parameters that define the resource to troubleshoot.
The options parameters.
Returns
Promise<TroubleshootingResult>
beginGetTroubleshootingResult(string, string, QueryTroubleshootingParameters, NetworkWatchersGetTroubleshootingResultOptionalParams)
Get the last completed troubleshooting result on a specified resource.
function beginGetTroubleshootingResult(resourceGroupName: string, networkWatcherName: string, parameters: QueryTroubleshootingParameters, options?: NetworkWatchersGetTroubleshootingResultOptionalParams): Promise<SimplePollerLike<OperationState<TroubleshootingResult>, TroubleshootingResult>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- QueryTroubleshootingParameters
Parameters that define the resource to query the troubleshooting result.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<TroubleshootingResult>, TroubleshootingResult>>
beginGetTroubleshootingResultAndWait(string, string, QueryTroubleshootingParameters, NetworkWatchersGetTroubleshootingResultOptionalParams)
Get the last completed troubleshooting result on a specified resource.
function beginGetTroubleshootingResultAndWait(resourceGroupName: string, networkWatcherName: string, parameters: QueryTroubleshootingParameters, options?: NetworkWatchersGetTroubleshootingResultOptionalParams): Promise<TroubleshootingResult>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- QueryTroubleshootingParameters
Parameters that define the resource to query the troubleshooting result.
The options parameters.
Returns
Promise<TroubleshootingResult>
beginGetVMSecurityRules(string, string, SecurityGroupViewParameters, NetworkWatchersGetVMSecurityRulesOptionalParams)
Gets the configured and effective security group rules on the specified VM.
function beginGetVMSecurityRules(resourceGroupName: string, networkWatcherName: string, parameters: SecurityGroupViewParameters, options?: NetworkWatchersGetVMSecurityRulesOptionalParams): Promise<SimplePollerLike<OperationState<SecurityGroupViewResult>, SecurityGroupViewResult>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
- parameters
- SecurityGroupViewParameters
Parameters that define the VM to check security groups for.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<SecurityGroupViewResult>, SecurityGroupViewResult>>
beginGetVMSecurityRulesAndWait(string, string, SecurityGroupViewParameters, NetworkWatchersGetVMSecurityRulesOptionalParams)
Gets the configured and effective security group rules on the specified VM.
function beginGetVMSecurityRulesAndWait(resourceGroupName: string, networkWatcherName: string, parameters: SecurityGroupViewParameters, options?: NetworkWatchersGetVMSecurityRulesOptionalParams): Promise<SecurityGroupViewResult>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
- parameters
- SecurityGroupViewParameters
Parameters that define the VM to check security groups for.
The options parameters.
Returns
Promise<SecurityGroupViewResult>
beginListAvailableProviders(string, string, AvailableProvidersListParameters, NetworkWatchersListAvailableProvidersOptionalParams)
NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region.
function beginListAvailableProviders(resourceGroupName: string, networkWatcherName: string, parameters: AvailableProvidersListParameters, options?: NetworkWatchersListAvailableProvidersOptionalParams): Promise<SimplePollerLike<OperationState<AvailableProvidersList>, AvailableProvidersList>>Parameters
- resourceGroupName
-
string
The name of the network watcher resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- AvailableProvidersListParameters
Parameters that scope the list of available providers.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AvailableProvidersList>, AvailableProvidersList>>
beginListAvailableProvidersAndWait(string, string, AvailableProvidersListParameters, NetworkWatchersListAvailableProvidersOptionalParams)
NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region.
function beginListAvailableProvidersAndWait(resourceGroupName: string, networkWatcherName: string, parameters: AvailableProvidersListParameters, options?: NetworkWatchersListAvailableProvidersOptionalParams): Promise<AvailableProvidersList>Parameters
- resourceGroupName
-
string
The name of the network watcher resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- AvailableProvidersListParameters
Parameters that scope the list of available providers.
The options parameters.
Returns
Promise<AvailableProvidersList>
beginSetFlowLogConfiguration(string, string, FlowLogInformation, NetworkWatchersSetFlowLogConfigurationOptionalParams)
Configures flow log and traffic analytics (optional) on a specified resource.
function beginSetFlowLogConfiguration(resourceGroupName: string, networkWatcherName: string, parameters: FlowLogInformation, options?: NetworkWatchersSetFlowLogConfigurationOptionalParams): Promise<SimplePollerLike<OperationState<FlowLogInformation>, FlowLogInformation>>Parameters
- resourceGroupName
-
string
The name of the network watcher resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- FlowLogInformation
Parameters that define the configuration of flow log.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<FlowLogInformation>, FlowLogInformation>>
beginSetFlowLogConfigurationAndWait(string, string, FlowLogInformation, NetworkWatchersSetFlowLogConfigurationOptionalParams)
Configures flow log and traffic analytics (optional) on a specified resource.
function beginSetFlowLogConfigurationAndWait(resourceGroupName: string, networkWatcherName: string, parameters: FlowLogInformation, options?: NetworkWatchersSetFlowLogConfigurationOptionalParams): Promise<FlowLogInformation>Parameters
- resourceGroupName
-
string
The name of the network watcher resource group.
- networkWatcherName
-
string
The name of the network watcher resource.
- parameters
- FlowLogInformation
Parameters that define the configuration of flow log.
The options parameters.
Returns
Promise<FlowLogInformation>
beginVerifyIPFlow(string, string, VerificationIPFlowParameters, NetworkWatchersVerifyIPFlowOptionalParams)
Verify IP flow from the specified VM to a location given the currently configured NSG rules.
function beginVerifyIPFlow(resourceGroupName: string, networkWatcherName: string, parameters: VerificationIPFlowParameters, options?: NetworkWatchersVerifyIPFlowOptionalParams): Promise<SimplePollerLike<OperationState<VerificationIPFlowResult>, VerificationIPFlowResult>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
- parameters
- VerificationIPFlowParameters
Parameters that define the IP flow to be verified.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<VerificationIPFlowResult>, VerificationIPFlowResult>>
beginVerifyIPFlowAndWait(string, string, VerificationIPFlowParameters, NetworkWatchersVerifyIPFlowOptionalParams)
Verify IP flow from the specified VM to a location given the currently configured NSG rules.
function beginVerifyIPFlowAndWait(resourceGroupName: string, networkWatcherName: string, parameters: VerificationIPFlowParameters, options?: NetworkWatchersVerifyIPFlowOptionalParams): Promise<VerificationIPFlowResult>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
- parameters
- VerificationIPFlowParameters
Parameters that define the IP flow to be verified.
The options parameters.
Returns
Promise<VerificationIPFlowResult>
createOrUpdate(string, string, NetworkWatcher, NetworkWatchersCreateOrUpdateOptionalParams)
Creates or updates a network watcher in the specified resource group.
function createOrUpdate(resourceGroupName: string, networkWatcherName: string, parameters: NetworkWatcher, options?: NetworkWatchersCreateOrUpdateOptionalParams): Promise<NetworkWatcher>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
- parameters
- NetworkWatcher
Parameters that define the network watcher resource.
The options parameters.
Returns
Promise<NetworkWatcher>
get(string, string, NetworkWatchersGetOptionalParams)
Gets the specified network watcher by resource group.
function get(resourceGroupName: string, networkWatcherName: string, options?: NetworkWatchersGetOptionalParams): Promise<NetworkWatcher>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
- options
- NetworkWatchersGetOptionalParams
The options parameters.
Returns
Promise<NetworkWatcher>
getTopology(string, string, TopologyParameters, NetworkWatchersGetTopologyOptionalParams)
Gets the current network topology by resource group.
function getTopology(resourceGroupName: string, networkWatcherName: string, parameters: TopologyParameters, options?: NetworkWatchersGetTopologyOptionalParams): Promise<Topology>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
- parameters
- TopologyParameters
Parameters that define the representation of topology.
The options parameters.
Returns
Promise<Topology>
list(string, NetworkWatchersListOptionalParams)
Gets all network watchers by resource group.
function list(resourceGroupName: string, options?: NetworkWatchersListOptionalParams): PagedAsyncIterableIterator<NetworkWatcher, NetworkWatcher[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
The options parameters.
Returns
listAll(NetworkWatchersListAllOptionalParams)
Gets all network watchers by subscription.
function listAll(options?: NetworkWatchersListAllOptionalParams): PagedAsyncIterableIterator<NetworkWatcher, NetworkWatcher[], PageSettings>Parameters
The options parameters.
Returns
updateTags(string, string, TagsObject, NetworkWatchersUpdateTagsOptionalParams)
Updates a network watcher tags.
function updateTags(resourceGroupName: string, networkWatcherName: string, parameters: TagsObject, options?: NetworkWatchersUpdateTagsOptionalParams): Promise<NetworkWatcher>Parameters
- resourceGroupName
-
string
The name of the resource group.
- networkWatcherName
-
string
The name of the network watcher.
- parameters
- TagsObject
Parameters supplied to update network watcher tags.
The options parameters.
Returns
Promise<NetworkWatcher>