Package version:

Interface Webhooks

Interface representing a Webhooks.

Hierarchy

Webhooks

Index

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get getCallbackConfig list listEvents ping

Methods

beginCreate

beginCreate(resourceGroupName: string, registryName: string, webhookName: string, webhookCreateParameters: WebhookCreateParameters, options?: WebhooksCreateOptionalParams): Promise<PollerLike<PollOperationState<Webhook>, Webhook>>
Creates a webhook for a container registry with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- webhookName: string
  
  The name of the webhook.
- webhookCreateParameters: WebhookCreateParameters
  
  The parameters for creating a webhook.
- Optional options: WebhooksCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<Webhook>, Webhook>>
- Defined in operationsInterfaces/webhooks.ts:79

beginCreateAndWait

beginCreateAndWait(resourceGroupName: string, registryName: string, webhookName: string, webhookCreateParameters: WebhookCreateParameters, options?: WebhooksCreateOptionalParams): Promise<Webhook>
Creates a webhook for a container registry with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- webhookName: string
  
  The name of the webhook.
- webhookCreateParameters: WebhookCreateParameters
  
  The parameters for creating a webhook.
- Optional options: WebhooksCreateOptionalParams
  
  The options parameters.
Returns Promise<Webhook>
- Defined in operationsInterfaces/webhooks.ts:99

beginDelete

beginDelete(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes a webhook from a container registry.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- webhookName: string
  
  The name of the webhook.
- Optional options: WebhooksDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/webhooks.ts:113

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksDeleteOptionalParams): Promise<void>
Deletes a webhook from a container registry.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- webhookName: string
  
  The name of the webhook.
- Optional options: WebhooksDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/webhooks.ts:126

beginUpdate

beginUpdate(resourceGroupName: string, registryName: string, webhookName: string, webhookUpdateParameters: WebhookUpdateParameters, options?: WebhooksUpdateOptionalParams): Promise<PollerLike<PollOperationState<Webhook>, Webhook>>
Updates a webhook with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- webhookName: string
  
  The name of the webhook.
- webhookUpdateParameters: WebhookUpdateParameters
  
  The parameters for updating a webhook.
- Optional options: WebhooksUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<Webhook>, Webhook>>
- Defined in operationsInterfaces/webhooks.ts:140

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, registryName: string, webhookName: string, webhookUpdateParameters: WebhookUpdateParameters, options?: WebhooksUpdateOptionalParams): Promise<Webhook>
Updates a webhook with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- webhookName: string
  
  The name of the webhook.
- webhookUpdateParameters: WebhookUpdateParameters
  
  The parameters for updating a webhook.
- Optional options: WebhooksUpdateOptionalParams
  
  The options parameters.
Returns Promise<Webhook>
- Defined in operationsInterfaces/webhooks.ts:160

get

get(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksGetOptionalParams): Promise<Webhook>
Gets the properties of the specified webhook.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- webhookName: string
  
  The name of the webhook.
- Optional options: WebhooksGetOptionalParams
  
  The options parameters.
Returns Promise<Webhook>
- Defined in operationsInterfaces/webhooks.ts:65

getCallbackConfig

getCallbackConfig(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksGetCallbackConfigOptionalParams): Promise<CallbackConfig>
Gets the configuration of service URI and custom headers for the webhook.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- webhookName: string
  
  The name of the webhook.
- Optional options: WebhooksGetCallbackConfigOptionalParams
  
  The options parameters.
Returns Promise<CallbackConfig>
- Defined in operationsInterfaces/webhooks.ts:187

list

list(resourceGroupName: string, registryName: string, options?: WebhooksListOptionalParams): PagedAsyncIterableIterator<Webhook>
Lists all the webhooks for the specified container registry.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- Optional options: WebhooksListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Webhook>
- Defined in operationsInterfaces/webhooks.ts:40

listEvents

listEvents(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksListEventsOptionalParams): PagedAsyncIterableIterator<Event>
Lists recent events for the specified webhook.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- webhookName: string
  
  The name of the webhook.
- Optional options: WebhooksListEventsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Event>
- Defined in operationsInterfaces/webhooks.ts:52

ping

ping(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksPingOptionalParams): Promise<EventInfo>
Triggers a ping event to be sent to the webhook.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- webhookName: string
  
  The name of the webhook.
- Optional options: WebhooksPingOptionalParams
  
  The options parameters.
Returns Promise<EventInfo>
- Defined in operationsInterfaces/webhooks.ts:174

Interface Webhooks

Hierarchy

Index

Methods

Methods

beginCreate

Parameters

resourceGroupName: string

registryName: string

webhookName: string

webhookCreateParameters: WebhookCreateParameters

Optional options: WebhooksCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<Webhook>, Webhook>>

beginCreateAndWait

Parameters

resourceGroupName: string

registryName: string

webhookName: string

webhookCreateParameters: WebhookCreateParameters

Optional options: WebhooksCreateOptionalParams

Returns Promise<Webhook>

beginDelete

Parameters

resourceGroupName: string

registryName: string

webhookName: string

Optional options: WebhooksDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

registryName: string

webhookName: string

Optional options: WebhooksDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

registryName: string

webhookName: string

webhookUpdateParameters: WebhookUpdateParameters

Optional options: WebhooksUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<Webhook>, Webhook>>

beginUpdateAndWait

Parameters

resourceGroupName: string

registryName: string

webhookName: string

webhookUpdateParameters: WebhookUpdateParameters

Optional options: WebhooksUpdateOptionalParams

Returns Promise<Webhook>

get

Parameters

resourceGroupName: string

registryName: string

webhookName: string

Optional options: WebhooksGetOptionalParams

Returns Promise<Webhook>

getCallbackConfig

Parameters

resourceGroupName: string

registryName: string

webhookName: string

Optional options: WebhooksGetCallbackConfigOptionalParams

Returns Promise<CallbackConfig>

list

Parameters

resourceGroupName: string

registryName: string

Optional options: WebhooksListOptionalParams

Returns PagedAsyncIterableIterator<Webhook>

listEvents

Parameters

resourceGroupName: string

registryName: string

webhookName: string

Optional options: WebhooksListEventsOptionalParams

Returns PagedAsyncIterableIterator<Event>

ping

Parameters

`Optional` options: WebhooksCreateOptionalParams

`Optional` options: WebhooksCreateOptionalParams

`Optional` options: WebhooksDeleteOptionalParams

`Optional` options: WebhooksDeleteOptionalParams

`Optional` options: WebhooksUpdateOptionalParams

`Optional` options: WebhooksUpdateOptionalParams

`Optional` options: WebhooksGetOptionalParams

`Optional` options: WebhooksGetCallbackConfigOptionalParams

`Optional` options: WebhooksListOptionalParams

`Optional` options: WebhooksListEventsOptionalParams

`Optional` options: WebhooksPingOptionalParams