Share via


WebhooksOperations interface

Interface representing a Webhooks operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
create

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

delete
get

Gets the properties of the specified webhook.

getCallbackConfig

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

list

Lists all the webhooks for the specified container registry.

listEvents

Lists recent events for the specified webhook.

ping

Triggers a ping event to be sent to the webhook.

update

Updates a webhook with the specified parameters.

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, registryName: string, webhookName: string, webhookCreateParameters: WebhookCreateParameters, options?: WebhooksCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Webhook>, Webhook>>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, webhookCreateParameters: WebhookCreateParameters, options?: WebhooksCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Webhook>, Webhook>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, registryName: string, webhookName: string, webhookCreateParameters: WebhookCreateParameters, options?: WebhooksCreateOptionalParams) => Promise<Webhook>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, webhookCreateParameters: WebhookCreateParameters, options?: WebhooksCreateOptionalParams) => Promise<Webhook>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksDeleteOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, registryName: string, webhookName: string, webhookUpdateParameters: WebhookUpdateParameters, options?: WebhooksUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Webhook>, Webhook>>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, webhookUpdateParameters: WebhookUpdateParameters, options?: WebhooksUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Webhook>, Webhook>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, registryName: string, webhookName: string, webhookUpdateParameters: WebhookUpdateParameters, options?: WebhooksUpdateOptionalParams) => Promise<Webhook>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, webhookUpdateParameters: WebhookUpdateParameters, options?: WebhooksUpdateOptionalParams) => Promise<Webhook>

create

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

create: (resourceGroupName: string, registryName: string, webhookName: string, webhookCreateParameters: WebhookCreateParameters, options?: WebhooksCreateOptionalParams) => PollerLike<OperationState<Webhook>, Webhook>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, webhookCreateParameters: WebhookCreateParameters, options?: WebhooksCreateOptionalParams) => PollerLike<OperationState<Webhook>, Webhook>

delete

delete: (resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the properties of the specified webhook.

get: (resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksGetOptionalParams) => Promise<Webhook>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksGetOptionalParams) => Promise<Webhook>

getCallbackConfig

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

getCallbackConfig: (resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksGetCallbackConfigOptionalParams) => Promise<CallbackConfig>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksGetCallbackConfigOptionalParams) => Promise<CallbackConfig>

list

Lists all the webhooks for the specified container registry.

list: (resourceGroupName: string, registryName: string, options?: WebhooksListOptionalParams) => PagedAsyncIterableIterator<Webhook, Webhook[], PageSettings>

Property Value

(resourceGroupName: string, registryName: string, options?: WebhooksListOptionalParams) => PagedAsyncIterableIterator<Webhook, Webhook[], PageSettings>

listEvents

Lists recent events for the specified webhook.

listEvents: (resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksListEventsOptionalParams) => PagedAsyncIterableIterator<Event, Event[], PageSettings>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksListEventsOptionalParams) => PagedAsyncIterableIterator<Event, Event[], PageSettings>

ping

Triggers a ping event to be sent to the webhook.

ping: (resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksPingOptionalParams) => Promise<EventInfo>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksPingOptionalParams) => Promise<EventInfo>

update

Updates a webhook with the specified parameters.

update: (resourceGroupName: string, registryName: string, webhookName: string, webhookUpdateParameters: WebhookUpdateParameters, options?: WebhooksUpdateOptionalParams) => PollerLike<OperationState<Webhook>, Webhook>

Property Value

(resourceGroupName: string, registryName: string, webhookName: string, webhookUpdateParameters: WebhookUpdateParameters, options?: WebhooksUpdateOptionalParams) => PollerLike<OperationState<Webhook>, Webhook>