@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getWatcher(args: GetWatcherArgs, opts?: pulumi.InvokeOptions): Promise<GetWatcherResult>;
export interface GetWatcherArgs {
/**
* The name of the automation account.
*/
automationAccountName: string;
/**
* Name of an Azure Resource group.
*/
resourceGroupName: string;
/**
* The watcher name.
*/
watcherName: string;
}
/**
* Definition of the watcher type.
*/
export interface GetWatcherResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Gets or sets the creation time.
*/
readonly creationTime: string;
/**
* Gets or sets the description.
*/
readonly description?: string;
/**
* Gets or sets the etag of the resource.
*/
readonly etag?: string;
/**
* Gets or sets the frequency at which the watcher is invoked.
*/
readonly executionFrequencyInSeconds?: number;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* Details of the user who last modified the watcher.
*/
readonly lastModifiedBy: string;
/**
* Gets or sets the last modified time.
*/
readonly lastModifiedTime: string;
/**
* The geo-location where the resource lives
*/
readonly location?: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.
*/
readonly scriptName?: string;
/**
* Gets or sets the parameters of the script.
*/
readonly scriptParameters?: {
[key: string]: string;
};
/**
* Gets or sets the name of the hybrid worker group the watcher will run on.
*/
readonly scriptRunOn?: string;
/**
* Gets the current status of the watcher.
*/
readonly status: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.automation.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
}
/**
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getWatcherOutput(args: GetWatcherOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWatcherResult>;
export interface GetWatcherOutputArgs {
/**
* The name of the automation account.
*/
automationAccountName: pulumi.Input<string>;
/**
* Name of an Azure Resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The watcher name.
*/
watcherName: pulumi.Input<string>;
}