WebhookOperations Class

WebhookOperations 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

WebhookOperations

Constructor

WebhookOperations(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 webhook identified by webhook name.
delete	Delete the webhook by name.
generate_uri	Generates a Uri for use in creating a webhook.
get	Retrieve the webhook identified by webhook name.
list_by_automation_account	Retrieve a list of webhooks.
update	Update the webhook identified by webhook name.

create_or_update

Create the webhook identified by webhook name.

async create_or_update(resource_group_name: str, automation_account_name: str, webhook_name: str, parameters: WebhookCreateOrUpdateParameters, **kwargs) -> Webhook

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.
webhook_name Required	str The webhook name.
parameters Required	WebhookCreateOrUpdateParameters The create or update parameters for webhook.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

delete

Delete the webhook by name.

async delete(resource_group_name: str, automation_account_name: str, webhook_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.
webhook_name Required	str The webhook 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

generate_uri

Generates a Uri for use in creating a webhook.

async generate_uri(resource_group_name: str, automation_account_name: str, **kwargs) -> str

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.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Retrieve the webhook identified by webhook name.

async get(resource_group_name: str, automation_account_name: str, webhook_name: str, **kwargs) -> Webhook

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.
webhook_name Required	str The webhook name.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_automation_account

Retrieve a list of webhooks.

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

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[WebhookListResult]	An iterator like instance of either WebhookListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Update the webhook identified by webhook name.

async update(resource_group_name: str, automation_account_name: str, webhook_name: str, parameters: WebhookUpdateParameters, **kwargs) -> Webhook

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.
webhook_name Required	str The webhook name.
parameters Required	WebhookUpdateParameters The update parameters for webhook.

Keyword-Only Parameters

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

Returns

Type	Description
Webhook	Webhook, 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'>