Package version:

Interface Webhooks

Interface representing a Webhooks.

interface Webhooks {
    beginCreate(resourceGroupName: string, registryName: string, webhookName: string, webhookCreateParameters: WebhookCreateParameters, options?: WebhooksCreateOptionalParams): Promise<SimplePollerLike<OperationState<Webhook>, Webhook>>;
    beginCreateAndWait(resourceGroupName: string, registryName: string, webhookName: string, webhookCreateParameters: WebhookCreateParameters, options?: WebhooksCreateOptionalParams): Promise<Webhook>;
    beginDelete(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksDeleteOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, registryName: string, webhookName: string, webhookUpdateParameters: WebhookUpdateParameters, options?: WebhooksUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Webhook>, Webhook>>;
    beginUpdateAndWait(resourceGroupName: string, registryName: string, webhookName: string, webhookUpdateParameters: WebhookUpdateParameters, options?: WebhooksUpdateOptionalParams): Promise<Webhook>;
    get(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksGetOptionalParams): Promise<Webhook>;
    getCallbackConfig(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksGetCallbackConfigOptionalParams): Promise<CallbackConfig>;
    list(resourceGroupName: string, registryName: string, options?: WebhooksListOptionalParams): PagedAsyncIterableIterator<Webhook>;
    listEvents(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksListEventsOptionalParams): PagedAsyncIterableIterator<Event>;
    ping(resourceGroupName: string, registryName: string, webhookName: string, options?: WebhooksPingOptionalParams): Promise<EventInfo>;
}

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get getCallbackConfig list listEvents ping

Methods

beginCreate

  • beginCreate(resourceGroupName, registryName, webhookName, webhookCreateParameters, options?): Promise<SimplePollerLike<OperationState<Webhook>, Webhook>>

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

    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.

    • Optionaloptions: WebhooksCreateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Webhook>, Webhook>>

beginCreateAndWait

  • beginCreateAndWait(resourceGroupName, registryName, webhookName, webhookCreateParameters, options?): Promise<Webhook>

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

    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.

    • Optionaloptions: WebhooksCreateOptionalParams

      The options parameters.

    Returns Promise<Webhook>

beginDelete

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

  • Deletes a webhook from a container registry.

    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.

    • Optionaloptions: WebhooksDeleteOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

  • beginDeleteAndWait(resourceGroupName, registryName, webhookName, options?): Promise<void>

  • Deletes a webhook from a container registry.

    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.

    • Optionaloptions: WebhooksDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

beginUpdate

  • beginUpdate(resourceGroupName, registryName, webhookName, webhookUpdateParameters, options?): Promise<SimplePollerLike<OperationState<Webhook>, Webhook>>

  • Updates a webhook with the specified parameters.

    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.

    • Optionaloptions: WebhooksUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Webhook>, Webhook>>

beginUpdateAndWait

  • beginUpdateAndWait(resourceGroupName, registryName, webhookName, webhookUpdateParameters, options?): Promise<Webhook>

  • Updates a webhook with the specified parameters.

    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.

    • Optionaloptions: WebhooksUpdateOptionalParams

      The options parameters.

    Returns Promise<Webhook>

get

  • get(resourceGroupName, registryName, webhookName, options?): Promise<Webhook>

  • Gets the properties of the specified 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.

    • Optionaloptions: WebhooksGetOptionalParams

      The options parameters.

    Returns Promise<Webhook>

getCallbackConfig

  • getCallbackConfig(resourceGroupName, registryName, webhookName, options?): Promise<CallbackConfig>

  • Gets the configuration of service URI and custom headers for the 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.

    • Optionaloptions: WebhooksGetCallbackConfigOptionalParams

      The options parameters.

    Returns Promise<CallbackConfig>

list

  • list(resourceGroupName, registryName, options?): PagedAsyncIterableIterator<Webhook>

  • Lists all the webhooks for the specified container registry.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • registryName: string

      The name of the container registry.

    • Optionaloptions: WebhooksListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Webhook>

listEvents

  • listEvents(resourceGroupName, registryName, webhookName, options?): PagedAsyncIterableIterator<Event>

  • Lists recent events for the specified 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.

    • Optionaloptions: WebhooksListEventsOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Event>

ping

  • ping(resourceGroupName, registryName, webhookName, options?): Promise<EventInfo>

  • Triggers a ping event to be sent to the 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.

    • Optionaloptions: WebhooksPingOptionalParams

      The options parameters.

    Returns Promise<EventInfo>

Settings

Member Visibility