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-01-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
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1?api-version=2024-01-01
{
"location": "eastus",
"properties": {}
}
import com.azure.resourcemanager.network.fluent.models.NetworkWatcherInner;
/**
* Samples for NetworkWatchers CreateOrUpdate.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherCreate.json
*/
/**
* Sample code: Create network watcher.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void createNetworkWatcher(com.azure.resourcemanager.AzureResourceManager azure) {
azure.networks().manager().serviceClient().getNetworkWatchers().createOrUpdateWithResponse("rg1", "nw1",
new NetworkWatcherInner().withLocation("eastus"), com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from typing import Any, IO, Union
from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-network
# USAGE
python network_watcher_create.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = NetworkManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.network_watchers.create_or_update(
resource_group_name="rg1",
network_watcher_name="nw1",
parameters={"location": "eastus", "properties": {}},
)
print(response)
# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherCreate.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armnetwork_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherCreate.json
func ExampleWatchersClient_CreateOrUpdate() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWatchersClient().CreateOrUpdate(ctx, "rg1", "nw1", armnetwork.Watcher{
Location: to.Ptr("eastus"),
Properties: &armnetwork.WatcherPropertiesFormat{},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Watcher = armnetwork.Watcher{
// Name: to.Ptr("nw1"),
// Type: to.Ptr("Microsoft.Network/networkWatchers"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1"),
// Location: to.Ptr("eastus"),
// Tags: map[string]*string{
// },
// Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
// Properties: &armnetwork.WatcherPropertiesFormat{
// ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Creates or updates a network watcher in the specified resource group.
*
* @summary Creates or updates a network watcher in the specified resource group.
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/NetworkWatcherCreate.json
*/
async function createNetworkWatcher() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
const networkWatcherName = "nw1";
const parameters = { location: "eastus" };
const credential = new DefaultAzureCredential();
const client = new NetworkManagementClient(credential, subscriptionId);
const result = await client.networkWatchers.createOrUpdate(
resourceGroupName,
networkWatcherName,
parameters,
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"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": "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
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
|
|