Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. automation
  5. getWatcher
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.automation.getWatcher

Explore with Pulumi AI

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieve the watcher identified by watcher name.

Uses Azure REST API version 2023-05-15-preview.

Other available API versions: 2015-10-31, 2019-06-01, 2020-01-13-preview, 2024-10-23. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native automation [ApiVersion]. See the version guide for details.

Using getWatcher

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWatcher(args: GetWatcherArgs, opts?: InvokeOptions): Promise<GetWatcherResult>
function getWatcherOutput(args: GetWatcherOutputArgs, opts?: InvokeOptions): Output<GetWatcherResult>
Copy
def get_watcher(automation_account_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                watcher_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetWatcherResult
def get_watcher_output(automation_account_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                watcher_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetWatcherResult]
Copy
func LookupWatcher(ctx *Context, args *LookupWatcherArgs, opts ...InvokeOption) (*LookupWatcherResult, error)
func LookupWatcherOutput(ctx *Context, args *LookupWatcherOutputArgs, opts ...InvokeOption) LookupWatcherResultOutput
Copy

> Note: This function is named LookupWatcher in the Go SDK.

public static class GetWatcher 
{
    public static Task<GetWatcherResult> InvokeAsync(GetWatcherArgs args, InvokeOptions? opts = null)
    public static Output<GetWatcherResult> Invoke(GetWatcherInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWatcherResult> getWatcher(GetWatcherArgs args, InvokeOptions options)
public static Output<GetWatcherResult> getWatcher(GetWatcherArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:automation:getWatcher
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AutomationAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the automation account.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure Resource group.
WatcherName
This property is required.
Changes to this property will trigger replacement.
string
The watcher name.
AutomationAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the automation account.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure Resource group.
WatcherName
This property is required.
Changes to this property will trigger replacement.
string
The watcher name.
automationAccountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the automation account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure Resource group.
watcherName
This property is required.
Changes to this property will trigger replacement.
String
The watcher name.
automationAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the automation account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure Resource group.
watcherName
This property is required.
Changes to this property will trigger replacement.
string
The watcher name.
automation_account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the automation account.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of an Azure Resource group.
watcher_name
This property is required.
Changes to this property will trigger replacement.
str
The watcher name.
automationAccountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the automation account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure Resource group.
watcherName
This property is required.
Changes to this property will trigger replacement.
String
The watcher name.

getWatcher Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
CreationTime string
Gets or sets the creation time.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
LastModifiedBy string
Details of the user who last modified the watcher.
LastModifiedTime string
Gets or sets the last modified time.
Name string
The name of the resource
Status string
Gets the current status of the watcher.
SystemData Pulumi.AzureNative.Automation.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string
Gets or sets the description.
Etag string
Gets or sets the etag of the resource.
ExecutionFrequencyInSeconds double
Gets or sets the frequency at which the watcher is invoked.
Location string
The geo-location where the resource lives
ScriptName string
Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.
ScriptParameters Dictionary<string, string>
Gets or sets the parameters of the script.
ScriptRunOn string
Gets or sets the name of the hybrid worker group the watcher will run on.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
CreationTime string
Gets or sets the creation time.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
LastModifiedBy string
Details of the user who last modified the watcher.
LastModifiedTime string
Gets or sets the last modified time.
Name string
The name of the resource
Status string
Gets the current status of the watcher.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string
Gets or sets the description.
Etag string
Gets or sets the etag of the resource.
ExecutionFrequencyInSeconds float64
Gets or sets the frequency at which the watcher is invoked.
Location string
The geo-location where the resource lives
ScriptName string
Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.
ScriptParameters map[string]string
Gets or sets the parameters of the script.
ScriptRunOn string
Gets or sets the name of the hybrid worker group the watcher will run on.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
creationTime String
Gets or sets the creation time.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
lastModifiedBy String
Details of the user who last modified the watcher.
lastModifiedTime String
Gets or sets the last modified time.
name String
The name of the resource
status String
Gets the current status of the watcher.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String
Gets or sets the description.
etag String
Gets or sets the etag of the resource.
executionFrequencyInSeconds Double
Gets or sets the frequency at which the watcher is invoked.
location String
The geo-location where the resource lives
scriptName String
Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.
scriptParameters Map<String,String>
Gets or sets the parameters of the script.
scriptRunOn String
Gets or sets the name of the hybrid worker group the watcher will run on.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
creationTime string
Gets or sets the creation time.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
lastModifiedBy string
Details of the user who last modified the watcher.
lastModifiedTime string
Gets or sets the last modified time.
name string
The name of the resource
status string
Gets the current status of the watcher.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description string
Gets or sets the description.
etag string
Gets or sets the etag of the resource.
executionFrequencyInSeconds number
Gets or sets the frequency at which the watcher is invoked.
location string
The geo-location where the resource lives
scriptName string
Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.
scriptParameters {[key: string]: string}
Gets or sets the parameters of the script.
scriptRunOn string
Gets or sets the name of the hybrid worker group the watcher will run on.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
creation_time str
Gets or sets the creation time.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
last_modified_by str
Details of the user who last modified the watcher.
last_modified_time str
Gets or sets the last modified time.
name str
The name of the resource
status str
Gets the current status of the watcher.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description str
Gets or sets the description.
etag str
Gets or sets the etag of the resource.
execution_frequency_in_seconds float
Gets or sets the frequency at which the watcher is invoked.
location str
The geo-location where the resource lives
script_name str
Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.
script_parameters Mapping[str, str]
Gets or sets the parameters of the script.
script_run_on str
Gets or sets the name of the hybrid worker group the watcher will run on.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
creationTime String
Gets or sets the creation time.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
lastModifiedBy String
Details of the user who last modified the watcher.
lastModifiedTime String
Gets or sets the last modified time.
name String
The name of the resource
status String
Gets the current status of the watcher.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String
Gets or sets the description.
etag String
Gets or sets the etag of the resource.
executionFrequencyInSeconds Number
Gets or sets the frequency at which the watcher is invoked.
location String
The geo-location where the resource lives
scriptName String
Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.
scriptParameters Map<String>
Gets or sets the parameters of the script.
scriptRunOn String
Gets or sets the name of the hybrid worker group the watcher will run on.
tags Map<String>
Resource tags.

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native