Webhooks - List Events

Riferimento

Servizio:: Container Registry

Versione API:: 2023-01-01-preview

Elenca gli eventi recenti per il webhook specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
registryName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Nome del registro contenitori.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa 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 minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Nome del webhook.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	EventListResult	La richiesta ha avuto esito positivo; la richiesta è stata ben formata e ricevuta correttamente.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

WebhookListEvents

Esempio di richiesta

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

package armcontainerregistry_test

import (
	"context"
	"log"

	"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/WebhookListEvents.json
func ExampleWebhooksClient_NewListEventsPager() {
	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)
	}
	pager := clientFactory.NewWebhooksClient().NewListEventsPager("myResourceGroup", "myRegistry", "myWebhook", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.EventListResult = armcontainerregistry.EventListResult{
		// 	Value: []*armcontainerregistry.Event{
		// 		{
		// 			ID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 			EventRequestMessage: &armcontainerregistry.EventRequestMessage{
		// 				Method: to.Ptr("POST"),
		// 				Content: &armcontainerregistry.EventContent{
		// 					Action: to.Ptr("push"),
		// 					Actor: &armcontainerregistry.Actor{
		// 					},
		// 					ID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 					Source: &armcontainerregistry.Source{
		// 						Addr: to.Ptr("xtal.local:5000"),
		// 						InstanceID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 					},
		// 					Target: &armcontainerregistry.Target{
		// 						Digest: to.Ptr("sha256:fea8895f450959fa676bcc1df0611ea93823a735a01205fd8622846041d0c7cf"),
		// 						Length: to.Ptr[int64](708),
		// 						MediaType: to.Ptr("application/vnd.docker.distribution.manifest.v2+json"),
		// 						Repository: to.Ptr("hello-world"),
		// 						Size: to.Ptr[int64](708),
		// 						Tag: to.Ptr("latest"),
		// 						URL: to.Ptr("http://192.168.100.227:5000/v2/hello-world/manifests/sha256:fea8895f450959fa676bcc1df0611ea93823a735a01205fd8622846041d0c7cf"),
		// 					},
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-01T23:14:37.0707808Z"); return t}()),
		// 					Request: &armcontainerregistry.Request{
		// 						Method: to.Ptr("GET"),
		// 						Addr: to.Ptr("192.168.64.11:42961"),
		// 						Host: to.Ptr("192.168.100.227:5000"),
		// 						ID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 						Useragent: to.Ptr("curl/7.38.0"),
		// 					},
		// 				},
		// 				Headers: map[string]*string{
		// 					"Authorization": to.Ptr("******"),
		// 					"Content-Length": to.Ptr("719"),
		// 					"Content-Type": to.Ptr("application/json"),
		// 				},
		// 				RequestURI: to.Ptr("http://myservice.com"),
		// 				Version: to.Ptr("1.1"),
		// 			},
		// 			EventResponseMessage: &armcontainerregistry.EventResponseMessage{
		// 				Headers: map[string]*string{
		// 					"Content-Length": to.Ptr("0"),
		// 				},
		// 				StatusCode: to.Ptr("200"),
		// 				Version: to.Ptr("1.1"),
		// 			},
		// 	}},
		// }
	}
}

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 Lists recent events for the specified webhook.
 *
 * @summary Lists recent events for the specified webhook.
 * x-ms-original-file: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookListEvents.json
 */
async function webhookListEvents() {
  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 credential = new DefaultAzureCredential();
  const client = new ContainerRegistryManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.webhooks.listEvents(resourceGroupName, registryName, webhookName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "eventRequestMessage": {
        "content": {
          "id": "00000000-0000-0000-0000-000000000000",
          "timestamp": "2017-03-01T23:14:37.0707808Z",
          "action": "push",
          "target": {
            "mediaType": "application/vnd.docker.distribution.manifest.v2+json",
            "size": 708,
            "digest": "sha256:fea8895f450959fa676bcc1df0611ea93823a735a01205fd8622846041d0c7cf",
            "length": 708,
            "repository": "hello-world",
            "url": "http://192.168.100.227:5000/v2/hello-world/manifests/sha256:fea8895f450959fa676bcc1df0611ea93823a735a01205fd8622846041d0c7cf",
            "tag": "latest"
          },
          "request": {
            "id": "00000000-0000-0000-0000-000000000000",
            "addr": "192.168.64.11:42961",
            "host": "192.168.100.227:5000",
            "method": "GET",
            "useragent": "curl/7.38.0"
          },
          "actor": {},
          "source": {
            "addr": "xtal.local:5000",
            "instanceID": "00000000-0000-0000-0000-000000000000"
          }
        },
        "headers": {
          "Content-Type": "application/json",
          "Content-Length": "719",
          "Authorization": "******"
        },
        "method": "POST",
        "requestUri": "http://myservice.com",
        "version": "1.1"
      },
      "eventResponseMessage": {
        "headers": {
          "Content-Length": "0"
        },
        "statusCode": "200",
        "version": "1.1"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
Actor	Agente che ha avviato l'evento. Per la maggior parte delle situazioni, questo potrebbe essere dal contesto di autorizzazione della richiesta.
Event	Evento per un webhook.
EventContent	Contenuto del messaggio di richiesta dell'evento.
EventListResult	Risultato di una richiesta di elenco degli eventi per un webhook.
EventRequestMessage	Messaggio di richiesta dell'evento inviato all'URI del servizio.
EventResponseMessage	Messaggio di risposta all'evento ricevuto dall'URI del servizio.
Request	Richiesta che ha generato l'evento.
Source	Nodo del Registro di sistema che ha generato l'evento. Mettere in modo diverso, mentre l'attore avvia l'evento, l'origine lo genera.
Target	Destinazione dell'evento.

Actor

Object

Agente che ha avviato l'evento. Per la maggior parte delle situazioni, questo potrebbe essere dal contesto di autorizzazione della richiesta.

Nome	Tipo	Descrizione
name	string	Oggetto o nome utente associato al contesto della richiesta che ha generato l'evento.

Event

Object

Evento per un webhook.

Nome	Tipo	Descrizione
eventRequestMessage	EventRequestMessage	Messaggio di richiesta dell'evento inviato all'URI del servizio.
eventResponseMessage	EventResponseMessage	Messaggio di risposta all'evento ricevuto dall'URI del servizio.
id	string	ID evento.

EventContent

Object

Contenuto del messaggio di richiesta dell'evento.

Nome	Tipo	Descrizione
action	string	Azione che include l'evento fornito.
actor	Actor	Agente che ha avviato l'evento. Per la maggior parte delle situazioni, questo potrebbe essere dal contesto di autorizzazione della richiesta.
id	string	ID evento.
request	Request	Richiesta che ha generato l'evento.
source	Source	Nodo del Registro di sistema che ha generato l'evento. Mettere in modo diverso, mentre l'attore avvia l'evento, l'origine lo genera.
target	Target	Destinazione dell'evento.
timestamp	string (date-time)	Ora in cui si è verificato l'evento.

EventListResult

Object

Risultato di una richiesta di elenco degli eventi per un webhook.

Nome	Tipo	Descrizione
nextLink	string	URI che può essere usato per richiedere l'elenco successivo di eventi.
value	Event[]	Elenco di eventi. Poiché questo elenco potrebbe essere incompleto, il campo nextLink deve essere utilizzato per richiedere l'elenco successivo di eventi.

EventRequestMessage

Object

Messaggio di richiesta dell'evento inviato all'URI del servizio.

Nome	Tipo	Descrizione
content	EventContent	Contenuto del messaggio di richiesta dell'evento.
headers	object	Intestazioni del messaggio di richiesta dell'evento.
method	string	Metodo HTTP usato per inviare il messaggio di richiesta dell'evento.
requestUri	string	URI utilizzato per inviare il messaggio di richiesta dell'evento.
version	string	Versione del messaggio HTTP.

EventResponseMessage

Object

Messaggio di risposta all'evento ricevuto dall'URI del servizio.

Nome	Tipo	Descrizione
content	string	Contenuto del messaggio di risposta dell'evento.
headers	object	Intestazioni del messaggio di risposta dell'evento.
reasonPhrase	string	Frase motivo del messaggio di risposta dell'evento.
statusCode	string	Codice di stato del messaggio di risposta dell'evento.
version	string	Versione del messaggio HTTP.

Request

Object

Richiesta che ha generato l'evento.

Nome	Tipo	Descrizione
addr	string	IP o nome host ed eventualmente porta della connessione client che ha avviato l'evento. Si tratta di RemoteAddr dalla richiesta HTTP standard.
host	string	Nome host accessibile esternamente dell'istanza del Registro di sistema, come specificato dall'intestazione host HTTP nelle richieste in ingresso.
id	string	ID della richiesta che ha avviato l'evento.
method	string	Metodo di richiesta che ha generato l'evento.
useragent	string	Intestazione dell'agente utente della richiesta.

Source

Object

Nodo del Registro di sistema che ha generato l'evento. Mettere in modo diverso, mentre l'attore avvia l'evento, l'origine lo genera.

Nome	Tipo	Descrizione
addr	string	IP o nome host e la porta del nodo del Registro di sistema che ha generato l'evento. In genere, questo verrà risolto dal sistema operativo. Hostname() insieme alla porta in esecuzione.
instanceID	string	Istanza in esecuzione di un'applicazione. Cambia dopo ogni riavvio.

Target

Object

Destinazione dell'evento.

Nome	Tipo	Descrizione
digest	string	Digest del contenuto, come definito dalla specifica dell'API HTTP V2 del Registro di sistema.
length	integer (int64)	Numero di byte del contenuto. Uguale al campo Dimensioni.
mediaType	string	Tipo MIME dell'oggetto a cui si fa riferimento.
name	string	Nome dell'artefatto.
repository	string	Nome del repository.
size	integer (int64)	Numero di byte del contenuto. Uguale al campo Lunghezza.
tag	string	Nome del tag.
url	string	URL diretto al contenuto.
version	string	Versione dell'artefatto.

Condividi tramite

Webhooks - List Events

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

WebhookListEvents

Esempio di richiesta

Risposta di esempio

Definizioni

Actor

Event

EventContent

EventListResult

EventRequestMessage

EventResponseMessage

Request

Source

Target

Risorse aggiuntive