WebhooksOperations Class
WebhooksOperations 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.objectWebhooksOperations
Constructor
WebhooksOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
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: azure.mgmt.containerregistry.v2021_08_01_preview.models._models_py3.WebhookCreateParameters, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.containerregistry.v2021_08_01_preview.models._models_py3.Webhook]Parameters
- resource_group_name
- str
The name of the resource group to which the container registry belongs.
- 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
An instance of AsyncLROPoller that returns either Webhook or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes a webhook from a container registry.
async begin_delete(resource_group_name: str, registry_name: str, webhook_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- resource_group_name
- str
The name of the resource group to which the container registry belongs.
- 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
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
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: azure.mgmt.containerregistry.v2021_08_01_preview.models._models_py3.WebhookUpdateParameters, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.containerregistry.v2021_08_01_preview.models._models_py3.Webhook]Parameters
- resource_group_name
- str
The name of the resource group to which the container registry belongs.
- 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
An instance of AsyncLROPoller that returns either Webhook or the result of cls(response)
Return type
Exceptions
get
Gets the properties of the specified webhook.
async get(resource_group_name: str, registry_name: str, webhook_name: str, **kwargs: Any) -> azure.mgmt.containerregistry.v2021_08_01_preview.models._models_py3.WebhookParameters
- resource_group_name
- str
The name of the resource group to which the container registry belongs.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Webhook, or the result of cls(response)
Return type
Exceptions
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) -> azure.mgmt.containerregistry.v2021_08_01_preview.models._models_py3.CallbackConfigParameters
- resource_group_name
- str
The name of the resource group to which the container registry belongs.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
CallbackConfig, or the result of cls(response)
Return type
Exceptions
list
Lists all the webhooks for the specified container registry.
list(resource_group_name: str, registry_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.containerregistry.v2021_08_01_preview.models._models_py3.WebhookListResult]Parameters
- resource_group_name
- str
The name of the resource group to which the container registry belongs.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either WebhookListResult or the result of cls(response)
Return type
Exceptions
list_events
Lists recent events for the specified webhook.
list_events(resource_group_name: str, registry_name: str, webhook_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.containerregistry.v2021_08_01_preview.models._models_py3.EventListResult]Parameters
- resource_group_name
- str
The name of the resource group to which the container registry belongs.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either EventListResult or the result of cls(response)
Return type
Exceptions
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) -> azure.mgmt.containerregistry.v2021_08_01_preview.models._models_py3.EventInfoParameters
- resource_group_name
- str
The name of the resource group to which the container registry belongs.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
EventInfo, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.containerregistry.v2021_08_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\containerregistry\\v2021_08_01_preview\\models\\__init__.py'>Feedback
Submit and view feedback for