Webhooks - List Events

Ссылка

Служба:: Container Registry

Версия API:: 2023-01-01-preview

Перечисляет последние события для указанного веб-перехватчика.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
registryName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Имя реестра контейнеров.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
webhookName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Имя веб-перехватчика.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	EventListResult	Запрос выполнен успешно; запрос был хорошо сформирован и получен должным образом.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

WebhookListEvents

Образец запроса

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

Пример ответа

Код состояния:: 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"
      }
    }
  ]
}

Определения

Имя	Описание
Actor	Агент, инициирующий событие. В большинстве случаев это может быть из контекста авторизации запроса.
Event	Событие для веб-перехватчика.
EventContent	Содержимое сообщения запроса на событие.
EventListResult	Результат запроса на перечисление событий для веб-перехватчика.
EventRequestMessage	Сообщение запроса события, отправленное в URI службы.
EventResponseMessage	Сообщение ответа на событие, полученное из URI службы.
Request	Запрос, создающий событие.
Source	Узел реестра, создающий событие. По-другому, в то время как субъект инициирует событие, источник создает его.
Target	Целевой объект события.

Actor

Object

Агент, инициирующий событие. В большинстве случаев это может быть из контекста авторизации запроса.

Имя	Тип	Описание
name	string	Тема или имя пользователя, связанные с контекстом запроса, который создал событие.

Event

Object

Событие для веб-перехватчика.

Имя	Тип	Описание
eventRequestMessage	EventRequestMessage	Сообщение запроса события, отправленное в URI службы.
eventResponseMessage	EventResponseMessage	Сообщение ответа на событие, полученное из URI службы.
id	string	Идентификатор события.

EventContent

Object

Содержимое сообщения запроса на событие.

Имя	Тип	Описание
action	string	Действие, охватывающее предоставленное событие.
actor	Actor	Агент, инициирующий событие. В большинстве случаев это может быть из контекста авторизации запроса.
id	string	Идентификатор события.
request	Request	Запрос, создающий событие.
source	Source	Узел реестра, создающий событие. По-другому, в то время как субъект инициирует событие, источник создает его.
target	Target	Целевой объект события.
timestamp	string (date-time)	Время, в течение которого произошло событие.

EventListResult

Object

Результат запроса на перечисление событий для веб-перехватчика.

Имя	Тип	Описание
nextLink	string	URI, который можно использовать для запроса следующего списка событий.
value	Event[]	Список событий. Так как этот список может быть неполным, поле nextLink должно использоваться для запроса следующего списка событий.

EventRequestMessage

Object

Сообщение запроса события, отправленное в URI службы.

Имя	Тип	Описание
content	EventContent	Содержимое сообщения запроса на событие.
headers	object	Заголовки сообщения запроса на событие.
method	string	Метод HTTP, используемый для отправки сообщения запроса события.
requestUri	string	Универсальный код ресурса (URI), используемый для отправки сообщения запроса на событие.
version	string	Версия HTTP-сообщения.

EventResponseMessage

Object

Сообщение ответа на событие, полученное из URI службы.

Имя	Тип	Описание
content	string	Содержимое сообщения ответа на событие.
headers	object	Заголовки сообщения ответа на события.
reasonPhrase	string	Фраза причины сообщения ответа на событие.
statusCode	string	Код состояния сообщения ответа на событие.
version	string	Версия HTTP-сообщения.

Request

Object

Запрос, создающий событие.

Имя	Тип	Описание
addr	string	IP-адрес или имя узла и, возможно, порт клиентского подключения, инициирующего событие. Это RemoteAddr из стандартного http-запроса.
host	string	Имя внешнего узла экземпляра реестра, указанное заголовком узла HTTP в входящих запросах.
id	string	Идентификатор запроса, инициированного событием.
method	string	Метод запроса, создающий событие.
useragent	string	Заголовок агента пользователя запроса.

Source

Object

Узел реестра, создающий событие. По-другому, в то время как субъект инициирует событие, источник создает его.

Имя	Тип	Описание
addr	string	IP-адрес или имя узла и порт узла реестра, создающего событие. Как правило, это будет разрешено ос. Hostname() вместе с запущенным портом.
instanceID	string	Запущенный экземпляр приложения. Изменения после каждого перезапуска.

Target

Object

Целевой объект события.

Имя	Тип	Описание
digest	string	Дайджест содержимого, как определено спецификацией API HTTP реестра версии 2.
length	integer (int64)	Количество байтов содержимого. То же, что и поле "Размер".
mediaType	string	Тип MIME объекта, на который ссылается ссылка.
name	string	Имя артефакта.
repository	string	Имя репозитория.
size	integer (int64)	Количество байтов содержимого. То же, что и поле Length.
tag	string	Имя тега.
url	string	Прямой URL-адрес содержимого.
version	string	Версия артефакта.

Поделиться через

Webhooks - List Events

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

WebhookListEvents

Образец запроса

Пример ответа

Определения

Actor

Event

EventContent

EventListResult

EventRequestMessage

EventResponseMessage

Request

Source

Target

Дополнительные ресурсы