Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. NetworkWatcher

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.network.NetworkWatcher

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Network Watcher.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "production-nwwatcher",
    location: "West Europe",
});
const exampleNetworkWatcher = new azure.network.NetworkWatcher("example", {
    name: "production-nwwatcher",
    location: example.location,
    resourceGroupName: example.name,
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="production-nwwatcher",
    location="West Europe")
example_network_watcher = azure.network.NetworkWatcher("example",
    name="production-nwwatcher",
    location=example.location,
    resource_group_name=example.name)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("production-nwwatcher"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewNetworkWatcher(ctx, "example", &network.NetworkWatcherArgs{
			Name:              pulumi.String("production-nwwatcher"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "production-nwwatcher",
        Location = "West Europe",
    });

    var exampleNetworkWatcher = new Azure.Network.NetworkWatcher("example", new()
    {
        Name = "production-nwwatcher",
        Location = example.Location,
        ResourceGroupName = example.Name,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.NetworkWatcher;
import com.pulumi.azure.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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("production-nwwatcher")
            .location("West Europe")
            .build());

        var exampleNetworkWatcher = new NetworkWatcher("exampleNetworkWatcher", NetworkWatcherArgs.builder()
            .name("production-nwwatcher")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: production-nwwatcher
      location: West Europe
  exampleNetworkWatcher:
    type: azure:network:NetworkWatcher
    name: example
    properties:
      name: production-nwwatcher
      location: ${example.location}
      resourceGroupName: ${example.name}

    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,
                   location: Optional[str] = None,
                   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: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 Azure.Network.NetworkWatcher("networkWatcherResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

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

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

    network_watcher_resource = azure.network.NetworkWatcher("networkWatcherResource",
    resource_group_name="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })

    const networkWatcherResource = new azure.network.NetworkWatcher("networkWatcherResource", {
    resourceGroupName: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: azure:network:NetworkWatcher
properties:
    location: string
    name: 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 in which to create the Network Watcher. Changing this forces a new resource to be created.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    The name of the Network Watcher. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    ResourceGroupName string
    The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    The name of the Network Watcher. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    resourceGroupName String
    The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    The name of the Network Watcher. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    resourceGroupName string
    The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    The name of the Network Watcher. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    resource_group_name str
    The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    The name of the Network Watcher. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    resourceGroupName String
    The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    The name of the Network Watcher. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NetworkWatcher Resource

    Get an existing NetworkWatcher resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: NetworkWatcherState, opts?: CustomResourceOptions): NetworkWatcher
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> NetworkWatcher
    func GetNetworkWatcher(ctx *Context, name string, id IDInput, state *NetworkWatcherState, opts ...ResourceOption) (*NetworkWatcher, error)
    public static NetworkWatcher Get(string name, Input<string> id, NetworkWatcherState? state, CustomResourceOptions? opts = null)
    public static NetworkWatcher get(String name, Output<String> id, NetworkWatcherState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    The name of the Network Watcher. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    The name of the Network Watcher. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    The name of the Network Watcher. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    The name of the Network Watcher. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    The name of the Network Watcher. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    The name of the Network Watcher. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Import

    Network Watchers can be imported using the resource id, e.g.

    $ pulumi import azure:network/networkWatcher:NetworkWatcher watcher1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/networkWatchers/watcher1

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure