{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-network-networkwatcher","description":"NetworkManagementClient","version":"2019-07-01","base_url":"https://management.azure.com","endpoints":24,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api NetworkManagementClient\n@base https://management.azure.com\n@version 2019-07-01\n@auth OAuth2\n@common_fields {resourceGroupName: any # The name of the resource group.}\n@endpoints 24\n@hint download_for_search\n@toc subscriptions(24)\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}\n@desc Creates or updates a network watcher in the specified resource group.\n@required {networkWatcherName: any # The name of the network watcher., parameters: any # Parameters that define the network watcher resource.}\n@returns(200) Update successful. The operation returns the resulting network watcher resource.\n@returns(201) Create successful. The operation returns the resulting network watcher resource.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}\n@desc Gets the specified network watcher by resource group.\n@required {networkWatcherName: any # The name of the network watcher.}\n@returns(200) Request successful. The operation returns a network watcher resource.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}\n@desc Deletes the specified network watcher resource.\n@required {networkWatcherName: any # The name of the network watcher.}\n@returns(202) Accepted and the operation will complete asynchronously.\n@returns(204) Delete successful.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}\n@desc Updates a network watcher tags.\n@required {networkWatcherName: any # The name of the network watcher., parameters: any # Parameters supplied to update network watcher tags.}\n@returns(200) Update successful. The operation returns the resulting network watcher resource.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers\n@desc Gets all network watchers by resource group.\n@returns(200) Request successful. The operation returns a list of network watcher resources.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers\n@desc Gets all network watchers by subscription.\n@returns(200) Request successful. The operation returns a list of network watcher resources.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/topology\n@desc Gets the current network topology by resource group.\n@required {networkWatcherName: any # The name of the network watcher., parameters: any # Parameters that define the representation of topology.}\n@returns(200) Request successful. The operation returns the topology of resource group.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/ipFlowVerify\n@desc Verify IP flow from the specified VM to a location given the currently configured NSG rules.\n@required {networkWatcherName: any # The name of the network watcher., parameters: any # Parameters that define the IP flow to be verified.}\n@returns(200) Request successful. The operation returns the result of IP flow verification.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/nextHop\n@desc Gets the next hop from the specified VM.\n@required {networkWatcherName: any # The name of the network watcher., parameters: any # Parameters that define the source and destination endpoint.}\n@returns(200) Request successful. The operation returns the next hop from the VM.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/securityGroupView\n@desc Gets the configured and effective security group rules on the specified VM.\n@required {networkWatcherName: any # The name of the network watcher., parameters: any # Parameters that define the VM to check security groups for.}\n@returns(200) Request successful. The operation returns security group rules on the VM.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}\n@desc Create and start a packet capture on the specified VM.\n@required {networkWatcherName: any # The name of the network watcher., packetCaptureName: any # The name of the packet capture session., parameters: any # Parameters that define the create packet capture operation.}\n@returns(201) Request successful. The operation returns the resulting packet capture session.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}\n@desc Gets a packet capture session by name.\n@required {networkWatcherName: any # The name of the network watcher., packetCaptureName: any # The name of the packet capture session.}\n@returns(200) Request successful. The operation returns a packet capture session.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}\n@desc Deletes the specified packet capture session.\n@required {networkWatcherName: any # The name of the network watcher., packetCaptureName: any # The name of the packet capture session.}\n@returns(202) Accepted and the operation will complete asynchronously.\n@returns(204) Delete successful.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/stop\n@desc Stops a specified packet capture session.\n@required {networkWatcherName: any # The name of the network watcher., packetCaptureName: any # The name of the packet capture session.}\n@returns(200) Request successful. The operation stops the packet capture session.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/queryStatus\n@desc Query the status of a running packet capture session.\n@required {networkWatcherName: any # The name of the Network Watcher resource., packetCaptureName: any # The name given to the packet capture session.}\n@returns(200) Successful query of packet capture status.\n@returns(202) Accepted query status of packet capture.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures\n@desc Lists all packet capture sessions within the specified resource group.\n@required {networkWatcherName: any # The name of the Network Watcher resource.}\n@returns(200) Successful packet capture enumeration request.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/troubleshoot\n@desc Initiate troubleshooting on a specified resource.\n@required {networkWatcherName: any # The name of the network watcher resource., parameters: any # Parameters that define the resource to troubleshoot.}\n@returns(200) Successful troubleshooting request.\n@returns(202) Accepted get troubleshooting request.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryTroubleshootResult\n@desc Get the last completed troubleshooting result on a specified resource.\n@required {networkWatcherName: any # The name of the network watcher resource., parameters: any # Parameters that define the resource to query the troubleshooting result.}\n@returns(200) Successful get troubleshooting result request.\n@returns(202) Accepted get troubleshooting result request.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog\n@desc Configures flow log and traffic analytics (optional) on a specified resource.\n@required {networkWatcherName: any # The name of the network watcher resource., parameters: any # Parameters that define the configuration of flow log.}\n@returns(200) Successful request for setting flow log and traffic analytics (optional) configuration.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryFlowLogStatus\n@desc Queries status of flow log and traffic analytics (optional) on a specified resource.\n@required {networkWatcherName: any # The name of the network watcher resource., parameters: any # Parameters that define a resource to query flow log and traffic analytics (optional) status.}\n@returns(200) Successful request for query flow log and traffic analytics (optional) status.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectivityCheck\n@desc 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.\n@required {networkWatcherName: any # The name of the network watcher resource., parameters: any # Parameters that determine how the connectivity check will be performed.}\n@returns(200) Successful request for checking connectivity.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/azureReachabilityReport\n@desc Gets the relative latency score for internet service providers from a specified location to Azure regions.\n@required {networkWatcherName: any # The name of the network watcher resource., parameters: any # Parameters that determine Azure reachability report configuration.}\n@returns(200) Successful request for Azure reachability report.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/availableProvidersList\n@desc Lists all available internet service providers for a specified Azure region.\n@required {networkWatcherName: any # The name of the network watcher resource., parameters: any # Parameters that scope the list of available providers.}\n@returns(200) Successful request for list of available providers.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/networkConfigurationDiagnostic\n@desc 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.\n@required {networkWatcherName: any # The name of the network watcher., parameters: any # Parameters to get network configuration diagnostic.}\n@returns(200) Request successful. The operation returns the result of network configuration diagnostic.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@end\n"}