Webhooks interface
Interface representing a Webhooks.
Methods
Method Details
beginCreate(string, string, string, WebhookCreateParameters, WebhooksCreateOptionalParams)
Creates a webhook for a container registry with the specified parameters.
function beginCreate(resourceGroupName: string, registryName: string, webhookName: string, webhookCreateParameters: WebhookCreateParameters, options?: WebhooksCreateOptionalParams): Promise<SimplePollerLike<OperationState<Webhook>, Webhook>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- webhookName
-
string
The name of the webhook.
- webhookCreateParameters
- WebhookCreateParameters
The parameters for creating a webhook.
- options
- WebhooksCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Webhook>, Webhook>>
beginCreateAndWait(string, string, string, WebhookCreateParameters, WebhooksCreateOptionalParams)
Creates a webhook for a container registry with the specified parameters.
function beginCreateAndWait(resourceGroupName: string, registryName: string, webhookName: string, webhookCreateParameters: WebhookCreateParameters, options?: WebhooksCreateOptionalParams): Promise<Webhook>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- webhookName
-
string
The name of the webhook.
- webhookCreateParameters
- WebhookCreateParameters
The parameters for creating a webhook.
- options
- WebhooksCreateOptionalParams
The options parameters.
Returns
Promise<Webhook>
beginDelete(string, string, string, WebhooksDeleteOptionalParams)
Deletes a webhook from a container registry.
function beginDelete(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- webhookName
-
string
The name of the webhook.
- options
- WebhooksDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, WebhooksDeleteOptionalParams)
Deletes a webhook from a container registry.
function beginDeleteAndWait(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- webhookName
-
string
The name of the webhook.
- options
- WebhooksDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, WebhookUpdateParameters, WebhooksUpdateOptionalParams)
Updates a webhook with the specified parameters.
function beginUpdate(resourceGroupName: string, registryName: string, webhookName: string, webhookUpdateParameters: WebhookUpdateParameters, options?: WebhooksUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Webhook>, Webhook>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- webhookName
-
string
The name of the webhook.
- webhookUpdateParameters
- WebhookUpdateParameters
The parameters for updating a webhook.
- options
- WebhooksUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Webhook>, Webhook>>
beginUpdateAndWait(string, string, string, WebhookUpdateParameters, WebhooksUpdateOptionalParams)
Updates a webhook with the specified parameters.
function beginUpdateAndWait(resourceGroupName: string, registryName: string, webhookName: string, webhookUpdateParameters: WebhookUpdateParameters, options?: WebhooksUpdateOptionalParams): Promise<Webhook>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- webhookName
-
string
The name of the webhook.
- webhookUpdateParameters
- WebhookUpdateParameters
The parameters for updating a webhook.
- options
- WebhooksUpdateOptionalParams
The options parameters.
Returns
Promise<Webhook>
get(string, string, string, WebhooksGetOptionalParams)
Gets the properties of the specified webhook.
function get(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksGetOptionalParams): Promise<Webhook>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- webhookName
-
string
The name of the webhook.
- options
- WebhooksGetOptionalParams
The options parameters.
Returns
Promise<Webhook>
getCallbackConfig(string, string, string, WebhooksGetCallbackConfigOptionalParams)
Gets the configuration of service URI and custom headers for the webhook.
function getCallbackConfig(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksGetCallbackConfigOptionalParams): Promise<CallbackConfig>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- webhookName
-
string
The name of the webhook.
The options parameters.
Returns
Promise<CallbackConfig>
list(string, string, WebhooksListOptionalParams)
Lists all the webhooks for the specified container registry.
function list(resourceGroupName: string, registryName: string, options?: WebhooksListOptionalParams): PagedAsyncIterableIterator<Webhook, Webhook[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- options
- WebhooksListOptionalParams
The options parameters.
Returns
listEvents(string, string, string, WebhooksListEventsOptionalParams)
Lists recent events for the specified webhook.
function listEvents(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksListEventsOptionalParams): PagedAsyncIterableIterator<Event_2, Event_2[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- webhookName
-
string
The name of the webhook.
- options
- WebhooksListEventsOptionalParams
The options parameters.
Returns
ping(string, string, string, WebhooksPingOptionalParams)
Triggers a ping event to be sent to the webhook.
function ping(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksPingOptionalParams): Promise<EventInfo>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- webhookName
-
string
The name of the webhook.
- options
- WebhooksPingOptionalParams
The options parameters.
Returns
Promise<EventInfo>