Webhooks - Create

Service:

Container Registry

API Version:

2023-01-01-preview

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}?api-version=2023-01-01-preview

URI Parameters

Name	In	Required	Type	Description
registryName	path	True	string	The name of the container registry. Regex pattern: ^[a-zA-Z0-9]*$
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
webhookName	path	True	string	The name of the webhook. Regex pattern: ^[a-zA-Z0-9]*$
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The location of the webhook. This cannot be changed after the resource is created.
properties.actions	True	WebhookAction[]	The list of actions that trigger the webhook to post notifications.
properties.serviceUri	True	string	The service URI for the webhook to post notifications.
properties.customHeaders		object	Custom headers that will be added to the webhook notifications.
properties.scope		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.
properties.status		WebhookStatus	The status of the webhook at the time the operation was called.
tags		object	The tags for the webhook.

Responses

Name	Type	Description
200 OK	Webhook	The request was successful; the request was well-formed and received properly.
201 Created	Webhook	The request was successful; the operation will complete asynchronously. Headers Azure-AsyncOperation: string

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

WebhookCreate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook?api-version=2023-01-01-preview

{
  "location": "westus",
  "tags": {
    "key": "value"
  },
  "properties": {
    "serviceUri": "http://myservice.com",
    "customHeaders": {
      "Authorization": "******"
    },
    "status": "enabled",
    "scope": "myRepository",
    "actions": [
      "push"
    ]
  }
}

Go

package armcontainerregistry_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerregistry/armcontainerregistry"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookCreate.json
func ExampleWebhooksClient_BeginCreate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerregistry.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWebhooksClient().BeginCreate(ctx, "myResourceGroup", "myRegistry", "myWebhook", armcontainerregistry.WebhookCreateParameters{
		Location: to.Ptr("westus"),
		Properties: &armcontainerregistry.WebhookPropertiesCreateParameters{
			Actions: []*armcontainerregistry.WebhookAction{
				to.Ptr(armcontainerregistry.WebhookActionPush)},
			CustomHeaders: map[string]*string{
				"Authorization": to.Ptr("Basic 000000000000000000000000000000000000000000000000000"),
			},
			Scope:      to.Ptr("myRepository"),
			ServiceURI: to.Ptr("http://myservice.com"),
			Status:     to.Ptr(armcontainerregistry.WebhookStatusEnabled),
		},
		Tags: map[string]*string{
			"key": to.Ptr("value"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Webhook = armcontainerregistry.Webhook{
	// 	Name: to.Ptr("myWebhook"),
	// 	Type: to.Ptr("Microsoft.ContainerRegistry/registries/webhooks"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Properties: &armcontainerregistry.WebhookProperties{
	// 		Actions: []*armcontainerregistry.WebhookAction{
	// 			to.Ptr(armcontainerregistry.WebhookActionPush)},
	// 			ProvisioningState: to.Ptr(armcontainerregistry.ProvisioningStateSucceeded),
	// 			Scope: to.Ptr("myRepository"),
	// 			Status: to.Ptr(armcontainerregistry.WebhookStatusEnabled),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ContainerRegistryManagementClient } = require("@azure/arm-containerregistry");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates a webhook for a container registry with the specified parameters.
 *
 * @summary Creates a webhook for a container registry with the specified parameters.
 * x-ms-original-file: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookCreate.json
 */
async function webhookCreate() {
  const subscriptionId =
    process.env["CONTAINERREGISTRY_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERREGISTRY_RESOURCE_GROUP"] || "myResourceGroup";
  const registryName = "myRegistry";
  const webhookName = "myWebhook";
  const webhookCreateParameters = {
    actions: ["push"],
    customHeaders: {
      authorization: "Basic 000000000000000000000000000000000000000000000000000",
    },
    location: "westus",
    scope: "myRepository",
    serviceUri: "http://myservice.com",
    status: "enabled",
    tags: { key: "value" },
  };
  const credential = new DefaultAzureCredential();
  const client = new ContainerRegistryManagementClient(credential, subscriptionId);
  const result = await client.webhooks.beginCreateAndWait(
    resourceGroupName,
    registryName,
    webhookName,
    webhookCreateParameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
  "name": "myWebhook",
  "type": "Microsoft.ContainerRegistry/registries/webhooks",
  "location": "westus",
  "tags": {
    "key": "value"
  },
  "properties": {
    "status": "enabled",
    "scope": "myRepository",
    "actions": [
      "push"
    ],
    "provisioningState": "Succeeded"
  }
}

Status code:

201

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook/operationStatuses/webhooks-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview

Response Body

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
  "name": "myWebhook",
  "type": "Microsoft.ContainerRegistry/registries/webhooks",
  "location": "westus",
  "tags": {
    "key": "value"
  },
  "properties": {
    "status": "enabled",
    "scope": "myRepository",
    "actions": [
      "push"
    ],
    "provisioningState": "Creating"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
lastModifiedByType	The type of identity that last modified the resource.
ProvisioningState	Provisioning state of the resource.
SystemData	Metadata pertaining to creation and last modification of the resource.
Webhook	An object that represents a webhook for a container registry.
WebhookAction	The list of actions that trigger the webhook to post notifications.
WebhookCreateParameters	The parameters for creating a webhook.
WebhookStatus	The status of the webhook at the time the operation was called.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

lastModifiedByType

The type of identity that last modified the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ProvisioningState

Provisioning state of the resource.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

SystemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource modification (UTC).
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	lastModifiedByType	The type of identity that last modified the resource.

Webhook

An object that represents a webhook for a container registry.

Name	Type	Description
id	string	The resource ID.
location	string	The location of the resource. This cannot be changed after the resource is created.
name	string	The name of the resource.
properties.actions	WebhookAction[]	The list of actions that trigger the webhook to post notifications.
properties.provisioningState	ProvisioningState	The provisioning state of the webhook at the time the operation was called.
properties.scope	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.
properties.status	WebhookStatus	The status of the webhook at the time the operation was called.
systemData	SystemData	Metadata pertaining to creation and last modification of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.

WebhookAction

The list of actions that trigger the webhook to post notifications.

Name	Type	Description
chart_delete	string
chart_push	string
delete	string
push	string
quarantine	string

WebhookCreateParameters

The parameters for creating a webhook.

Name	Type	Description
location	string	The location of the webhook. This cannot be changed after the resource is created.
properties.actions	WebhookAction[]	The list of actions that trigger the webhook to post notifications.
properties.customHeaders	object	Custom headers that will be added to the webhook notifications.
properties.scope	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.
properties.serviceUri	string	The service URI for the webhook to post notifications.
properties.status	WebhookStatus	The status of the webhook at the time the operation was called.
tags	object	The tags for the webhook.

WebhookStatus

The status of the webhook at the time the operation was called.

Name	Type	Description
disabled	string
enabled	string