WatcherOperations Class

WatcherOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

WatcherOperations

Constructor

WatcherOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

Methods

create_or_update	Create the watcher identified by watcher name.
delete	Delete the watcher by name.
get	Retrieve the watcher identified by watcher name.
list_by_automation_account	Retrieve a list of watchers.
start	Resume the watcher identified by watcher name.
stop	Resume the watcher identified by watcher name.
update	Update the watcher identified by watcher name.

create_or_update

Create the watcher identified by watcher name.

async create_or_update(resource_group_name: str, automation_account_name: str, watcher_name: str, parameters: Watcher, **kwargs) -> Watcher

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
watcher_name Required	str The watcher name.
parameters Required	Watcher The create or update parameters for watcher.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Watcher	Watcher, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Delete the watcher by name.

async delete(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs) -> None

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
watcher_name Required	str The watcher name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Retrieve the watcher identified by watcher name.

async get(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs) -> Watcher

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
watcher_name Required	str The watcher name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Watcher	Watcher, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_automation_account

Retrieve a list of watchers.

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: str | None = None, **kwargs) -> AsyncIterable[WatcherListResult]

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
filter	str The filter to apply on the operation. default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[WatcherListResult]	An iterator like instance of either WatcherListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

start

Resume the watcher identified by watcher name.

async start(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs) -> None

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
watcher_name Required	str The watcher name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

stop

Resume the watcher identified by watcher name.

async stop(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs) -> None

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
watcher_name Required	str The watcher name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Update the watcher identified by watcher name.

async update(resource_group_name: str, automation_account_name: str, watcher_name: str, parameters: WatcherUpdateParameters, **kwargs) -> Watcher

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
watcher_name Required	str The watcher name.
parameters Required	WatcherUpdateParameters The update parameters for watcher.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Watcher	Watcher, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.automation.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\automation\\models\\__init__.py'>