Webhooks - Update

Referência

Serviço:: Container Registry

Versão da API:: 2023-01-01-preview

Atualiza um webhook com os parâmetros especificados.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
registryName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	O nome do registro de contêiner.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
webhookName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	O nome do webhook.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.actions	WebhookAction[]	A lista de ações que disparam o webhook para postar notificações.
properties.customHeaders	object	Cabeçalhos personalizados que serão adicionados às notificações do webhook.
properties.scope	string	O escopo dos repositórios em que o evento pode ser disparado. Por exemplo, 'foo:*' significa eventos para todas as marcas no repositório 'foo'. 'foo:bar' significa eventos apenas para 'foo:bar'. 'foo' é equivalente a 'foo:latest'. Vazio significa todos os eventos.
properties.serviceUri	string	O URI de serviço do webhook para postar notificações.
properties.status	WebhookStatus	O status do webhook no momento em que a operação foi chamada.
tags	object	As marcas do webhook.

Respostas

Nome	Tipo	Description
200 OK	Webhook	A solicitação foi bem-sucedida; a solicitação foi bem formada e recebida corretamente.
201 Created	Webhook	A solicitação foi bem-sucedida; a operação será concluída de forma assíncrona. Cabeçalhos Azure-AsyncOperation: string

Nome

Tipo

Description

200 OK

Webhook

A solicitação foi bem-sucedida; a solicitação foi bem formada e recebida corretamente.

201 Created

Webhook

A solicitação foi bem-sucedida; a operação será concluída de forma assíncrona.

Cabeçalhos

Azure-AsyncOperation: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

WebhookUpdate

Solicitação de exemplo

PATCH 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

{
  "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/WebhookUpdate.json
func ExampleWebhooksClient_BeginUpdate() {
	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().BeginUpdate(ctx, "myResourceGroup", "myRegistry", "myWebhook", armcontainerregistry.WebhookUpdateParameters{
		Properties: &armcontainerregistry.WebhookPropertiesUpdateParameters{
			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 Updates a webhook with the specified parameters.
 *
 * @summary Updates a webhook with the specified parameters.
 * x-ms-original-file: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookUpdate.json
 */
async function webhookUpdate() {
  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 webhookUpdateParameters = {
    actions: ["push"],
    customHeaders: {
      authorization: "Basic 000000000000000000000000000000000000000000000000000",
    },
    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.beginUpdateAndWait(
    resourceGroupName,
    registryName,
    webhookName,
    webhookUpdateParameters
  );
  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

Resposta de exemplo

Código de status:: 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"
  }
}

Código de status:: 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

{
  "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": "Updating"
  }
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.
ProvisioningState	Estado de provisionamento do recurso.
SystemData	Metadados relativos à criação e última modificação do recurso.
Webhook	Um objeto que representa um webhook para um registro de contêiner.
WebhookAction	A lista de ações que disparam o webhook para postar notificações.
WebhookStatus	O status do webhook no momento em que a operação foi chamada.
WebhookUpdateParameters	Os parâmetros para atualizar um webhook.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

lastModifiedByType

Enumeração

O tipo de identidade que modificou o recurso pela última vez.

Valor	Description
Application
Key
ManagedIdentity
User

ProvisioningState

Enumeração

Estado de provisionamento do recurso.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

SystemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da modificação de recurso (UTC).
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.

Webhook

Objeto

Um objeto que representa um webhook para um registro de contêiner.

Nome	Tipo	Description
id	string	A ID do recurso.
location	string	A localização do recurso. Isso não pode ser alterado depois que o recurso é criado.
name	string	O nome do recurso.
properties.actions	WebhookAction[]	A lista de ações que disparam o webhook para postar notificações.
properties.provisioningState	ProvisioningState	O estado de provisionamento do webhook no momento em que a operação foi chamada.
properties.scope	string	O escopo dos repositórios em que o evento pode ser disparado. Por exemplo, 'foo:*' significa eventos para todas as marcas no repositório 'foo'. 'foo:bar' significa eventos apenas para 'foo:bar'. 'foo' é equivalente a 'foo:latest'. Vazio significa todos os eventos.
properties.status	WebhookStatus	O status do webhook no momento em que a operação foi chamada.
systemData	SystemData	Metadados relativos à criação e última modificação do recurso.
tags	object	As marcas do recurso.
type	string	O tipo do recurso.

WebhookAction

Enumeração

A lista de ações que disparam o webhook para postar notificações.

Valor	Description
chart_delete
chart_push
delete
push
quarantine

WebhookStatus

Enumeração

O status do webhook no momento em que a operação foi chamada.

Valor	Description
disabled
enabled

WebhookUpdateParameters

Objeto

Os parâmetros para atualizar um webhook.

Nome	Tipo	Description
properties.actions	WebhookAction[]	A lista de ações que disparam o webhook para postar notificações.
properties.customHeaders	object	Cabeçalhos personalizados que serão adicionados às notificações do webhook.
properties.scope	string	O escopo dos repositórios em que o evento pode ser disparado. Por exemplo, 'foo:*' significa eventos para todas as marcas no repositório 'foo'. 'foo:bar' significa eventos apenas para 'foo:bar'. 'foo' é equivalente a 'foo:latest'. Vazio significa todos os eventos.
properties.serviceUri	string	O URI de serviço do webhook para postar notificações.
properties.status	WebhookStatus	O status do webhook no momento em que a operação foi chamada.
tags	object	As marcas do webhook.

Compartilhar via

Webhooks - Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

WebhookUpdate

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

lastModifiedByType

ProvisioningState

SystemData

Webhook

WebhookAction

WebhookStatus

WebhookUpdateParameters