WebhooksOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerRegistryManagementClient's

<xref:webhooks> attribute.

Inheritance

builtins.object

WebhooksOperations

Constructor

WebhooksOperations(*args, **kwargs)

Methods

begin_create	Creates a webhook for a container registry with the specified parameters.
begin_delete	Deletes a webhook from a container registry.
begin_update	Updates a webhook with the specified parameters.
get	Gets the properties of the specified webhook.
get_callback_config	Gets the configuration of service URI and custom headers for the webhook.
list	Lists all the webhooks for the specified container registry.
list_events	Lists recent events for the specified webhook.
ping	Triggers a ping event to be sent to the webhook.

begin_create

Creates a webhook for a container registry with the specified parameters.

async begin_create(resource_group_name: str, registry_name: str, webhook_name: str, webhook_create_parameters: _models.WebhookCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Webhook]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.
webhook_name Required	str The name of the webhook. Required.
webhook_create_parameters Required	WebhookCreateParameters or IO The parameters for creating a webhook. Is either a WebhookCreateParameters type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[Webhook]	An instance of AsyncLROPoller that returns either Webhook or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a webhook from a container registry.

async begin_delete(resource_group_name: str, registry_name: str, webhook_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.
webhook_name Required	str The name of the webhook. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates a webhook with the specified parameters.

async begin_update(resource_group_name: str, registry_name: str, webhook_name: str, webhook_update_parameters: _models.WebhookUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Webhook]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.
webhook_name Required	str The name of the webhook. Required.
webhook_update_parameters Required	WebhookUpdateParameters or IO The parameters for updating a webhook. Is either a WebhookUpdateParameters type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[Webhook]	An instance of AsyncLROPoller that returns either Webhook or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the properties of the specified webhook.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.
webhook_name Required	str The name of the webhook. Required.

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

get_callback_config

Gets the configuration of service URI and custom headers for the webhook.

async get_callback_config(resource_group_name: str, registry_name: str, webhook_name: str, **kwargs: Any) -> CallbackConfig

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.
webhook_name Required	str The name of the webhook. Required.

Keyword-Only Parameters

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

Returns

Type	Description
CallbackConfig	CallbackConfig or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists all the webhooks for the specified container registry.

list(resource_group_name: str, registry_name: str, **kwargs: Any) -> AsyncIterable[Webhook]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_events

Lists recent events for the specified webhook.

list_events(resource_group_name: str, registry_name: str, webhook_name: str, **kwargs: Any) -> AsyncIterable[Event]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.
webhook_name Required	str The name of the webhook. Required.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

ping

Triggers a ping event to be sent to the webhook.

async ping(resource_group_name: str, registry_name: str, webhook_name: str, **kwargs: Any) -> EventInfo

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.
webhook_name Required	str The name of the webhook. Required.

Keyword-Only Parameters

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

Returns

Type	Description
EventInfo	EventInfo or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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