Network Watchers - Create Or Update

Service:

Network Watcher

API Version:

2024-05-01

Creates or updates a network watcher in the specified resource group.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
networkWatcherName	path	True	string	The name of the network watcher.
resourceGroupName	path	True	string	The name of the resource group.
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.

Request Body

Name	Type	Description
id	string	Resource ID.
location	string	Resource location.
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	NetworkWatcher	Update successful. The operation returns the resulting network watcher resource.
201 Created	NetworkWatcher	Create successful. The operation returns the resulting network watcher resource.
Other Status Codes	ErrorResponse	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

Create network watcher

Sample request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1?api-version=2024-05-01

{
  "location": "eastus",
  "properties": {}
}

Sample response

Status code:

200

{
  "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"
  }
}

Status code:

201

{
  "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"
  }
}

Definitions

Name	Description
ErrorDetails	Common error details representation.
ErrorResponse	The error object.
NetworkWatcher	Network watcher in a resource group.
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	ErrorDetails	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	ProvisioningState	The provisioning state of the network watcher resource.
tags	object	Resource tags.
type	string	Resource type.

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string