Webhooks - List Events

Odwołanie

Usługa:: Container Registry

Wersja interfejsu API:: 2023-01-01-preview

Wyświetla listę ostatnich zdarzeń dla określonego elementu webhook.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
registryName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Nazwa rejestru kontenerów.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
webhookName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Nazwa elementu webhook.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	EventListResult	Żądanie zakończyło się pomyślnie; żądanie zostało prawidłowo sformułowane i odebrane.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

WebhookListEvents

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
      }
    }
  ]
}

Definicje

Nazwa	Opis
Actor	Agent, który zainicjował zdarzenie. W większości sytuacji może to wynikać z kontekstu autoryzacji żądania.
Event	Zdarzenie elementu webhook.
EventContent	Zawartość komunikatu żądania zdarzenia.
EventListResult	Wynik żądania wyświetlenia listy zdarzeń dla elementu webhook.
EventRequestMessage	Komunikat żądania zdarzenia wysłany do identyfikatora URI usługi.
EventResponseMessage	Komunikat odpowiedzi zdarzenia odebrany z identyfikatora URI usługi.
Request	Żądanie, które wygenerowało zdarzenie.
Source	Węzeł rejestru, który wygenerował zdarzenie. Umieść inaczej, gdy aktor inicjuje zdarzenie, źródło je generuje.
Target	Element docelowy zdarzenia.

Actor

Objekt

Agent, który zainicjował zdarzenie. W większości sytuacji może to wynikać z kontekstu autoryzacji żądania.

Nazwa	Typ	Opis
name	string	Temat lub nazwa użytkownika skojarzona z kontekstem żądania, który wygenerował zdarzenie.

Event

Objekt

Zdarzenie elementu webhook.

Nazwa	Typ	Opis
eventRequestMessage	EventRequestMessage	Komunikat żądania zdarzenia wysłany do identyfikatora URI usługi.
eventResponseMessage	EventResponseMessage	Komunikat odpowiedzi zdarzenia odebrany z identyfikatora URI usługi.
id	string	Identyfikator zdarzenia.

EventContent

Objekt

Zawartość komunikatu żądania zdarzenia.

Nazwa	Typ	Opis
action	string	Akcja obejmująca podane zdarzenie.
actor	Actor	Agent, który zainicjował zdarzenie. W większości sytuacji może to wynikać z kontekstu autoryzacji żądania.
id	string	Identyfikator zdarzenia.
request	Request	Żądanie, które wygenerowało zdarzenie.
source	Source	Węzeł rejestru, który wygenerował zdarzenie. Umieść inaczej, gdy aktor inicjuje zdarzenie, źródło je generuje.
target	Target	Element docelowy zdarzenia.
timestamp	string (date-time)	Godzina wystąpienia zdarzenia.

EventListResult

Objekt

Wynik żądania wyświetlenia listy zdarzeń dla elementu webhook.

Nazwa	Typ	Opis
nextLink	string	Identyfikator URI, który może służyć do żądania następnej listy zdarzeń.
value	Event[]	Lista zdarzeń. Ponieważ ta lista może być niekompletna, pole nextLink powinno służyć do żądania następnej listy zdarzeń.

EventRequestMessage

Objekt

Komunikat żądania zdarzenia wysłany do identyfikatora URI usługi.

Nazwa	Typ	Opis
content	EventContent	Zawartość komunikatu żądania zdarzenia.
headers	object	Nagłówki komunikatu żądania zdarzenia.
method	string	Metoda HTTP używana do wysyłania komunikatu żądania zdarzenia.
requestUri	string	Identyfikator URI używany do wysyłania komunikatu żądania zdarzenia.
version	string	Wersja komunikatu HTTP.

EventResponseMessage

Objekt

Komunikat odpowiedzi zdarzenia odebrany z identyfikatora URI usługi.

Nazwa	Typ	Opis
content	string	Zawartość komunikatu odpowiedzi zdarzenia.
headers	object	Nagłówki komunikatu odpowiedzi zdarzenia.
reasonPhrase	string	Fraza przyczyny komunikatu odpowiedzi zdarzenia.
statusCode	string	Kod stanu komunikatu odpowiedzi zdarzenia.
version	string	Wersja komunikatu HTTP.

Request

Objekt

Żądanie, które wygenerowało zdarzenie.

Nazwa	Typ	Opis
addr	string	Adres IP lub nazwa hosta i prawdopodobnie port połączenia klienta, które zainicjowało zdarzenie. Jest to RemoteAddr ze standardowego żądania HTTP.
host	string	Zewnętrznie dostępna nazwa hosta wystąpienia rejestru określona przez nagłówek hosta HTTP dla żądań przychodzących.
id	string	Identyfikator żądania, które zainicjowało zdarzenie.
method	string	Metoda żądania, która wygenerowała zdarzenie.
useragent	string	Nagłówek agenta użytkownika żądania.

Source

Objekt

Węzeł rejestru, który wygenerował zdarzenie. Umieść inaczej, gdy aktor inicjuje zdarzenie, źródło je generuje.

Nazwa	Typ	Opis
addr	string	Adres IP lub nazwa hosta oraz port węzła rejestru, który wygenerował zdarzenie. Ogólnie rzecz biorąc, zostanie to rozwiązane przez system operacyjny. Nazwa hosta() wraz z uruchomionym portem.
instanceID	string	Uruchomione wystąpienie aplikacji. Zmiany po każdym ponownym uruchomieniu.

Target

Objekt

Element docelowy zdarzenia.

Nazwa	Typ	Opis
digest	string	Skrót zawartości zdefiniowanej przez specyfikację interfejsu API HTTP rejestru w wersji 2.
length	integer (int64)	Liczba bajtów zawartości. Tak samo jak pole Rozmiar.
mediaType	string	Typ MIME obiektu, do których odwołuje się odwołanie.
name	string	Nazwa artefaktu.
repository	string	Nazwa repozytorium.
size	integer (int64)	Liczba bajtów zawartości. Tak samo jak pole Długość.
tag	string	Nazwa tagu.
url	string	Bezpośredni adres URL do zawartości.
version	string	Wersja artefaktu.

Udostępnij za pośrednictwem

Webhooks - List Events

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

WebhookListEvents

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Actor

Event

EventContent

EventListResult

EventRequestMessage

EventResponseMessage

Request

Source

Target

Dodatkowe zasoby