Webhooks - List Events

Referens

Tjänst:: Container Registry

API-version:: 2023-01-01-preview

Visar en lista över de senaste händelserna för den angivna webhooken.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
registryName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Namnet på containerregistret.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
webhookName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Namnet på webhooken.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	EventListResult	Begäran lyckades. begäran var väl utformad och mottogs korrekt.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

WebhookListEvents

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
Actor	Agenten som initierade händelsen. I de flesta fall kan detta komma från auktoriseringskontexten för begäran.
Event	Händelsen för en webhook.
EventContent	Innehållet i meddelandet för händelsebegäran.
EventListResult	Resultatet av en begäran om att lista händelser för en webhook.
EventRequestMessage	Meddelandet om händelsebegäran som skickas till tjänstens URI.
EventResponseMessage	Händelsesvarsmeddelandet som togs emot från tjänst-URI:n.
Request	Begäran som genererade händelsen.
Source	Registernoden som genererade händelsen. På ett annat sätt, medan aktören initierar händelsen, genererar källan den.
Target	Målet för händelsen.

Actor

Objekt

Agenten som initierade händelsen. I de flesta fall kan detta komma från auktoriseringskontexten för begäran.

Name	Typ	Description
name	string	Ämnet eller användarnamnet som är associerat med begärandekontexten som genererade händelsen.

Event

Objekt

Händelsen för en webhook.

Name	Typ	Description
eventRequestMessage	EventRequestMessage	Meddelandet om händelsebegäran som skickas till tjänstens URI.
eventResponseMessage	EventResponseMessage	Händelsesvarsmeddelandet som togs emot från tjänst-URI:n.
id	string	Händelse-ID:t.

EventContent

Objekt

Innehållet i meddelandet för händelsebegäran.

Name	Typ	Description
action	string	Åtgärden som omfattar den angivna händelsen.
actor	Actor	Agenten som initierade händelsen. I de flesta fall kan detta komma från auktoriseringskontexten för begäran.
id	string	Händelse-ID:t.
request	Request	Begäran som genererade händelsen.
source	Source	Registernoden som genererade händelsen. På ett annat sätt, medan aktören initierar händelsen, genererar källan den.
target	Target	Målet för händelsen.
timestamp	string (date-time)	Tidpunkten då händelsen inträffade.

EventListResult

Objekt

Resultatet av en begäran om att lista händelser för en webhook.

Name	Typ	Description
nextLink	string	Den URI som kan användas för att begära nästa lista över händelser.
value	Event[]	Listan över händelser. Eftersom den här listan kan vara ofullständig bör fältet nextLink användas för att begära nästa lista över händelser.

EventRequestMessage

Objekt

Meddelandet om händelsebegäran som skickas till tjänstens URI.

Name	Typ	Description
content	EventContent	Innehållet i meddelandet för händelsebegäran.
headers	object	Rubrikerna i meddelandet för händelsebegäran.
method	string	HTTP-metoden som används för att skicka meddelandet för händelsebegäran.
requestUri	string	Den URI som användes för att skicka meddelandet för händelsebegäran.
version	string	HTTP-meddelandeversionen.

EventResponseMessage

Objekt

Händelsesvarsmeddelandet som togs emot från tjänst-URI:n.

Name	Typ	Description
content	string	Innehållet i händelsesvarsmeddelandet.
headers	object	Rubrikerna i händelsesvarsmeddelandet.
reasonPhrase	string	Orsaksfrasen för händelsesvarsmeddelandet.
statusCode	string	Statuskoden för händelsesvarsmeddelandet.
version	string	HTTP-meddelandeversionen.

Request

Objekt

Begäran som genererade händelsen.

Name	Typ	Description
addr	string	IP-adressen eller värdnamnet och eventuellt porten för klientanslutningen som initierade händelsen. Det här är RemoteAddr från http-standardbegäran.
host	string	Registerinstansens externt tillgängliga värdnamn enligt http-värdhuvudet för inkommande begäranden.
id	string	ID för begäran som initierade händelsen.
method	string	Den begärandemetod som genererade händelsen.
useragent	string	Användaragentens huvud för begäran.

Source

Objekt

Registernoden som genererade händelsen. På ett annat sätt, medan aktören initierar händelsen, genererar källan den.

Name	Typ	Description
addr	string	IP-adressen eller värdnamnet och porten för registernoden som genererade händelsen. I allmänhet löses detta av operativsystemet. Hostname() tillsammans med den port som körs.
instanceID	string	Den instans av ett program som körs. Ändringar efter varje omstart.

Target

Objekt

Målet för händelsen.

Name	Typ	Description
digest	string	Sammanfattningen av innehållet enligt definitionen i HTTP API-specifikationen för Registry V2.
length	integer (int64)	Antalet byte av innehållet. Samma som fältet Storlek.
mediaType	string	MIME-typen för det refererade objektet.
name	string	Artefaktens namn.
repository	string	Lagringsplatsens namn.
size	integer (int64)	Antalet byte av innehållet. Samma som fältet Längd.
tag	string	Taggnamnet.
url	string	Direkt-URL:en till innehållet.
version	string	Artefaktens version.

Dela via

Webhooks - List Events

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

WebhookListEvents

Exempelbegäran

Exempelsvar

Definitioner

Actor

Event

EventContent

EventListResult

EventRequestMessage

EventResponseMessage

Request

Source

Target

Ytterligare resurser