Webhooks - List Events

リファレンス

サービス:: Container Registry

API バージョン:: 2023-01-01-preview

指定した Webhook の最近のイベントを一覧表示します。

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)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
webhookName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Webhook の名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	EventListResult	要求が成功しました。要求は整形式であり、適切に受信されました。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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	Webhook のイベント。
EventContent	イベント要求メッセージの内容。
EventListResult	Webhook のイベントを一覧表示する要求の結果。
EventRequestMessage	サービス URI に送信されるイベント要求メッセージ。
EventResponseMessage	サービス URI から受信したイベント応答メッセージ。
Request	イベントを生成した要求。
Source	イベントを生成したレジストリノード。別の言い方をすると、アクターがイベントを開始するときに、ソースによって生成されます。
Target	イベントのターゲット。

Actor

Object

イベントを開始したエージェント。ほとんどの場合、これは要求の承認コンテキストから発生する可能性があります。

名前	型	説明
name	string	イベントを生成した要求コンテキストに関連付けられているサブジェクトまたはユーザー名。

Event

Object

Webhook のイベント。

名前	型	説明
eventRequestMessage	EventRequestMessage	サービス URI に送信されるイベント要求メッセージ。
eventResponseMessage	EventResponseMessage	サービス URI から受信したイベント応答メッセージ。
id	string	イベント ID。

EventContent

Object

イベント要求メッセージの内容。

名前	型	説明
action	string	指定されたイベントを含むアクション。
actor	Actor	イベントを開始したエージェント。ほとんどの場合、これは要求の承認コンテキストから発生する可能性があります。
id	string	イベント ID。
request	Request	イベントを生成した要求。
source	Source	イベントを生成したレジストリノード。別の言い方をすると、アクターがイベントを開始するときに、ソースによって生成されます。
target	Target	イベントのターゲット。
timestamp	string (date-time)	イベントが発生した時刻。

EventListResult

Object

Webhook のイベントを一覧表示する要求の結果。

名前	型	説明
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 またはホスト名と場合によってはポート。これは、標準の http 要求からの RemoteAddr です。
host	string	受信要求の http ホストヘッダーで指定された、レジストリインスタンスの外部からアクセス可能なホスト名。
id	string	イベントを開始した要求の ID。
method	string	イベントを生成した要求メソッド。
useragent	string	要求のユーザーエージェントヘッダー。

Source

Object

イベントを生成したレジストリノード。別の言い方をすると、アクターがイベントを開始するときに、ソースによって生成されます。

名前	型	説明
addr	string	イベントを生成したレジストリノードの IP またはホスト名とポート。一般に、これは os によって解決されます。Hostname() と実行中のポート。
instanceID	string	アプリケーションの実行中のインスタンス。再起動のたびに変更されます。

Target

Object

イベントのターゲット。

名前	型	説明
digest	string	レジストリ V2 HTTP API 仕様で定義されているコンテンツのダイジェスト。
length	integer (int64)	コンテンツのバイト数。 [サイズ] フィールドと同じです。
mediaType	string	参照先オブジェクトの MIME の種類。
name	string	成果物の名前。
repository	string	リポジトリ名。
size	integer (int64)	コンテンツのバイト数。長さフィールドと同じです。
tag	string	タグ名。
url	string	コンテンツへの直接 URL。
version	string	成果物のバージョン。

次の方法で共有

Webhooks - List Events

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

WebhookListEvents

要求のサンプル

応答のサンプル

定義

Actor

Event

EventContent

EventListResult

EventRequestMessage

EventResponseMessage

Request

Source

Target

その他のリソース