Network Watchers - List All

Gets all network watchers by subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers?api-version=2020-11-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client API version.

Responses

Name Type Description
200 OK

Request successful. The operation returns a list of network watcher resources.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

List all network watchers

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/networkWatchers?api-version=2020-11-01

Sample Response

{
  "value": [
    {
      "name": "nw1",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1",
      "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
      "type": "Microsoft.Network/networkWatchers",
      "location": "eastus",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded"
      }
    },
    {
      "name": "nw2",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2",
      "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
      "type": "Microsoft.Network/networkWatchers",
      "location": "westus",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definitions

ErrorDetails

Common error details representation.

ErrorResponse

The error object.

NetworkWatcher

Network watcher in a resource group.

NetworkWatcherListResult

Response for ListNetworkWatchers API service call.

ProvisioningState

The current provisioning state.

ErrorDetails

Common error details representation.

Name Type Description
code
  • string

Error code.

message
  • string

Error message.

target
  • string

Error target.

ErrorResponse

The error object.

Name Type Description
error

Error
The error details object.

NetworkWatcher

Network watcher in a resource group.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.provisioningState

The provisioning state of the network watcher resource.

tags
  • object

Resource tags.

type
  • string

Resource type.

NetworkWatcherListResult

Response for ListNetworkWatchers API service call.

Name Type Description
value

List of network watcher resources.

ProvisioningState

The current provisioning state.

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string