Share via

Webhook Class

An object that represents a webhook for a container registry.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

Webhook(*, ___location: str, tags: Dict[str, str] | None = None, status: str | _models.WebhookStatus | None = None, scope: str | None = None, actions: List[str | _models.WebhookAction] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
___location
str

The ___location of the resource. This cannot be changed after the resource is created. Required.
tags
dict[str, str]

The tags of the resource.

Default value: None
status
str or WebhookStatus

The status of the webhook at the time the operation was called. Known values are: "enabled" and "disabled".

Default value: None
scope
str

The scope of repositories where the event can be triggered. For example, 'foo:>>*<<' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.

Default value: None
actions
list[str or WebhookAction]

The list of actions that trigger the webhook to post notifications.

Default value: None

Variables

Name Description
id
str

The resource ID.
name
str

The name of the resource.
type
str

The type of the resource.
___location
str

The ___location of the resource. This cannot be changed after the resource is created. Required.
tags
dict[str, str]

The tags of the resource.
system_data
SystemData

Metadata pertaining to creation and last modification of the resource.
status
str or WebhookStatus

The status of the webhook at the time the operation was called. Known values are: "enabled" and "disabled".
scope
str

The scope of repositories where the event can be triggered. For example, 'foo:>>*<<' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.
actions
list[str or WebhookAction]

The list of actions that trigger the webhook to post notifications.
provisioning_state
str or ProvisioningState

The provisioning state of the webhook at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled".