Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. NetworkWatcher
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.NetworkWatcher

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Network watcher in a resource group.

    Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.

    Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

    Example Usage

    Create network watcher

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var networkWatcher = new AzureNative.Network.NetworkWatcher("networkWatcher", new()
    {
        Location = "eastus",
        NetworkWatcherName = "nw1",
        ResourceGroupName = "rg1",
    });

});

    package main

import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewNetworkWatcher(ctx, "networkWatcher", &network.NetworkWatcherArgs{
			Location:           pulumi.String("eastus"),
			NetworkWatcherName: pulumi.String("nw1"),
			ResourceGroupName:  pulumi.String("rg1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.NetworkWatcher;
import com.pulumi.azurenative.network.NetworkWatcherArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var networkWatcher = new NetworkWatcher("networkWatcher", NetworkWatcherArgs.builder()
            .location("eastus")
            .networkWatcherName("nw1")
            .resourceGroupName("rg1")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const networkWatcher = new azure_native.network.NetworkWatcher("networkWatcher", {
    location: "eastus",
    networkWatcherName: "nw1",
    resourceGroupName: "rg1",
});

    import pulumi
import pulumi_azure_native as azure_native

network_watcher = azure_native.network.NetworkWatcher("networkWatcher",
    location="eastus",
    network_watcher_name="nw1",
    resource_group_name="rg1")

    resources:
  networkWatcher:
    type: azure-native:network:NetworkWatcher
    properties:
      location: eastus
      networkWatcherName: nw1
      resourceGroupName: rg1

    Create NetworkWatcher Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NetworkWatcher(name: string, args: NetworkWatcherArgs, opts?: CustomResourceOptions);
    @overload
def NetworkWatcher(resource_name: str,
                   args: NetworkWatcherArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def NetworkWatcher(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   id: Optional[str] = None,
                   location: Optional[str] = None,
                   network_watcher_name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewNetworkWatcher(ctx *Context, name string, args NetworkWatcherArgs, opts ...ResourceOption) (*NetworkWatcher, error)
    public NetworkWatcher(string name, NetworkWatcherArgs args, CustomResourceOptions? opts = null)
    public NetworkWatcher(String name, NetworkWatcherArgs args)
public NetworkWatcher(String name, NetworkWatcherArgs args, CustomResourceOptions options)

    type: azure-native:network:NetworkWatcher
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args NetworkWatcherArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NetworkWatcherArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NetworkWatcherArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkWatcherArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkWatcherArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var networkWatcherResource = new AzureNative.Network.NetworkWatcher("networkWatcherResource", new()
{
    ResourceGroupName = "string",
    Id = "string",
    Location = "string",
    NetworkWatcherName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := network.NewNetworkWatcher(ctx, "networkWatcherResource", &network.NetworkWatcherArgs{
	ResourceGroupName:  pulumi.String("string"),
	Id:                 pulumi.String("string"),
	Location:           pulumi.String("string"),
	NetworkWatcherName: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var networkWatcherResource = new NetworkWatcher("networkWatcherResource", NetworkWatcherArgs.builder()
    .resourceGroupName("string")
    .id("string")
    .location("string")
    .networkWatcherName("string")
    .tags(Map.of("string", "string"))
    .build());

    network_watcher_resource = azure_native.network.NetworkWatcher("networkWatcherResource",
    resource_group_name="string",
    id="string",
    location="string",
    network_watcher_name="string",
    tags={
        "string": "string",
    })

    const networkWatcherResource = new azure_native.network.NetworkWatcher("networkWatcherResource", {
    resourceGroupName: "string",
    id: "string",
    location: "string",
    networkWatcherName: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:network:NetworkWatcher
properties:
    id: string
    location: string
    networkWatcherName: string
    resourceGroupName: string
    tags:
        string: string

    NetworkWatcher Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The NetworkWatcher resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group.
    Id string
    Resource ID.
    Location string
    Resource location.
    NetworkWatcherName string
    The name of the network watcher.
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    The name of the resource group.
    Id string
    Resource ID.
    Location string
    Resource location.
    NetworkWatcherName string
    The name of the network watcher.
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    The name of the resource group.
    id String
    Resource ID.
    location String
    Resource location.
    networkWatcherName String
    The name of the network watcher.
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    The name of the resource group.
    id string
    Resource ID.
    location string
    Resource location.
    networkWatcherName string
    The name of the network watcher.
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    The name of the resource group.
    id str
    Resource ID.
    location str
    Resource location.
    network_watcher_name str
    The name of the network watcher.
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    The name of the resource group.
    id String
    Resource ID.
    location String
    Resource location.
    networkWatcherName String
    The name of the network watcher.
    tags Map<String>
    Resource tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NetworkWatcher resource produces the following output properties:

    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the network watcher resource.
    Type string
    Resource type.
    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the network watcher resource.
    Type string
    Resource type.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the network watcher resource.
    type String
    Resource type.
    azureApiVersion string
    The Azure API version of the resource.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the network watcher resource.
    type string
    Resource type.
    azure_api_version str
    The Azure API version of the resource.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the network watcher resource.
    type str
    Resource type.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the network watcher resource.
    type String
    Resource type.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:network:NetworkWatcher nw1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native