System Topic Event Subscriptions - Create Or Update

サービス:

Event Grid

API バージョン:

2022-06-15

システム トピックのイベント サブスクリプションを作成または更新します。
指定したパラメーターを使用して、イベント サブスクリプションを非同期的に作成または更新します。 既存のイベント サブスクリプションは、この API で更新されます。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}?api-version=2022-06-15

URI パラメーター

名前	/	必須	型	説明
eventSubscriptionName	path	True	string	作成されるイベント サブスクリプションの名前。 イベント サブスクリプション名の長さは 3 から 100 文字で、英数字のみを使用する必要があります。
resourceGroupName	path	True	string	ユーザーのサブスクリプション内のリソース グループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
systemTopicName	path	True	string	システム トピックの名前。
api-version	query	True	string	クライアント要求で使用される API のバージョン。

要求本文

名前	型	説明
properties.deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination	イベント サブスクリプションの配信不能の宛先。 送信先に配信できないイベントは、配信不能の宛先に送信されます。 Azure Event Gridの ID を使用して、配信/配信不能時に使用される認証トークンを取得します。
properties.deadLetterWithResourceIdentity	DeadLetterWithResourceIdentity	イベント サブスクリプションの配信不能の宛先。 送信先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。
properties.deliveryWithResourceIdentity	DeliveryWithResourceIdentity	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。
properties.destination	EventSubscriptionDestination: WebHookEventSubscriptionDestination EventHubEventSubscriptionDestination StorageQueueEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination AzureFunctionEventSubscriptionDestination	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 Azure Event Gridの ID を使用して、配信/配信不能時に使用される認証トークンを取得します。
properties.eventDeliverySchema	EventDeliverySchema	イベント サブスクリプションのイベント配信スキーマ。
properties.expirationTimeUtc	string	イベント サブスクリプションの有効期限。
properties.filter	EventSubscriptionFilter	イベント サブスクリプションのフィルターに関する情報。
properties.labels	string[]	ユーザー定義ラベルの一覧。
properties.retryPolicy	RetryPolicy	イベントの再試行ポリシー。 これは、配信試行の最大数とイベントの有効期間を構成するために使用できます。

応答

名前	型	説明
201 Created	EventSubscription	作成済み
Other Status Codes		エラー応答: *** 400 無効な要求です。 500 内部サーバー エラー :

例

SystemTopicEventSubscriptions_CreateOrUpdate

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/exampleEventSubscriptionName1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.eventgrid.fluent.models.EventSubscriptionInner;
import com.azure.resourcemanager.eventgrid.models.EventSubscriptionFilter;
import com.azure.resourcemanager.eventgrid.models.WebhookEventSubscriptionDestination;

/** Samples for SystemTopicEventSubscriptions CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
     */
    /**
     * Sample code: SystemTopicEventSubscriptions_CreateOrUpdate.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void systemTopicEventSubscriptionsCreateOrUpdate(
        com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager
            .systemTopicEventSubscriptions()
            .createOrUpdate(
                "examplerg",
                "exampleSystemTopic1",
                "exampleEventSubscriptionName1",
                new EventSubscriptionInner()
                    .withDestination(
                        new WebhookEventSubscriptionDestination().withEndpointUrl("https://requestb.in/15ksip71"))
                    .withFilter(
                        new EventSubscriptionFilter()
                            .withSubjectBeginsWith("ExamplePrefix")
                            .withSubjectEndsWith("ExampleSuffix")
                            .withIsSubjectCaseSensitive(false)),
                Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python system_topic_event_subscriptions_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EventGridManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.system_topic_event_subscriptions.begin_create_or_update(
        resource_group_name="examplerg",
        system_topic_name="exampleSystemTopic1",
        event_subscription_name="exampleEventSubscriptionName1",
        event_subscription_info={
            "properties": {
                "destination": {
                    "endpointType": "WebHook",
                    "properties": {"endpointUrl": "https://requestb.in/15ksip71"},
                },
                "filter": {
                    "isSubjectCaseSensitive": False,
                    "subjectBeginsWith": "ExamplePrefix",
                    "subjectEndsWith": "ExampleSuffix",
                },
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
if __name__ == "__main__":
    main()

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

Go

package armeventgrid_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
func ExampleSystemTopicEventSubscriptionsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSystemTopicEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleSystemTopic1", "exampleEventSubscriptionName1", armeventgrid.EventSubscription{
		Properties: &armeventgrid.EventSubscriptionProperties{
			Destination: &armeventgrid.WebHookEventSubscriptionDestination{
				EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
				Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
					EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
				},
			},
			Filter: &armeventgrid.EventSubscriptionFilter{
				IsSubjectCaseSensitive: to.Ptr(false),
				SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
				SubjectEndsWith:        to.Ptr("ExampleSuffix"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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

JavaScript

const { EventGridManagementClient } = require("@azure/arm-eventgrid");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
 *
 * @summary Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
 */
async function systemTopicEventSubscriptionsCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const systemTopicName = "exampleSystemTopic1";
  const eventSubscriptionName = "exampleEventSubscriptionName1";
  const eventSubscriptionInfo = {
    destination: {
      endpointType: "WebHook",
      endpointUrl: "https://requestb.in/15ksip71",
    },
    filter: {
      isSubjectCaseSensitive: false,
      subjectBeginsWith: "ExamplePrefix",
      subjectEndsWith: "ExampleSuffix",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.systemTopicEventSubscriptions.beginCreateOrUpdateAndWait(
    resourceGroupName,
    systemTopicName,
    eventSubscriptionName,
    eventSubscriptionInfo
  );
  console.log(result);
}

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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.EventGrid;
using Azure.ResourceManager.EventGrid.Models;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
// this example is just showing the usage of "SystemTopicEventSubscriptions_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SystemTopicResource created on azure
// for more information of creating SystemTopicResource, please refer to the document of SystemTopicResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
string systemTopicName = "exampleSystemTopic1";
ResourceIdentifier systemTopicResourceId = SystemTopicResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, systemTopicName);
SystemTopicResource systemTopic = client.GetSystemTopicResource(systemTopicResourceId);

// get the collection of this SystemTopicEventSubscriptionResource
SystemTopicEventSubscriptionCollection collection = systemTopic.GetSystemTopicEventSubscriptions();

// invoke the operation
string eventSubscriptionName = "exampleEventSubscriptionName1";
EventGridSubscriptionData data = new EventGridSubscriptionData()
{
    Destination = new WebHookEventSubscriptionDestination()
    {
        Endpoint = new Uri("https://requestb.in/15ksip71"),
    },
    Filter = new EventSubscriptionFilter()
    {
        SubjectBeginsWith = "ExamplePrefix",
        SubjectEndsWith = "ExampleSuffix",
        IsSubjectCaseSensitive = false,
    },
};
ArmOperation<SystemTopicEventSubscriptionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, eventSubscriptionName, data);
SystemTopicEventSubscriptionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
EventGridSubscriptionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:

201

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": null,
    "eventDeliverySchema": "EventGridSchema",
    "retryPolicy": {
      "maxDeliveryAttempts": 30,
      "eventTimeToLiveInMinutes": 1440
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/exampleEventSubscriptionName1",
  "name": "exampleEventSubscriptionName1",
  "type": "Microsoft.EventGrid/systemTopics/eventSubscriptions"
}

定義

名前	説明
AzureFunctionEventSubscriptionDestination	イベント サブスクリプションの Azure 関数の送信先に関する情報。
BoolEqualsAdvancedFilter	BoolEquals 高度なフィルター。
createdByType	リソースを作成した ID の種類。
DeadLetterWithResourceIdentity	リソース ID を持つ配信不能な宛先に関する情報。
DeliveryWithResourceIdentity	リソース ID を使用したイベント サブスクリプションの配信に関する情報。
DynamicDeliveryAttributeMapping	動的配信属性マッピングの詳細。
EventDeliverySchema	イベント サブスクリプションのイベント配信スキーマ。
EventHubEventSubscriptionDestination	イベント サブスクリプションのイベント ハブの送信先に関する情報。
EventSubscription	イベント サブスクリプション
EventSubscriptionFilter	イベント サブスクリプションをフィルター処理します。
EventSubscriptionIdentity	イベント サブスクリプションの ID 情報。
EventSubscriptionIdentityType	使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。
EventSubscriptionProvisioningState	イベント サブスクリプションのプロビジョニング状態。
HybridConnectionEventSubscriptionDestination	イベント サブスクリプションの HybridConnection 変換先に関する情報。
IsNotNullAdvancedFilter	IsNotNull 高度なフィルター。
IsNullOrUndefinedAdvancedFilter	IsNullOrUndefined 高度なフィルター。
NumberGreaterThanAdvancedFilter	NumberGreaterThan 高度なフィルター。
NumberGreaterThanOrEqualsAdvancedFilter	NumberGreaterThanOrEquals 高度なフィルター。
NumberInAdvancedFilter	NumberIn 高度なフィルター。
NumberInRangeAdvancedFilter	NumberInRange 高度なフィルター。
NumberLessThanAdvancedFilter	NumberLessThan 高度なフィルター。
NumberLessThanOrEqualsAdvancedFilter	NumberLessThanOrEquals 高度なフィルター。
NumberNotInAdvancedFilter	NumberNotIn 高度なフィルター。
NumberNotInRangeAdvancedFilter	NumberNotInRange 高度なフィルター。
RetryPolicy	イベント サブスクリプションの再試行ポリシーに関する情報。
ServiceBusQueueEventSubscriptionDestination	イベント サブスクリプションのサービス バスの宛先に関する情報。
ServiceBusTopicEventSubscriptionDestination	イベント サブスクリプションの Service Bus トピックの宛先に関する情報。
StaticDeliveryAttributeMapping	静的配信属性マッピングの詳細。
StorageBlobDeadLetterDestination	ストレージ BLOB ベースの配信不能の宛先に関する情報。
StorageQueueEventSubscriptionDestination	イベント サブスクリプションのストレージ キューの宛先に関する情報。
StringBeginsWithAdvancedFilter	StringBeginsWith Advanced Filter。
StringContainsAdvancedFilter	StringContains Advanced Filter。
StringEndsWithAdvancedFilter	StringEndsWith Advanced Filter。
StringInAdvancedFilter	StringIn 高度なフィルター。
StringNotBeginsWithAdvancedFilter	StringNotBeginsWith Advanced Filter。
StringNotContainsAdvancedFilter	StringNotContains 高度なフィルター。
StringNotEndsWithAdvancedFilter	StringNotEndsWith Advanced Filter。
StringNotInAdvancedFilter	StringNotIn 高度なフィルター。
systemData	リソースの作成と最後の変更に関連するメタデータ。
WebHookEventSubscriptionDestination	イベント サブスクリプションの Webhook 変換先に関する情報。

AzureFunctionEventSubscriptionDestination

イベント サブスクリプションの Azure 関数の送信先に関する情報。

名前	型	規定値	説明
endpointType	string: AzureFunction		イベント サブスクリプションの送信先のエンドポイントの種類。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		配信属性の詳細。
properties.maxEventsPerBatch	integer	1	バッチあたりのイベントの最大数。
properties.preferredBatchSizeInKilobytes	integer	64	推奨されるバッチ サイズ (キロバイト単位)。
properties.resourceId	string		イベント サブスクリプションの Azure 関数の宛先のエンドポイントを表す Azure リソース ID。

BoolEqualsAdvancedFilter

BoolEquals 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: BoolEquals	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
value	boolean	ブール値フィルター値。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

DeadLetterWithResourceIdentity

リソース ID を持つ配信不能な宛先に関する情報。

名前	型	説明
deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。
identity	EventSubscriptionIdentity	配信不能イベントの場合に使用する ID。

DeliveryWithResourceIdentity

リソース ID を使用したイベント サブスクリプションの配信に関する情報。

名前	型	説明
destination	EventSubscriptionDestination: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 Azure Event Gridの ID を使用して、配信/配信不能時に使用される認証トークンを取得します。
identity	EventSubscriptionIdentity	イベントを配信するときに使用する ID。

DynamicDeliveryAttributeMapping

動的配信属性マッピングの詳細。

名前	型	説明
name	string	配信属性またはヘッダーの名前。
properties.sourceField	string	属性値を含むイベント内の JSON パス。
type	string: Dynamic	配信属性またはヘッダー名の種類。

EventDeliverySchema

イベント サブスクリプションのイベント配信スキーマ。

名前	型	説明
CloudEventSchemaV1_0	string
CustomInputSchema	string
EventGridSchema	string

EventHubEventSubscriptionDestination

イベント サブスクリプションのイベント ハブの送信先に関する情報。

名前	型	説明
endpointType	string: EventHub	イベント サブスクリプションの送信先のエンドポイントの種類。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	配信属性の詳細。
properties.resourceId	string	イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。

EventSubscription

イベント サブスクリプション

名前	型	規定値	説明
id	string		リソースの完全修飾識別子。
name	string		リソースの名前。
properties.deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination		イベント サブスクリプションの配信不能の宛先。 送信先に配信できないイベントは、配信不能の宛先に送信されます。 Azure Event Gridの ID を使用して、配信/配信不能時に使用される認証トークンを取得します。
properties.deadLetterWithResourceIdentity	DeadLetterWithResourceIdentity		イベント サブスクリプションの配信不能の宛先。 送信先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。
properties.deliveryWithResourceIdentity	DeliveryWithResourceIdentity		イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。
properties.destination	EventSubscriptionDestination: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination		イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 Azure Event Gridの ID を使用して、配信/配信不能時に使用される認証トークンを取得します。
properties.eventDeliverySchema	EventDeliverySchema	EventGridSchema	イベント サブスクリプションのイベント配信スキーマ。
properties.expirationTimeUtc	string		イベント サブスクリプションの有効期限。
properties.filter	EventSubscriptionFilter		イベント サブスクリプションのフィルターに関する情報。
properties.labels	string[]		ユーザー定義ラベルの一覧。
properties.provisioningState	EventSubscriptionProvisioningState		イベント サブスクリプションのプロビジョニング状態。
properties.retryPolicy	RetryPolicy		イベントの再試行ポリシー。 これは、配信試行の最大数とイベントの有効期間を構成するために使用できます。
properties.topic	string		イベント サブスクリプションのトピックの名前。
systemData	systemData		イベント サブスクリプション リソースに関連するシステム メタデータ。
type	string		リソースの種類。

EventSubscriptionFilter

イベント サブスクリプションをフィルター処理します。

名前	型	規定値	説明
advancedFilters	AdvancedFilter[]: BoolEqualsAdvancedFilter[] IsNotNullAdvancedFilter[] IsNullOrUndefinedAdvancedFilter[] NumberGreaterThanAdvancedFilter[] NumberGreaterThanOrEqualsAdvancedFilter[] NumberInAdvancedFilter[] NumberInRangeAdvancedFilter[] NumberLessThanAdvancedFilter[] NumberLessThanOrEqualsAdvancedFilter[] NumberNotInAdvancedFilter[] NumberNotInRangeAdvancedFilter[] StringBeginsWithAdvancedFilter[] StringContainsAdvancedFilter[] StringEndsWithAdvancedFilter[] StringInAdvancedFilter[] StringNotBeginsWithAdvancedFilter[] StringNotContainsAdvancedFilter[] StringNotEndsWithAdvancedFilter[] StringNotInAdvancedFilter[]		イベント サブスクリプションのフィルター処理に使用される高度なフィルターの配列。
enableAdvancedFilteringOnArrays	boolean		単数形の値を想定するのではなく、値の配列に対して高度なフィルターを評価できるようにします。
includedEventTypes	string[]		イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 すべての既定のイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。
isSubjectCaseSensitive	boolean	False	フィルターの SubjectBeginsWith プロパティと SubjectEndsWith プロパティを大文字と小文字を区別して比較するかどうかを指定します。
subjectBeginsWith	string		リソース パス プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 この形式は、イベントの発行元によって異なります。 ワイルドカード文字は、このパスではサポートされていません。
subjectEndsWith	string		リソース パス サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字は、このパスではサポートされていません。

EventSubscriptionIdentity

イベント サブスクリプションの ID 情報。

名前	型	説明
type	EventSubscriptionIdentityType	使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。
userAssignedIdentity	string	リソースに関連付けられているユーザー ID。

EventSubscriptionIdentityType

使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。

名前	型	説明
SystemAssigned	string
UserAssigned	string

EventSubscriptionProvisioningState

イベント サブスクリプションのプロビジョニング状態。

名前	型	説明
AwaitingManualAction	string
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

HybridConnectionEventSubscriptionDestination

イベント サブスクリプションの HybridConnection 変換先に関する情報。

名前	型	説明
endpointType	string: HybridConnection	イベント サブスクリプションの送信先のエンドポイントの種類。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	配信属性の詳細。
properties.resourceId	string	イベント サブスクリプションの送信先であるハイブリッド接続の Azure リソース ID。

IsNotNullAdvancedFilter

IsNotNull 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: IsNotNull	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。

IsNullOrUndefinedAdvancedFilter

IsNullOrUndefined 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: IsNullOrUndefined	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。

NumberGreaterThanAdvancedFilter

NumberGreaterThan 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: NumberGreaterThan	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
value	number	フィルター値。

NumberGreaterThanOrEqualsAdvancedFilter

NumberGreaterThanOrEquals 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: NumberGreaterThanOrEquals	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
value	number	フィルター値。

NumberInAdvancedFilter

NumberIn 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: NumberIn	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
values	number[]	フィルター値のセット。

NumberInRangeAdvancedFilter

NumberInRange 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: NumberInRange	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
values	number[]	フィルター値のセット。

NumberLessThanAdvancedFilter

NumberLessThan 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: NumberLessThan	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
value	number	フィルター値。

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: NumberLessThanOrEquals	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
value	number	フィルター値。

NumberNotInAdvancedFilter

NumberNotIn 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: NumberNotIn	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
values	number[]	フィルター値のセット。

NumberNotInRangeAdvancedFilter

NumberNotInRange 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: NumberNotInRange	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
values	number[]	フィルター値のセット。

RetryPolicy

イベント サブスクリプションの再試行ポリシーに関する情報。

名前	型	規定値	説明
eventTimeToLiveInMinutes	integer	1440	イベントの Time To Live (分単位)。
maxDeliveryAttempts	integer	30	イベントの配信再試行の最大数。

ServiceBusQueueEventSubscriptionDestination

イベント サブスクリプションのサービス バスの宛先に関する情報。

名前	型	説明
endpointType	string: ServiceBusQueue	イベント サブスクリプションの送信先のエンドポイントの種類。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	配信属性の詳細。
properties.resourceId	string	イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。

ServiceBusTopicEventSubscriptionDestination

イベント サブスクリプションの Service Bus トピックの宛先に関する情報。

名前	型	説明
endpointType	string: ServiceBusTopic	イベント サブスクリプションの送信先のエンドポイントの種類。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	配信属性の詳細。
properties.resourceId	string	イベント サブスクリプションの Service Bus トピックの送信先のエンドポイントを表す Azure リソース ID。

StaticDeliveryAttributeMapping

静的配信属性マッピングの詳細。

名前	型	規定値	説明
name	string		配信属性またはヘッダーの名前。
properties.isSecret	boolean	False	属性に機密情報が含まれているかどうかを示すブール型フラグ。
properties.value	string		配信属性の値。
type	string: Static		配信属性またはヘッダー名の種類。

StorageBlobDeadLetterDestination

ストレージ BLOB ベースの配信不能の宛先に関する情報。

名前	型	説明
endpointType	string: StorageBlob	配信不能の宛先のエンドポイントの種類
properties.blobContainerName	string	配信不能イベントの送信先であるストレージ BLOB コンテナーの名前
properties.resourceId	string	配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID

StorageQueueEventSubscriptionDestination

イベント サブスクリプションのストレージ キューの宛先に関する情報。

名前	型	説明
endpointType	string: StorageQueue	イベント サブスクリプションの送信先のエンドポイントの種類。
properties.queueMessageTimeToLiveInSeconds	integer	ストレージ キュー メッセージの有効期間 (秒単位)。
properties.queueName	string	イベント サブスクリプションの送信先であるストレージ アカウントの下にあるストレージ キューの名前。
properties.resourceId	string	イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。

StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: StringBeginsWith	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
values	string[]	フィルター値のセット。

StringContainsAdvancedFilter

StringContains Advanced Filter。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: StringContains	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
values	string[]	フィルター値のセット。

StringEndsWithAdvancedFilter

StringEndsWith Advanced Filter。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: StringEndsWith	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
values	string[]	フィルター値のセット。

StringInAdvancedFilter

StringIn 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: StringIn	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
values	string[]	フィルター値のセット。

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: StringNotBeginsWith	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
values	string[]	フィルター値のセット。

StringNotContainsAdvancedFilter

StringNotContains 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: StringNotContains	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
values	string[]	フィルター値のセット。

StringNotEndsWithAdvancedFilter

StringNotEndsWith Advanced Filter。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: StringNotEndsWith	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
values	string[]	フィルター値のセット。

StringNotInAdvancedFilter

StringNotIn 高度なフィルター。

名前	型	説明
key	string	フィルター処理するイベントのフィールド/プロパティ。
operatorType	string: StringNotIn	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。
values	string[]	フィルター値のセット。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

WebHookEventSubscriptionDestination

イベント サブスクリプションの Webhook 変換先に関する情報。

名前	型	規定値	説明
endpointType	string: WebHook		イベント サブスクリプションの送信先のエンドポイントの種類。
properties.azureActiveDirectoryApplicationIdOrUri	string		配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory アプリケーション ID または URI。
properties.azureActiveDirectoryTenantId	string		配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory テナント ID。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		配信属性の詳細。
properties.endpointBaseUrl	string		イベント サブスクリプションの送信先のエンドポイントを表すベース URL。
properties.endpointUrl	string		イベント サブスクリプションの送信先のエンドポイントを表す URL。
properties.maxEventsPerBatch	integer	1	バッチあたりのイベントの最大数。
properties.preferredBatchSizeInKilobytes	integer	64	推奨されるバッチ サイズ (キロバイト単位)。