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

We recommend using Azure Native.

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

azure.automation.Watcher

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 an Automation Wacher.

    Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleAccount = new azure.automation.Account("example", {
    name: "example-account",
    location: example.location,
    resourceGroupName: example.name,
    skuName: "Basic",
});
const exampleHybridRunbookWorkerGroup = new azure.automation.HybridRunbookWorkerGroup("example", {
    name: "example",
    resourceGroupName: example.name,
    automationAccountName: exampleAccount.name,
});
const exampleRunBook = new azure.automation.RunBook("example", {
    name: "Get-AzureVMTutorial",
    location: example.location,
    resourceGroupName: example.name,
    automationAccountName: exampleAccount.name,
    logVerbose: true,
    logProgress: true,
    description: "This is an example runbook",
    runbookType: "PowerShellWorkflow",
    publishContentLink: {
        uri: "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
    },
});
const exampleWatcher = new azure.automation.Watcher("example", {
    name: "example",
    automationAccountId: exampleAccount.id,
    location: "West Europe",
    scriptName: exampleRunBook.name,
    scriptRunOn: exampleHybridRunbookWorkerGroup.name,
    description: "example-watcher desc",
    executionFrequencyInSeconds: 42,
    tags: {
        foo: "bar",
    },
    scriptParameters: {
        foo: "bar",
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_account = azure.automation.Account("example",
    name="example-account",
    location=example.location,
    resource_group_name=example.name,
    sku_name="Basic")
example_hybrid_runbook_worker_group = azure.automation.HybridRunbookWorkerGroup("example",
    name="example",
    resource_group_name=example.name,
    automation_account_name=example_account.name)
example_run_book = azure.automation.RunBook("example",
    name="Get-AzureVMTutorial",
    location=example.location,
    resource_group_name=example.name,
    automation_account_name=example_account.name,
    log_verbose=True,
    log_progress=True,
    description="This is an example runbook",
    runbook_type="PowerShellWorkflow",
    publish_content_link={
        "uri": "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
    })
example_watcher = azure.automation.Watcher("example",
    name="example",
    automation_account_id=example_account.id,
    location="West Europe",
    script_name=example_run_book.name,
    script_run_on=example_hybrid_runbook_worker_group.name,
    description="example-watcher desc",
    execution_frequency_in_seconds=42,
    tags={
        "foo": "bar",
    },
    script_parameters={
        "foo": "bar",
    })

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/automation"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"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("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := automation.NewAccount(ctx, "example", &automation.AccountArgs{
			Name:              pulumi.String("example-account"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			SkuName:           pulumi.String("Basic"),
		})
		if err != nil {
			return err
		}
		exampleHybridRunbookWorkerGroup, err := automation.NewHybridRunbookWorkerGroup(ctx, "example", &automation.HybridRunbookWorkerGroupArgs{
			Name:                  pulumi.String("example"),
			ResourceGroupName:     example.Name,
			AutomationAccountName: exampleAccount.Name,
		})
		if err != nil {
			return err
		}
		exampleRunBook, err := automation.NewRunBook(ctx, "example", &automation.RunBookArgs{
			Name:                  pulumi.String("Get-AzureVMTutorial"),
			Location:              example.Location,
			ResourceGroupName:     example.Name,
			AutomationAccountName: exampleAccount.Name,
			LogVerbose:            pulumi.Bool(true),
			LogProgress:           pulumi.Bool(true),
			Description:           pulumi.String("This is an example runbook"),
			RunbookType:           pulumi.String("PowerShellWorkflow"),
			PublishContentLink: &automation.RunBookPublishContentLinkArgs{
				Uri: pulumi.String("https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1"),
			},
		})
		if err != nil {
			return err
		}
		_, err = automation.NewWatcher(ctx, "example", &automation.WatcherArgs{
			Name:                        pulumi.String("example"),
			AutomationAccountId:         exampleAccount.ID(),
			Location:                    pulumi.String("West Europe"),
			ScriptName:                  exampleRunBook.Name,
			ScriptRunOn:                 exampleHybridRunbookWorkerGroup.Name,
			Description:                 pulumi.String("example-watcher desc"),
			ExecutionFrequencyInSeconds: pulumi.Int(42),
			Tags: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
			ScriptParameters: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		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 = "example-resources",
        Location = "West Europe",
    });

    var exampleAccount = new Azure.Automation.Account("example", new()
    {
        Name = "example-account",
        Location = example.Location,
        ResourceGroupName = example.Name,
        SkuName = "Basic",
    });

    var exampleHybridRunbookWorkerGroup = new Azure.Automation.HybridRunbookWorkerGroup("example", new()
    {
        Name = "example",
        ResourceGroupName = example.Name,
        AutomationAccountName = exampleAccount.Name,
    });

    var exampleRunBook = new Azure.Automation.RunBook("example", new()
    {
        Name = "Get-AzureVMTutorial",
        Location = example.Location,
        ResourceGroupName = example.Name,
        AutomationAccountName = exampleAccount.Name,
        LogVerbose = true,
        LogProgress = true,
        Description = "This is an example runbook",
        RunbookType = "PowerShellWorkflow",
        PublishContentLink = new Azure.Automation.Inputs.RunBookPublishContentLinkArgs
        {
            Uri = "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
        },
    });

    var exampleWatcher = new Azure.Automation.Watcher("example", new()
    {
        Name = "example",
        AutomationAccountId = exampleAccount.Id,
        Location = "West Europe",
        ScriptName = exampleRunBook.Name,
        ScriptRunOn = exampleHybridRunbookWorkerGroup.Name,
        Description = "example-watcher desc",
        ExecutionFrequencyInSeconds = 42,
        Tags = 
        {
            { "foo", "bar" },
        },
        ScriptParameters = 
        {
            { "foo", "bar" },
        },
    });

});

    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.automation.Account;
import com.pulumi.azure.automation.AccountArgs;
import com.pulumi.azure.automation.HybridRunbookWorkerGroup;
import com.pulumi.azure.automation.HybridRunbookWorkerGroupArgs;
import com.pulumi.azure.automation.RunBook;
import com.pulumi.azure.automation.RunBookArgs;
import com.pulumi.azure.automation.inputs.RunBookPublishContentLinkArgs;
import com.pulumi.azure.automation.Watcher;
import com.pulumi.azure.automation.WatcherArgs;
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("example-resources")
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("example-account")
            .location(example.location())
            .resourceGroupName(example.name())
            .skuName("Basic")
            .build());

        var exampleHybridRunbookWorkerGroup = new HybridRunbookWorkerGroup("exampleHybridRunbookWorkerGroup", HybridRunbookWorkerGroupArgs.builder()
            .name("example")
            .resourceGroupName(example.name())
            .automationAccountName(exampleAccount.name())
            .build());

        var exampleRunBook = new RunBook("exampleRunBook", RunBookArgs.builder()
            .name("Get-AzureVMTutorial")
            .location(example.location())
            .resourceGroupName(example.name())
            .automationAccountName(exampleAccount.name())
            .logVerbose("true")
            .logProgress("true")
            .description("This is an example runbook")
            .runbookType("PowerShellWorkflow")
            .publishContentLink(RunBookPublishContentLinkArgs.builder()
                .uri("https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1")
                .build())
            .build());

        var exampleWatcher = new Watcher("exampleWatcher", WatcherArgs.builder()
            .name("example")
            .automationAccountId(exampleAccount.id())
            .location("West Europe")
            .scriptName(exampleRunBook.name())
            .scriptRunOn(exampleHybridRunbookWorkerGroup.name())
            .description("example-watcher desc")
            .executionFrequencyInSeconds(42)
            .tags(Map.of("foo", "bar"))
            .scriptParameters(Map.of("foo", "bar"))
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccount:
    type: azure:automation:Account
    name: example
    properties:
      name: example-account
      location: ${example.location}
      resourceGroupName: ${example.name}
      skuName: Basic
  exampleHybridRunbookWorkerGroup:
    type: azure:automation:HybridRunbookWorkerGroup
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      automationAccountName: ${exampleAccount.name}
  exampleRunBook:
    type: azure:automation:RunBook
    name: example
    properties:
      name: Get-AzureVMTutorial
      location: ${example.location}
      resourceGroupName: ${example.name}
      automationAccountName: ${exampleAccount.name}
      logVerbose: 'true'
      logProgress: 'true'
      description: This is an example runbook
      runbookType: PowerShellWorkflow
      publishContentLink:
        uri: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1
  exampleWatcher:
    type: azure:automation:Watcher
    name: example
    properties:
      name: example
      automationAccountId: ${exampleAccount.id}
      location: West Europe
      scriptName: ${exampleRunBook.name}
      scriptRunOn: ${exampleHybridRunbookWorkerGroup.name}
      description: example-watcher desc
      executionFrequencyInSeconds: 42
      tags:
        foo: bar
      scriptParameters:
        foo: bar

    Create Watcher Resource

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

    Constructor syntax

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

@overload
def Watcher(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            automation_account_id: Optional[str] = None,
            execution_frequency_in_seconds: Optional[int] = None,
            script_name: Optional[str] = None,
            script_run_on: Optional[str] = None,
            description: Optional[str] = None,
            etag: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            script_parameters: Optional[Mapping[str, str]] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewWatcher(ctx *Context, name string, args WatcherArgs, opts ...ResourceOption) (*Watcher, error)
    public Watcher(string name, WatcherArgs args, CustomResourceOptions? opts = null)
    public Watcher(String name, WatcherArgs args)
public Watcher(String name, WatcherArgs args, CustomResourceOptions options)

    type: azure:automation:Watcher
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 WatcherArgs
    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 WatcherArgs
    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 WatcherArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WatcherArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WatcherArgs
    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 watcherResource = new Azure.Automation.Watcher("watcherResource", new()
{
    AutomationAccountId = "string",
    ExecutionFrequencyInSeconds = 0,
    ScriptName = "string",
    ScriptRunOn = "string",
    Description = "string",
    Etag = "string",
    Location = "string",
    Name = "string",
    ScriptParameters = 
    {
        { "string", "string" },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := automation.NewWatcher(ctx, "watcherResource", &automation.WatcherArgs{
	AutomationAccountId:         pulumi.String("string"),
	ExecutionFrequencyInSeconds: pulumi.Int(0),
	ScriptName:                  pulumi.String("string"),
	ScriptRunOn:                 pulumi.String("string"),
	Description:                 pulumi.String("string"),
	Etag:                        pulumi.String("string"),
	Location:                    pulumi.String("string"),
	Name:                        pulumi.String("string"),
	ScriptParameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var watcherResource = new Watcher("watcherResource", WatcherArgs.builder()
    .automationAccountId("string")
    .executionFrequencyInSeconds(0)
    .scriptName("string")
    .scriptRunOn("string")
    .description("string")
    .etag("string")
    .location("string")
    .name("string")
    .scriptParameters(Map.of("string", "string"))
    .tags(Map.of("string", "string"))
    .build());

    watcher_resource = azure.automation.Watcher("watcherResource",
    automation_account_id="string",
    execution_frequency_in_seconds=0,
    script_name="string",
    script_run_on="string",
    description="string",
    etag="string",
    location="string",
    name="string",
    script_parameters={
        "string": "string",
    },
    tags={
        "string": "string",
    })

    const watcherResource = new azure.automation.Watcher("watcherResource", {
    automationAccountId: "string",
    executionFrequencyInSeconds: 0,
    scriptName: "string",
    scriptRunOn: "string",
    description: "string",
    etag: "string",
    location: "string",
    name: "string",
    scriptParameters: {
        string: "string",
    },
    tags: {
        string: "string",
    },
});

    type: azure:automation:Watcher
properties:
    automationAccountId: string
    description: string
    etag: string
    executionFrequencyInSeconds: 0
    location: string
    name: string
    scriptName: string
    scriptParameters:
        string: string
    scriptRunOn: string
    tags:
        string: string

    Watcher 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 Watcher resource accepts the following input properties:

    AutomationAccountId string
    The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
    ExecutionFrequencyInSeconds int
    Specify the frequency at which the watcher is invoked.
    ScriptName string
    Specify the name of an existing runbook this watcher is attached to. Changing this forces a new Automation to be created.
    ScriptRunOn string
    Specify the name of the Hybrid work group the watcher will run on.
    Description string
    A description of this Automation Watcher.
    Etag string
    A string of etag assigned to this Automation Watcher.
    Location string
    The Azure Region where the Automation Watcher should exist. Changing this forces a new Automation Watcher to be created.
    Name string
    The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
    ScriptParameters Dictionary<string, string>
    Specifies a list of key-vaule parameters. Changing this forces a new Automation watcher to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Automation Watcher.
    AutomationAccountId string
    The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
    ExecutionFrequencyInSeconds int
    Specify the frequency at which the watcher is invoked.
    ScriptName string
    Specify the name of an existing runbook this watcher is attached to. Changing this forces a new Automation to be created.
    ScriptRunOn string
    Specify the name of the Hybrid work group the watcher will run on.
    Description string
    A description of this Automation Watcher.
    Etag string
    A string of etag assigned to this Automation Watcher.
    Location string
    The Azure Region where the Automation Watcher should exist. Changing this forces a new Automation Watcher to be created.
    Name string
    The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
    ScriptParameters map[string]string
    Specifies a list of key-vaule parameters. Changing this forces a new Automation watcher to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Automation Watcher.
    automationAccountId String
    The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
    executionFrequencyInSeconds Integer
    Specify the frequency at which the watcher is invoked.
    scriptName String
    Specify the name of an existing runbook this watcher is attached to. Changing this forces a new Automation to be created.
    scriptRunOn String
    Specify the name of the Hybrid work group the watcher will run on.
    description String
    A description of this Automation Watcher.
    etag String
    A string of etag assigned to this Automation Watcher.
    location String
    The Azure Region where the Automation Watcher should exist. Changing this forces a new Automation Watcher to be created.
    name String
    The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
    scriptParameters Map<String,String>
    Specifies a list of key-vaule parameters. Changing this forces a new Automation watcher to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Automation Watcher.
    automationAccountId string
    The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
    executionFrequencyInSeconds number
    Specify the frequency at which the watcher is invoked.
    scriptName string
    Specify the name of an existing runbook this watcher is attached to. Changing this forces a new Automation to be created.
    scriptRunOn string
    Specify the name of the Hybrid work group the watcher will run on.
    description string
    A description of this Automation Watcher.
    etag string
    A string of etag assigned to this Automation Watcher.
    location string
    The Azure Region where the Automation Watcher should exist. Changing this forces a new Automation Watcher to be created.
    name string
    The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
    scriptParameters {[key: string]: string}
    Specifies a list of key-vaule parameters. Changing this forces a new Automation watcher to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Automation Watcher.
    automation_account_id str
    The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
    execution_frequency_in_seconds int
    Specify the frequency at which the watcher is invoked.
    script_name str
    Specify the name of an existing runbook this watcher is attached to. Changing this forces a new Automation to be created.
    script_run_on str
    Specify the name of the Hybrid work group the watcher will run on.
    description str
    A description of this Automation Watcher.
    etag str
    A string of etag assigned to this Automation Watcher.
    location str
    The Azure Region where the Automation Watcher should exist. Changing this forces a new Automation Watcher to be created.
    name str
    The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
    script_parameters Mapping[str, str]
    Specifies a list of key-vaule parameters. Changing this forces a new Automation watcher to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Automation Watcher.
    automationAccountId String
    The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
    executionFrequencyInSeconds Number
    Specify the frequency at which the watcher is invoked.
    scriptName String
    Specify the name of an existing runbook this watcher is attached to. Changing this forces a new Automation to be created.
    scriptRunOn String
    Specify the name of the Hybrid work group the watcher will run on.
    description String
    A description of this Automation Watcher.
    etag String
    A string of etag assigned to this Automation Watcher.
    location String
    The Azure Region where the Automation Watcher should exist. Changing this forces a new Automation Watcher to be created.
    name String
    The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
    scriptParameters Map<String>
    Specifies a list of key-vaule parameters. Changing this forces a new Automation watcher to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Automation Watcher.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The current status of the Automation Watcher.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The current status of the Automation Watcher.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The current status of the Automation Watcher.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The current status of the Automation Watcher.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The current status of the Automation Watcher.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The current status of the Automation Watcher.

    Look up Existing Watcher Resource

    Get an existing Watcher 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?: WatcherState, opts?: CustomResourceOptions): Watcher
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automation_account_id: Optional[str] = None,
        description: Optional[str] = None,
        etag: Optional[str] = None,
        execution_frequency_in_seconds: Optional[int] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        script_name: Optional[str] = None,
        script_parameters: Optional[Mapping[str, str]] = None,
        script_run_on: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Watcher
    func GetWatcher(ctx *Context, name string, id IDInput, state *WatcherState, opts ...ResourceOption) (*Watcher, error)
    public static Watcher Get(string name, Input<string> id, WatcherState? state, CustomResourceOptions? opts = null)
    public static Watcher get(String name, Output<String> id, WatcherState 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:
    AutomationAccountId string
    The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
    Description string
    A description of this Automation Watcher.
    Etag string
    A string of etag assigned to this Automation Watcher.
    ExecutionFrequencyInSeconds int
    Specify the frequency at which the watcher is invoked.
    Location string
    The Azure Region where the Automation Watcher should exist. Changing this forces a new Automation Watcher to be created.
    Name string
    The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
    ScriptName string
    Specify the name of an existing runbook this watcher is attached to. Changing this forces a new Automation to be created.
    ScriptParameters Dictionary<string, string>
    Specifies a list of key-vaule parameters. Changing this forces a new Automation watcher to be created.
    ScriptRunOn string
    Specify the name of the Hybrid work group the watcher will run on.
    Status string
    The current status of the Automation Watcher.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Automation Watcher.
    AutomationAccountId string
    The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
    Description string
    A description of this Automation Watcher.
    Etag string
    A string of etag assigned to this Automation Watcher.
    ExecutionFrequencyInSeconds int
    Specify the frequency at which the watcher is invoked.
    Location string
    The Azure Region where the Automation Watcher should exist. Changing this forces a new Automation Watcher to be created.
    Name string
    The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
    ScriptName string
    Specify the name of an existing runbook this watcher is attached to. Changing this forces a new Automation to be created.
    ScriptParameters map[string]string
    Specifies a list of key-vaule parameters. Changing this forces a new Automation watcher to be created.
    ScriptRunOn string
    Specify the name of the Hybrid work group the watcher will run on.
    Status string
    The current status of the Automation Watcher.
    Tags map[string]string
    A mapping of tags which should be assigned to the Automation Watcher.
    automationAccountId String
    The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
    description String
    A description of this Automation Watcher.
    etag String
    A string of etag assigned to this Automation Watcher.
    executionFrequencyInSeconds Integer
    Specify the frequency at which the watcher is invoked.
    location String
    The Azure Region where the Automation Watcher should exist. Changing this forces a new Automation Watcher to be created.
    name String
    The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
    scriptName String
    Specify the name of an existing runbook this watcher is attached to. Changing this forces a new Automation to be created.
    scriptParameters Map<String,String>
    Specifies a list of key-vaule parameters. Changing this forces a new Automation watcher to be created.
    scriptRunOn String
    Specify the name of the Hybrid work group the watcher will run on.
    status String
    The current status of the Automation Watcher.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Automation Watcher.
    automationAccountId string
    The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
    description string
    A description of this Automation Watcher.
    etag string
    A string of etag assigned to this Automation Watcher.
    executionFrequencyInSeconds number
    Specify the frequency at which the watcher is invoked.
    location string
    The Azure Region where the Automation Watcher should exist. Changing this forces a new Automation Watcher to be created.
    name string
    The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
    scriptName string
    Specify the name of an existing runbook this watcher is attached to. Changing this forces a new Automation to be created.
    scriptParameters {[key: string]: string}
    Specifies a list of key-vaule parameters. Changing this forces a new Automation watcher to be created.
    scriptRunOn string
    Specify the name of the Hybrid work group the watcher will run on.
    status string
    The current status of the Automation Watcher.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Automation Watcher.
    automation_account_id str
    The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
    description str
    A description of this Automation Watcher.
    etag str
    A string of etag assigned to this Automation Watcher.
    execution_frequency_in_seconds int
    Specify the frequency at which the watcher is invoked.
    location str
    The Azure Region where the Automation Watcher should exist. Changing this forces a new Automation Watcher to be created.
    name str
    The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
    script_name str
    Specify the name of an existing runbook this watcher is attached to. Changing this forces a new Automation to be created.
    script_parameters Mapping[str, str]
    Specifies a list of key-vaule parameters. Changing this forces a new Automation watcher to be created.
    script_run_on str
    Specify the name of the Hybrid work group the watcher will run on.
    status str
    The current status of the Automation Watcher.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Automation Watcher.
    automationAccountId String
    The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
    description String
    A description of this Automation Watcher.
    etag String
    A string of etag assigned to this Automation Watcher.
    executionFrequencyInSeconds Number
    Specify the frequency at which the watcher is invoked.
    location String
    The Azure Region where the Automation Watcher should exist. Changing this forces a new Automation Watcher to be created.
    name String
    The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
    scriptName String
    Specify the name of an existing runbook this watcher is attached to. Changing this forces a new Automation to be created.
    scriptParameters Map<String>
    Specifies a list of key-vaule parameters. Changing this forces a new Automation watcher to be created.
    scriptRunOn String
    Specify the name of the Hybrid work group the watcher will run on.
    status String
    The current status of the Automation Watcher.
    tags Map<String>
    A mapping of tags which should be assigned to the Automation Watcher.

    Import

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

    $ pulumi import azure:automation/watcher:Watcher example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/group1/providers/Microsoft.Automation/automationAccounts/account1/watchers/watch1

    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