openapi-directory/api/azure.com/network-networkWatcher.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.","title":"NetworkManagementClient","version":"2019-07-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/networkWatcher.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"network-networkWatcher","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers":{"get":{"description":"Gets all network watchers by subscription.","operationId":"NetworkWatchers_ListAll","parameters":[{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List all network watchers":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List all network watchers":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a list of network watcher resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkWatcherListResult"},"examples":{"List all network watchers":{"$ref":"#/components/examples/List_all_network_watchers"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"],"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers":{"get":{"description":"Gets all network watchers by resource group.","operationId":"NetworkWatchers_List","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"List network watchers":{"value":"rg1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List network watchers":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List network watchers":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a list of network watcher resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkWatcherListResult"},"examples":{"List network watchers":{"$ref":"#/components/examples/List_network_watchers"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"],"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}":{"delete":{"description":"Deletes the specified network watcher resource.","operationId":"NetworkWatchers_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Delete network watcher":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Delete network watcher":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete network watcher":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete network watcher":{"value":"subid"}}}],"responses":{"202":{"description":"Accepted and the operation will complete asynchronously."},"204":{"description":"Delete successful."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Gets the specified network watcher by resource group.","operationId":"NetworkWatchers_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get network watcher":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Get network watcher":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get network watcher":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get network watcher":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a network watcher resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkWatcher"},"examples":{"Get network watcher":{"$ref":"#/components/examples/Get_network_watcher"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"]},"patch":{"description":"Updates a network watcher tags.","operationId":"NetworkWatchers_UpdateTags","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Update network watcher tags":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Update network watcher tags":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Update network watcher tags":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Update network watcher tags":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Tags object for patch operations.","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"}}}}},"description":"Parameters supplied to update network watcher tags.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting network watcher resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkWatcher"},"examples":{"Update network watcher tags":{"$ref":"#/components/examples/Update_network_watcher_tags"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"]},"put":{"description":"Creates or updates a network watcher in the specified resource group.","operationId":"NetworkWatchers_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Create network watcher":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Create network watcher":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create network watcher":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create network watcher":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkWatcher"}}},"description":"Parameters that define the network watcher resource.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting network watcher resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkWatcher"},"examples":{"Create network watcher":{"$ref":"#/components/examples/Create_network_watcher"}}}}},"201":{"description":"Create successful. The operation returns the resulting network watcher resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkWatcher"},"examples":{"Create network watcher":{"$ref":"#/components/examples/Create_network_watcher"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/availableProvidersList":{"post":{"description":"Lists all available internet service providers for a specified Azure region.","operationId":"NetworkWatchers_ListAvailableProviders","parameters":[{"description":"The name of the network watcher resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get Available Providers List":{"value":"rg1"}}},{"description":"The name of the network watcher resource.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Get Available Providers List":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get Available Providers List":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get Available Providers List":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableProvidersListParameters"}}},"description":"Parameters that scope the list of available providers.","required":true},"responses":{"200":{"description":"Successful request for list of available providers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableProvidersList"},"examples":{"Get Available Providers List":{"$ref":"#/components/examples/Get_Available_Providers_List"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableProvidersList"},"examples":{"Get Available Providers List":{"$ref":"#/components/examples/Get_Available_Providers_List"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/azureReachabilityReport":{"post":{"description":"Gets the relative latency score for internet service providers from a specified location to Azure regions.","operationId":"NetworkWatchers_GetAzureReachabilityReport","parameters":[{"description":"The name of the network watcher resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get Azure Reachability Report":{"value":"rg1"}}},{"description":"The name of the network watcher resource.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Get Azure Reachability Report":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get Azure Reachability Report":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get Azure Reachability Report":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureReachabilityReportParameters"}}},"description":"Parameters that determine Azure reachability report configuration.","required":true},"responses":{"200":{"description":"Successful request for Azure reachability report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureReachabilityReport"},"examples":{"Get Azure Reachability Report":{"$ref":"#/components/examples/Get_Azure_Reachability_Report"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureReachabilityReport"},"examples":{"Get Azure Reachability Report":{"$ref":"#/components/examples/Get_Azure_Reachability_Report"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog":{"post":{"description":"Configures flow log and traffic analytics (optional) on a specified resource.","operationId":"NetworkWatchers_SetFlowLogConfiguration","parameters":[{"description":"The name of the network watcher resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Configure flow log":{"value":"rg1"}}},{"description":"The name of the network watcher resource.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Configure flow log":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Configure flow log":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Configure flow log":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowLogInformation"}}},"description":"Parameters that define the configuration of flow log.","required":true},"responses":{"200":{"description":"Successful request for setting flow log and traffic analytics (optional) configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowLogInformation"},"examples":{"Configure flow log":{"$ref":"#/components/examples/Configure_flow_log"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowLogInformation"},"examples":{"Configure flow log":{"$ref":"#/components/examples/Configure_flow_log"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers","TrafficAnalytics"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectivityCheck":{"post":{"description":"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.","operationId":"NetworkWatchers_CheckConnectivity","parameters":[{"description":"The name of the network watcher resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Check connectivity":{"value":"rg1"}}},{"description":"The name of the network watcher resource.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Check connectivity":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Check connectivity":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Check connectivity":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectivityParameters"}}},"description":"Parameters that determine how the connectivity check will be performed.","required":true},"responses":{"200":{"description":"Successful request for checking connectivity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectivityInformation"},"examples":{"Check connectivity":{"$ref":"#/components/examples/Check_connectivity"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectivityInformation"},"examples":{"Check connectivity":{"$ref":"#/components/examples/Check_connectivity"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/ipFlowVerify":{"post":{"description":"Verify IP flow from the specified VM to a location given the currently configured NSG rules.","operationId":"NetworkWatchers_VerifyIPFlow","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Ip flow verify":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Ip flow verify":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Ip flow verify":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Ip flow verify":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationIPFlowParameters"}}},"description":"Parameters that define the IP flow to be verified.","required":true},"responses":{"200":{"description":"Request successful. The operation returns the result of IP flow verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationIPFlowResult"},"examples":{"Ip flow verify":{"$ref":"#/components/examples/Ip_flow_verify"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationIPFlowResult"},"examples":{"Ip flow verify":{"$ref":"#/components/examples/Ip_flow_verify"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/networkConfigurationDiagnostic":{"post":{"description":"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.","operationId":"NetworkWatchers_GetNetworkConfigurationDiagnostic","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Network configuration diagnostic":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Network configuration diagnostic":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Network configuration diagnostic":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Network configuration diagnostic":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkConfigurationDiagnosticParameters"}}},"description":"Parameters to get network configuration diagnostic.","required":true},"responses":{"200":{"description":"Request successful. The operation returns the result of network configuration diagnostic.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkConfigurationDiagnosticResponse"},"examples":{"Network configuration diagnostic":{"$ref":"#/components/examples/Network_configuration_diagnostic"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkConfigurationDiagnosticResponse"},"examples":{"Network configuration diagnostic":{"$ref":"#/components/examples/Network_configuration_diagnostic"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/nextHop":{"post":{"description":"Gets the next hop from the specified VM.","operationId":"NetworkWatchers_GetNextHop","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get next hop":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Get next hop":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get next hop":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get next hop":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NextHopParameters"}}},"description":"Parameters that define the source and destination endpoint.","required":true},"responses":{"200":{"description":"Request successful. The operation returns the next hop from the VM.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NextHopResult"},"examples":{"Get next hop":{"$ref":"#/components/examples/Get_next_hop"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NextHopResult"},"examples":{"Get next hop":{"$ref":"#/components/examples/Get_next_hop"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures":{"get":{"description":"Lists all packet capture sessions within the specified resource group.","operationId":"PacketCaptures_List","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"List packet captures":{"value":"rg1"}}},{"description":"The name of the Network Watcher resource.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"List packet captures":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List packet captures":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List packet captures":{"value":"subid"}}}],"responses":{"200":{"description":"Successful packet capture enumeration request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacketCaptureListResult"},"examples":{"List packet captures":{"$ref":"#/components/examples/List_packet_captures"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["PacketCaptures"],"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}":{"delete":{"description":"Deletes the specified packet capture session.","operationId":"PacketCaptures_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Delete packet capture":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Delete packet capture":{"value":"nw1"}}},{"description":"The name of the packet capture session.","in":"path","name":"packetCaptureName","required":true,"schema":{"type":"string"},"examples":{"Delete packet capture":{"value":"pc1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete packet capture":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete packet capture":{"value":"subid"}}}],"responses":{"202":{"description":"Accepted and the operation will complete asynchronously."},"204":{"description":"Delete successful."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["PacketCaptures"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Gets a packet capture session by name.","operationId":"PacketCaptures_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get packet capture":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Get packet capture":{"value":"nw1"}}},{"description":"The name of the packet capture session.","in":"path","name":"packetCaptureName","required":true,"schema":{"type":"string"},"examples":{"Get packet capture":{"value":"pc1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get packet capture":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get packet capture":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a packet capture session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacketCaptureResult"},"examples":{"Get packet capture":{"$ref":"#/components/examples/Get_packet_capture"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["PacketCaptures"]},"put":{"description":"Create and start a packet capture on the specified VM.","operationId":"PacketCaptures_Create","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Create packet capture":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Create packet capture":{"value":"nw1"}}},{"description":"The name of the packet capture session.","in":"path","name":"packetCaptureName","required":true,"schema":{"type":"string"},"examples":{"Create packet capture":{"value":"pc1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create packet capture":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create packet capture":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacketCapture"}}},"description":"Parameters that define the create packet capture operation.","required":true},"responses":{"201":{"description":"Request successful. The operation returns the resulting packet capture session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacketCaptureResult"},"examples":{"Create packet capture":{"$ref":"#/components/examples/Create_packet_capture"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["PacketCaptures"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/queryStatus":{"post":{"description":"Query the status of a running packet capture session.","operationId":"PacketCaptures_GetStatus","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Query packet capture status":{"value":"rg1"}}},{"description":"The name of the Network Watcher resource.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Query packet capture status":{"value":"nw1"}}},{"description":"The name given to the packet capture session.","in":"path","name":"packetCaptureName","required":true,"schema":{"type":"string"},"examples":{"Query packet capture status":{"value":"pc1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Query packet capture status":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Query packet capture status":{"value":"subid"}}}],"responses":{"200":{"description":"Successful query of packet capture status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacketCaptureQueryStatusResult"},"examples":{"Query packet capture status":{"$ref":"#/components/examples/Query_packet_capture_status"}}}}},"202":{"description":"Accepted query status of packet capture.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacketCaptureQueryStatusResult"},"examples":{"Query packet capture status":{"$ref":"#/components/examples/Query_packet_capture_status"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["PacketCaptures"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/stop":{"post":{"description":"Stops a specified packet capture session.","operationId":"PacketCaptures_Stop","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Stop packet capture":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Stop packet capture":{"value":"nw1"}}},{"description":"The name of the packet capture session.","in":"path","name":"packetCaptureName","required":true,"schema":{"type":"string"},"examples":{"Stop packet capture":{"value":"pc1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Stop packet capture":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Stop packet capture":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation stops the packet capture session."},"202":{"description":"Accepted and the operation will complete asynchronously."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["PacketCaptures"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryFlowLogStatus":{"post":{"description":"Queries status of flow log and traffic analytics (optional) on a specified resource.","operationId":"NetworkWatchers_GetFlowLogStatus","parameters":[{"description":"The name of the network watcher resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get flow log status":{"value":"rg1"}}},{"description":"The name of the network watcher resource.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Get flow log status":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get flow log status":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get flow log status":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowLogStatusParameters"}}},"description":"Parameters that define a resource to query flow log and traffic analytics (optional) status.","required":true},"responses":{"200":{"description":"Successful request for query flow log and traffic analytics (optional) status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowLogInformation"},"examples":{"Get flow log status":{"$ref":"#/components/examples/Get_flow_log_status"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowLogInformation"},"examples":{"Get flow log status":{"$ref":"#/components/examples/Get_flow_log_status"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers","TrafficAnalytics"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryTroubleshootResult":{"post":{"description":"Get the last completed troubleshooting result on a specified resource.","operationId":"NetworkWatchers_GetTroubleshootingResult","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get troubleshoot result":{"value":"rg1"}}},{"description":"The name of the network watcher resource.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Get troubleshoot result":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get troubleshoot result":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get troubleshoot result":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryTroubleshootingParameters"}}},"description":"Parameters that define the resource to query the troubleshooting result.","required":true},"responses":{"200":{"description":"Successful get troubleshooting result request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TroubleshootingResult"},"examples":{"Get troubleshoot result":{"$ref":"#/components/examples/Get_troubleshoot_result"}}}}},"202":{"description":"Accepted get troubleshooting result request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TroubleshootingResult"},"examples":{"Get troubleshoot result":{"$ref":"#/components/examples/Get_troubleshoot_result"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/securityGroupView":{"post":{"description":"Gets the configured and effective security group rules on the specified VM.","operationId":"NetworkWatchers_GetVMSecurityRules","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get security group view":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Get security group view":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get security group view":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get security group view":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityGroupViewParameters"}}},"description":"Parameters that define the VM to check security groups for.","required":true},"responses":{"200":{"description":"Request successful. The operation returns security group rules on the VM.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityGroupViewResult"},"examples":{"Get security group view":{"$ref":"#/components/examples/Get_security_group_view"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityGroupViewResult"},"examples":{"Get security group view":{"$ref":"#/components/examples/Get_security_group_view"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/topology":{"post":{"description":"Gets the current network topology by resource group.","operationId":"NetworkWatchers_GetTopology","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get Topology":{"value":"rg1"}}},{"description":"The name of the network watcher.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Get Topology":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get Topology":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get Topology":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopologyParameters"}}},"description":"Parameters that define the representation of topology.","required":true},"responses":{"200":{"description":"Request successful. The operation returns the topology of resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Topology"},"examples":{"Get Topology":{"$ref":"#/components/examples/Get_Topology"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/troubleshoot":{"post":{"description":"Initiate troubleshooting on a specified resource.","operationId":"NetworkWatchers_GetTroubleshooting","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get troubleshooting":{"value":"rg1"}}},{"description":"The name of the network watcher resource.","in":"path","name":"networkWatcherName","required":true,"schema":{"type":"string"},"examples":{"Get troubleshooting":{"value":"nw1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get troubleshooting":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get troubleshooting":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TroubleshootingParameters"}}},"description":"Parameters that define the resource to troubleshoot.","required":true},"responses":{"200":{"description":"Successful troubleshooting request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TroubleshootingResult"},"examples":{"Get troubleshooting":{"$ref":"#/components/examples/Get_troubleshooting"}}}}},"202":{"description":"Accepted get troubleshooting request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TroubleshootingResult"},"examples":{"Get troubleshooting":{"$ref":"#/components/examples/Get_troubleshooting"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["NetworkWatchers"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_all_network_watchers":{"value":{"value":[{"etag":"W/\"00000000-0000-0000-0000-000000000000\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1","location":"eastus","name":"nw1","properties":{"provisioningState":"Succeeded"},"tags":{},"type":"Microsoft.Network/networkWatchers"},{"etag":"W/\"00000000-0000-0000-0000-000000000000\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2","location":"westus","name":"nw2","properties":{"provisioningState":"Succeeded"},"tags":{},"type":"Microsoft.Network/networkWatchers"}]}},"List_network_watchers":{"value":{"value":[{"etag":"W/\"00000000-0000-0000-0000-000000000000\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1","location":"eastus","name":"nw1","properties":{"provisioningState":"Succeeded"},"tags":{},"type":"Microsoft.Network/networkWatchers"},{"etag":"W/\"00000000-0000-0000-0000-000000000000\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2","location":"eastus","name":"nw2","properties":{"provisioningState":"Succeeded"},"tags":{},"type":"Microsoft.Network/networkWatchers"}]}},"Get_network_watcher":{"value":{"etag":"W/\"00000000-0000-0000-0000-00000000