Webhooks - Create

Riferimento

Service:: Container Registry

API Version:: 2023-01-01-preview

Crea un webhook per un registro contenitori con i parametri specificati.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
registryName	path	True	string	Nome del registro contenitori. Regex pattern: `^[a-zA-Z0-9]*$`
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string uuid	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
webhookName	path	True	string	Nome del webhook. Regex pattern: `^[a-zA-Z0-9]*$`
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Percorso del webhook. Questa operazione non può essere modificata dopo la creazione della risorsa.
properties.actions	True	WebhookAction[]	Elenco di azioni che attivano il webhook per pubblicare le notifiche.
properties.serviceUri	True	string	URI del servizio per il webhook per la pubblicazione delle notifiche.
properties.customHeaders		object	Intestazioni personalizzate che verranno aggiunte alle notifiche del webhook.
properties.scope		string	Ambito dei repository in cui è possibile attivare l'evento. Ad esempio, 'foo:*' significa eventi per tutti i tag nel repository 'foo'. 'foo:bar' significa eventi solo per 'foo:bar'. 'foo' equivale a 'foo:latest'. Vuoto indica tutti gli eventi.
properties.status		WebhookStatus	Stato del webhook al momento della chiamata dell'operazione.
tags		object	Tag per il webhook.

Risposte

Nome	Tipo	Descrizione
200 OK	Webhook	La richiesta ha avuto esito positivo; la richiesta è stata ben formata e ricevuta correttamente.
201 Created	Webhook	La richiesta ha avuto esito positivo; l'operazione verrà completata in modo asincrono. Headers Azure-AsyncOperation: string

Nome

Tipo

Descrizione

200 OK

Webhook

La richiesta ha avuto esito positivo; la richiesta è stata ben formata e ricevuta correttamente.

201 Created

Webhook

La richiesta ha avuto esito positivo; l'operazione verrà completata in modo asincrono.

Headers

Azure-AsyncOperation: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

WebhookCreate

Sample Request

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"
    ]
  }
}

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

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"
  }
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedByType	Tipo di identità che ha modificato l'ultima volta la risorsa.
ProvisioningState	Stato di provisioning della risorsa.
SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
Webhook	Oggetto che rappresenta un webhook per un registro contenitori.
WebhookAction	Elenco di azioni che attivano il webhook per pubblicare le notifiche.
WebhookCreateParameters	Parametri per la creazione di un webhook.
WebhookStatus	Stato del webhook al momento della chiamata dell'operazione.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

lastModifiedByType

Tipo di identità che ha modificato l'ultima volta la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ProvisioningState

Stato di provisioning della risorsa.

Nome	Tipo	Descrizione
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

SystemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp della modifica della risorsa (UTC).
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	lastModifiedByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Webhook

Oggetto che rappresenta un webhook per un registro contenitori.

Nome	Tipo	Descrizione
id	string	L'ID della risorsa.
location	string	Il percorso della risorsa. Questa operazione non può essere modificata dopo la creazione della risorsa.
name	string	Nome della risorsa.
properties.actions	WebhookAction[]	Elenco di azioni che attivano il webhook per pubblicare le notifiche.
properties.provisioningState	ProvisioningState	Stato di provisioning del webhook al momento della chiamata dell'operazione.
properties.scope	string	Ambito dei repository in cui è possibile attivare l'evento. Ad esempio, 'foo:*' significa eventi per tutti i tag nel repository 'foo'. 'foo:bar' significa eventi solo per 'foo:bar'. 'foo' equivale a 'foo:latest'. Vuoto indica tutti gli eventi.
properties.status	WebhookStatus	Stato del webhook al momento della chiamata dell'operazione.
systemData	SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
tags	object	Tag della risorsa.
type	string	Tipo di risorsa.

WebhookAction

Elenco di azioni che attivano il webhook per pubblicare le notifiche.

Nome	Tipo	Descrizione
chart_delete	string
chart_push	string
delete	string
push	string
quarantine	string

WebhookCreateParameters

Parametri per la creazione di un webhook.

Nome	Tipo	Descrizione
location	string	Percorso del webhook. Questa operazione non può essere modificata dopo la creazione della risorsa.
properties.actions	WebhookAction[]	Elenco di azioni che attivano il webhook per pubblicare le notifiche.
properties.customHeaders	object	Intestazioni personalizzate che verranno aggiunte alle notifiche del webhook.
properties.scope	string	Ambito dei repository in cui è possibile attivare l'evento. Ad esempio, 'foo:*' significa eventi per tutti i tag nel repository 'foo'. 'foo:bar' significa eventi solo per 'foo:bar'. 'foo' equivale a 'foo:latest'. Vuoto indica tutti gli eventi.
properties.serviceUri	string	URI del servizio per il webhook per la pubblicazione delle notifiche.
properties.status	WebhookStatus	Stato del webhook al momento della chiamata dell'operazione.
tags	object	Tag per il webhook.

WebhookStatus

Stato del webhook al momento della chiamata dell'operazione.

Nome	Tipo	Descrizione
disabled	string
enabled	string

Webhooks - Create

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Scopes

Esempio

WebhookCreate

Sample Request

Sample Response

Definizioni

createdByType

lastModifiedByType

ProvisioningState

SystemData

Webhook

WebhookAction

WebhookCreateParameters

WebhookStatus

Risorse aggiuntive