@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.24 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* An object that represents a webhook for a container registry.
*
* Uses Azure REST API version 2024-11-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-12-01.
*
* Other available API versions: 2019-12-01-preview, 2020-11-01-preview, 2021-06-01-preview, 2021-08-01-preview, 2021-09-01, 2021-12-01-preview, 2022-02-01-preview, 2022-12-01, 2023-01-01-preview, 2023-06-01-preview, 2023-07-01, 2023-08-01-preview, 2023-11-01-preview, 2025-03-01-preview, 2025-04-01, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native containerregistry [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Webhook extends pulumi.CustomResource {
/**
* Get an existing Webhook resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Webhook;
/**
* Returns true if the given object is an instance of Webhook. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Webhook;
/**
* The list of actions that trigger the webhook to post notifications.
*/
readonly actions: pulumi.Output<string[]>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The location of the resource. This cannot be changed after the resource is created.
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource.
*/
readonly name: pulumi.Output<string>;
/**
* The provisioning state of the webhook at the time the operation was called.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* 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.
*/
readonly scope: pulumi.Output<string | undefined>;
/**
* The status of the webhook at the time the operation was called.
*/
readonly status: pulumi.Output<string | undefined>;
/**
* Metadata pertaining to creation and last modification of the resource.
*/
readonly systemData: pulumi.Output<outputs.containerregistry.SystemDataResponse>;
/**
* The tags of the resource.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The type of the resource.
*/
readonly type: pulumi.Output<string>;
/**
* Create a Webhook resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: WebhookArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Webhook resource.
*/
export interface WebhookArgs {
/**
* The list of actions that trigger the webhook to post notifications.
*/
actions: pulumi.Input<pulumi.Input<string | enums.containerregistry.WebhookAction>[]>;
/**
* Custom headers that will be added to the webhook notifications.
*/
customHeaders?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The location of the webhook. This cannot be changed after the resource is created.
*/
location?: pulumi.Input<string>;
/**
* The name of the container registry.
*/
registryName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* 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.
*/
scope?: pulumi.Input<string>;
/**
* The service URI for the webhook to post notifications.
*/
serviceUri: pulumi.Input<string>;
/**
* The status of the webhook at the time the operation was called.
*/
status?: pulumi.Input<string | enums.containerregistry.WebhookStatus>;
/**
* The tags for the webhook.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the webhook.
*/
webhookName?: pulumi.Input<string>;
}