Microsoft.EventGrid eventSubscriptions 2021-12-01

  • [アーティクル]

Bicep リソース定義

eventSubscriptions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。

このリソースの スコープを scope 設定するには、このリソースの プロパティを使用します。 「Bicep で拡張機能リソースのスコープを設定する」を参照してください。

eventSubscriptions リソースの種類は、次をターゲットとする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.EventGrid/eventSubscriptions リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2021-12-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    eventDeliverySchema: 'string'
    expirationTimeUtc: 'string'
    filter: {
      advancedFilters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see AdvancedFilter objects
        }
      ]
      enableAdvancedFilteringOnArrays: bool
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
    retryPolicy: {
      eventTimeToLiveInMinutes: int
      maxDeliveryAttempts: int
    }
  }
}

DeadLetterDestination オブジェクト

endpointType プロパティを設定して、オブジェクトの種類を指定します。

StorageBlob の場合は、次の値を使用します。

  endpointType: 'StorageBlob'
  properties: {
    blobContainerName: 'string'
    resourceId: 'string'
  }

EventSubscriptionDestination オブジェクト

endpointType プロパティを設定して、オブジェクトの種類を指定します。

AzureFunction の場合は、次を使用します。

  endpointType: 'AzureFunction'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
    resourceId: 'string'
  }

EventHub の場合は、次の値を使用します。

  endpointType: 'EventHub'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }

HybridConnection の場合は、次の値を使用します。

  endpointType: 'HybridConnection'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }

ServiceBusQueue の場合は、次の値を使用します。

  endpointType: 'ServiceBusQueue'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }

ServiceBusTopic の場合は、次の値を使用します。

  endpointType: 'ServiceBusTopic'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }

StorageQueue の場合は、次の値を使用します。

  endpointType: 'StorageQueue'
  properties: {
    queueMessageTimeToLiveInSeconds: int
    queueName: 'string'
    resourceId: 'string'
  }

WebHook の場合は、次の値を使用します。

  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl: 'string'
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
  }

DeliveryAttributeMapping オブジェクト

type プロパティを設定して、オブジェクトの種類を指定します。

[動的] には、次の値を使用します。

  type: 'Dynamic'
  properties: {
    sourceField: 'string'
  }

Static の場合は、次の値を使用します。

  type: 'Static'
  properties: {
    isSecret: bool
    value: 'string'
  }

AdvancedFilter オブジェクト

オブジェクトの種類を指定するには、 operatorType プロパティを設定します。

BoolEquals の場合は、次の値を使用します。

  operatorType: 'BoolEquals'
  value: bool

IsNotNull の場合は、次の値を使用します。

  operatorType: 'IsNotNull'

IsNullOrUndefined の場合は、次の値を使用します。

  operatorType: 'IsNullOrUndefined'

NumberGreaterThan の場合は、次の値を使用します。

  operatorType: 'NumberGreaterThan'
  value: int

NumberGreaterThanOrEquals の場合は、次の値を使用します。

  operatorType: 'NumberGreaterThanOrEquals'
  value: int

NumberIn の場合は、次の値を使用します。

  operatorType: 'NumberIn'
  values: [
    int
  ]

NumberInRange の場合は、次の値を使用します。

  operatorType: 'NumberInRange'
  values: [
    [
      int
    ]
  ]

NumberLessThan の場合は、次の値を使用します。

  operatorType: 'NumberLessThan'
  value: int

NumberLessThanOrEquals の場合は、次の値を使用します。

  operatorType: 'NumberLessThanOrEquals'
  value: int

NumberNotIn の場合は、次の値を使用します。

  operatorType: 'NumberNotIn'
  values: [
    int
  ]

NumberNotInRange の場合は、次の値を使用します。

  operatorType: 'NumberNotInRange'
  values: [
    [
      int
    ]
  ]

StringBeginsWith の場合は、次の値を使用します。

  operatorType: 'StringBeginsWith'
  values: [
    'string'
  ]

StringContains の場合は、次を使用します。

  operatorType: 'StringContains'
  values: [
    'string'
  ]

StringEndsWith の場合は、次の値を使用します。

  operatorType: 'StringEndsWith'
  values: [
    'string'
  ]

StringIn の場合は、次の値を使用します。

  operatorType: 'StringIn'
  values: [
    'string'
  ]

StringNotBeginsWith の場合は、次の値を使用します。

  operatorType: 'StringNotBeginsWith'
  values: [
    'string'
  ]

StringNotContains の場合は、次を使用します。

  operatorType: 'StringNotContains'
  values: [
    'string'
  ]

StringNotEndsWith の場合は、次の値を使用します。

  operatorType: 'StringNotEndsWith'
  values: [
    'string'
  ]

StringNotIn の場合は、次の値を使用します。

  operatorType: 'StringNotIn'
  values: [
    'string'
  ]

プロパティ値

eventSubscriptions

名前 説明 値
name リソース名 string (必須)

文字数制限: 3 から 64

有効な文字:
英数字とハイフン。
scope デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 ターゲット リソース

Bicep の場合は、このプロパティをリソースのシンボリック名に設定して 、拡張機能リソースを適用します。
properties イベント サブスクリプションのプロパティ。 EventSubscriptionProperties

EventSubscriptionProperties

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

DeadLetterDestination

名前 説明 値
endpointType オブジェクトの種類を設定する StorageBlob (必須)

StorageBlobDeadLetterDestination

名前 説明 値
endpointType 配信不能の宛先のエンドポイントの種類 'StorageBlob' (必須)
properties ストレージ BLOB ベースの配信不能宛先のプロパティ StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名前 説明 値
blobContainerName 配信不能イベントの送信先であるストレージ BLOB コンテナーの名前 string
resourceId 配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID string

DeadLetterWithResourceIdentity

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

EventSubscriptionIdentity

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

DeliveryWithResourceIdentity

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

EventSubscriptionDestination

名前 説明 値
endpointType オブジェクトの種類を設定する AzureFunction
EventHub
HybridConnection
ServiceBusQueue
ServiceBusTopic
StorageQueue
WebHook (必須)

AzureFunctionEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの宛先のエンドポイントの種類。 'AzureFunction' (必須)
properties イベント サブスクリプションの送信先の Azure 関数のプロパティ。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
maxEventsPerBatch バッチあたりのイベントの最大数。 INT
preferredBatchSizeInKilobytes 推奨されるバッチ サイズ (キロバイト単位)。 INT
resourceId イベント サブスクリプションの Azure 関数の送信先のエンドポイントを表す Azure リソース ID。 string

DeliveryAttributeMapping

名前 説明 値
name 配信属性またはヘッダーの名前。 string
type オブジェクトの種類を設定する 動的
静的 (必須)

DynamicDeliveryAttributeMapping

名前 説明 値
type 配信属性またはヘッダー名の種類。 'Dynamic' (必須)
properties 動的配信属性マッピングのプロパティ。 DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

名前 説明 値
sourceField 属性値を含むイベント内の JSON パス。 string

StaticDeliveryAttributeMapping

名前 説明 値
type 配信属性またはヘッダー名の種類。 'Static' (必須)
properties 静的配信属性マッピングのプロパティ。 StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

名前 説明 値
isSecret 属性に機密情報が含まれているかどうかを示すブール型 (Boolean) フラグ。 [bool]
value 配信属性の値。 string

EventHubEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの宛先のエンドポイントの種類。 'EventHub' (必須)
properties イベント サブスクリプションの送信先の Event Hub プロパティ。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
resourceId イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。 string

HybridConnectionEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの宛先のエンドポイントの種類。 'HybridConnection' (必須)
properties イベント サブスクリプションの送信先のハイブリッド接続プロパティ。 HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
resourceId イベント サブスクリプションの送信先であるハイブリッド接続の Azure リソース ID。 string

ServiceBusQueueEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類。 'ServiceBusQueue' (必須)
properties イベント サブスクリプションの送信先の Service Bus プロパティ。 ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
resourceId イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。 string

ServiceBusTopicEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類。 'ServiceBusTopic' (必須)
properties イベント サブスクリプションの送信先の Service Bus トピックのプロパティ。 ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

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

StorageQueueEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類。 'StorageQueue' (必須)
properties イベント サブスクリプションの送信先のストレージ キューのプロパティ。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類。 'WebHook' (必須)
properties イベント サブスクリプションの宛先の WebHook プロパティ。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名前 説明 値
azureActiveDirectoryApplicationIdOrUri 配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory アプリケーション ID または URI。 string
azureActiveDirectoryTenantId 配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory テナント ID。 string
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
endpointUrl イベント サブスクリプションの送信先のエンドポイントを表す URL。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
maxEventsPerBatch バッチあたりのイベントの最大数。 INT
preferredBatchSizeInKilobytes 推奨されるバッチ サイズ (キロバイト単位)。 INT

EventSubscriptionFilter

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

AdvancedFilter

名前 説明 値
キー フィルター処理するイベントのフィールド/プロパティ。 string
operatorType オブジェクトの種類を設定する BoolEquals です。
IsNotNull
IsNullOrUndefined
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberInRange
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
NumberNotInRange
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (必須)

BoolEqualsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'BoolEquals' (必須)
value ブール値フィルター値。 [bool]

IsNotNullAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'IsNotNull' (必須)

IsNullOrUndefinedAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'IsNullOrUndefined' (必須)

NumberGreaterThanAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberGreaterThan' (必須)
value フィルター値。 INT

NumberGreaterThanOrEqualsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberGreaterThanOrEquals' (必須)
value フィルター値。 INT

NumberInAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberIn' (必須)
値 フィルター値のセット。 int[]

NumberInRangeAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberInRange' (必須)
値 フィルター値のセット。 int[][]

NumberLessThanAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberLessThan' (必須)
value フィルター値。 INT

NumberLessThanOrEqualsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberLessThanOrEquals' (必須)
value フィルター値。 INT

NumberNotInAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberNotIn' (必須)
値 フィルター値のセット。 int[]

NumberNotInRangeAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberNotInRange' (必須)
値 フィルター値のセット。 int[][]

StringBeginsWithAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringBeginsWith' (必須)
値 フィルター値のセット。 string[]

StringContainsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringContains' (必須)
値 フィルター値のセット。 string[]

StringEndsWithAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringEndsWith' (必須)
値 フィルター値のセット。 string[]

StringInAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringIn' (必須)
値 フィルター値のセット。 string[]

StringNotBeginsWithAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringNotBeginsWith' (必須)
値 フィルター値のセット。 string[]

StringNotContainsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringNotContains' (必須)
値 フィルター値のセット。 string[]

StringNotEndsWithAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringNotEndsWith' (必須)
値 フィルター値のセット。 string[]

StringNotInAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringNotIn' (必須)
値 フィルター値のセット。 string[]

RetryPolicy

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

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
カスタム トピックとサブスクリプションAzure Event Grid作成する

Azure にデプロイする		 Azure Event Gridカスタム トピックと Webhook サブスクリプションを作成します。 最初に John Downs によって作成されたテンプレート。
CloudEvents を使用したカスタム Azure Event Grid トピック/サブスクリプション

Azure にデプロイする		 カスタム Azure Event Grid トピック、CloudEvents スキーマを持つ Webhook サブスクリプション、およびイベント ハンドラーとしてのロジック アプリを作成します。 テンプレートは、もともと Justin Yoo によって作成されました。
Event Grid カスタム トピックとイベント ハブ ハンドラーを作成する

Azure にデプロイする		 イベントを処理Azure Event Gridカスタム トピックとイベント ハブを作成します。
リソース イベントの Event Grid サブスクリプションを作成する

Azure にデプロイする		 リソース グループまたは Azure サブスクリプションのいずれかに Event Grid サブスクリプションを作成します。
カスタム トピックとキュー サブスクリプションAzure Event Grid作成する

Azure にデプロイする		 Azure Event Gridカスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートは、もともと Markus Meyer によって作成されました。
カスタム トピック サブスクリプションAzure Event Grid作成する

Azure にデプロイする		 Azure Event Gridカスタム トピックと Service Bus トピック サブスクリプションを作成します。 テンプレートは、もともと Markus Meyer によって作成されました。

ARM テンプレート リソース定義

eventSubscriptions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。

このリソースの プロパティを scope 使用して、このリソースのスコープを設定します。 「ARM テンプレートで拡張機能リソースのスコープを設定する」を参照してください。

eventSubscriptions リソースの種類は、次をターゲットとする操作と共にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.EventGrid/eventSubscriptions リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2021-12-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "deadLetterWithResourceIdentity": {
      "deadLetterDestination": {
        "endpointType": "string"
        // For remaining properties, see DeadLetterDestination objects
      },
      "identity": {
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "deliveryWithResourceIdentity": {
      "destination": {
        "endpointType": "string"
        // For remaining properties, see EventSubscriptionDestination objects
      },
      "identity": {
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "eventDeliverySchema": "string",
    "expirationTimeUtc": "string",
    "filter": {
      "advancedFilters": [
        {
          "key": "string",
          "operatorType": "string"
          // For remaining properties, see AdvancedFilter objects
        }
      ],
      "enableAdvancedFilteringOnArrays": "bool",
      "includedEventTypes": [ "string" ],
      "isSubjectCaseSensitive": "bool",
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string"
    },
    "labels": [ "string" ],
    "retryPolicy": {
      "eventTimeToLiveInMinutes": "int",
      "maxDeliveryAttempts": "int"
    }
  }
}

DeadLetterDestination オブジェクト

endpointType プロパティを設定して、オブジェクトの種類を指定します。

StorageBlob の場合は、次の値を使用します。

  "endpointType": "StorageBlob",
  "properties": {
    "blobContainerName": "string",
    "resourceId": "string"
  }

EventSubscriptionDestination オブジェクト

endpointType プロパティを設定して、オブジェクトの種類を指定します。

AzureFunction の場合は、次を使用します。

  "endpointType": "AzureFunction",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "maxEventsPerBatch": "int",
    "preferredBatchSizeInKilobytes": "int",
    "resourceId": "string"
  }

EventHub の場合は、次の値を使用します。

  "endpointType": "EventHub",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "resourceId": "string"
  }

HybridConnection の場合は、次の値を使用します。

  "endpointType": "HybridConnection",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "resourceId": "string"
  }

ServiceBusQueue の場合は、次の値を使用します。

  "endpointType": "ServiceBusQueue",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "resourceId": "string"
  }

ServiceBusTopic の場合は、次の値を使用します。

  "endpointType": "ServiceBusTopic",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "resourceId": "string"
  }

StorageQueue の場合は、次の値を使用します。

  "endpointType": "StorageQueue",
  "properties": {
    "queueMessageTimeToLiveInSeconds": "int",
    "queueName": "string",
    "resourceId": "string"
  }

WebHook の場合は、次の値を使用します。

  "endpointType": "WebHook",
  "properties": {
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string",
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "endpointUrl": "string",
    "maxEventsPerBatch": "int",
    "preferredBatchSizeInKilobytes": "int"
  }

DeliveryAttributeMapping オブジェクト

type プロパティを設定して、オブジェクトの種類を指定します。

[動的] には、次の値を使用します。

  "type": "Dynamic",
  "properties": {
    "sourceField": "string"
  }

Static の場合は、次の値を使用します。

  "type": "Static",
  "properties": {
    "isSecret": "bool",
    "value": "string"
  }

AdvancedFilter オブジェクト

オブジェクトの種類を指定するには、 operatorType プロパティを設定します。

BoolEquals の場合は、次の値を使用します。

  "operatorType": "BoolEquals",
  "value": "bool"

IsNotNull の場合は、次の値を使用します。

  "operatorType": "IsNotNull"

IsNullOrUndefined の場合は、次の値を使用します。

  "operatorType": "IsNullOrUndefined"

NumberGreaterThan の場合は、次の値を使用します。

  "operatorType": "NumberGreaterThan",
  "value": "int"

NumberGreaterThanOrEquals の場合は、次の値を使用します。

  "operatorType": "NumberGreaterThanOrEquals",
  "value": "int"

NumberIn の場合は、次の値を使用します。

  "operatorType": "NumberIn",
  "values": [ "int" ]

NumberInRange の場合は、次の値を使用します。

  "operatorType": "NumberInRange",
  "values": [ [ "int" ] ]

NumberLessThan の場合は、次の値を使用します。

  "operatorType": "NumberLessThan",
  "value": "int"

NumberLessThanOrEquals の場合は、次の値を使用します。

  "operatorType": "NumberLessThanOrEquals",
  "value": "int"

NumberNotIn の場合は、次の値を使用します。

  "operatorType": "NumberNotIn",
  "values": [ "int" ]

NumberNotInRange の場合は、次の値を使用します。

  "operatorType": "NumberNotInRange",
  "values": [ [ "int" ] ]

StringBeginsWith の場合は、次の値を使用します。

  "operatorType": "StringBeginsWith",
  "values": [ "string" ]

StringContains の場合は、次を使用します。

  "operatorType": "StringContains",
  "values": [ "string" ]

StringEndsWith の場合は、次の値を使用します。

  "operatorType": "StringEndsWith",
  "values": [ "string" ]

StringIn の場合は、次の値を使用します。

  "operatorType": "StringIn",
  "values": [ "string" ]

StringNotBeginsWith の場合は、次の値を使用します。

  "operatorType": "StringNotBeginsWith",
  "values": [ "string" ]

StringNotContains の場合は、次を使用します。

  "operatorType": "StringNotContains",
  "values": [ "string" ]

StringNotEndsWith の場合は、次の値を使用します。

  "operatorType": "StringNotEndsWith",
  "values": [ "string" ]

StringNotIn の場合は、次の値を使用します。

  "operatorType": "StringNotIn",
  "values": [ "string" ]

プロパティ値

eventSubscriptions

名前 説明 値
type リソースの種類 'Microsoft.EventGrid/eventSubscriptions'
apiVersion リソース API のバージョン '2021-12-01'
name リソース名 string (必須)

文字数制限: 3 から 64

有効な文字:
英数字とハイフン。
scope デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 ターゲット リソース

JSON の場合は、 拡張 リソースを適用するリソースの完全な名前に値を設定します。
properties イベント サブスクリプションのプロパティ。 EventSubscriptionProperties

EventSubscriptionProperties

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

DeadLetterDestination

名前 説明 値
endpointType オブジェクトの種類を設定する StorageBlob (必須)

StorageBlobDeadLetterDestination

名前 説明 値
endpointType 配信不能の宛先のエンドポイントの種類 'StorageBlob' (必須)
properties ストレージ BLOB ベースの配信不能宛先のプロパティ StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名前 説明 値
blobContainerName 配信不能イベントの送信先であるストレージ BLOB コンテナーの名前 string
resourceId 配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID string

DeadLetterWithResourceIdentity

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

EventSubscriptionIdentity

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

DeliveryWithResourceIdentity

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

EventSubscriptionDestination

名前 説明 値
endpointType オブジェクトの種類を設定する AzureFunction
EventHub
HybridConnection
ServiceBusQueue
ServiceBusTopic
StorageQueue
WebHook (必須)

AzureFunctionEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類。 'AzureFunction' (必須)
properties イベント サブスクリプションの送信先の Azure 関数のプロパティ。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
maxEventsPerBatch バッチあたりのイベントの最大数。 INT
preferredBatchSizeInKilobytes 推奨されるバッチ サイズ (キロバイト単位)。 INT
resourceId イベント サブスクリプションの Azure 関数の宛先のエンドポイントを表す Azure リソース ID。 string

DeliveryAttributeMapping

名前 説明 値
name 配信属性またはヘッダーの名前。 string
type オブジェクトの種類を設定する 動的
静的 (必須)

DynamicDeliveryAttributeMapping

名前 説明 値
type 配信属性またはヘッダー名の種類。 'Dynamic' (必須)
properties 動的配信属性マッピングのプロパティ。 DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

名前 説明 値
sourceField 属性値を含むイベント内の JSON パス。 string

StaticDeliveryAttributeMapping

名前 説明 値
type 配信属性またはヘッダー名の種類。 'Static' (必須)
properties 静的配信属性マッピングのプロパティ。 StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

名前 説明 値
isSecret 属性に機密情報が含まれているかどうかを示すブール型 (Boolean) フラグ。 [bool]
value 配信属性の値。 string

EventHubEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの宛先のエンドポイントの種類。 'EventHub' (必須)
properties イベント サブスクリプションの送信先の Event Hub プロパティ。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
resourceId イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。 string

HybridConnectionEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの宛先のエンドポイントの種類。 'HybridConnection' (必須)
properties ハイブリッド接続 イベント サブスクリプションの送信先のプロパティ。 HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
resourceId イベント サブスクリプションの宛先であるハイブリッド接続の Azure リソース ID。 string

ServiceBusQueueEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの宛先のエンドポイントの種類。 'ServiceBusQueue' (必須)
properties イベント サブスクリプションの送信先の Service Bus プロパティ。 ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
resourceId イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。 string

ServiceBusTopicEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類。 'ServiceBusTopic' (必須)
properties イベント サブスクリプションの送信先の Service Bus トピックのプロパティ。 ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

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

StorageQueueEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類。 'StorageQueue' (必須)
properties イベント サブスクリプションの送信先のストレージ キューのプロパティ。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類。 'WebHook' (必須)
properties イベント サブスクリプションの宛先の WebHook プロパティ。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名前 説明 値
azureActiveDirectoryApplicationIdOrUri 配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory アプリケーション ID または URI。 string
azureActiveDirectoryTenantId 配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory テナント ID。 string
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
endpointUrl イベント サブスクリプションの送信先のエンドポイントを表す URL。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
maxEventsPerBatch バッチあたりのイベントの最大数。 INT
preferredBatchSizeInKilobytes 推奨されるバッチ サイズ (キロバイト単位)。 INT

EventSubscriptionFilter

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

AdvancedFilter

名前 説明 値
キー フィルター処理するイベントのフィールド/プロパティ。 string
operatorType オブジェクトの種類を設定する BoolEquals です。
IsNotNull
IsNullOrUndefined
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberInRange
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
NumberNotInRange
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (必須)

BoolEqualsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'BoolEquals' (必須)
value ブール値フィルター値。 [bool]

IsNotNullAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'IsNotNull' (必須)

IsNullOrUndefinedAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'IsNullOrUndefined' (必須)

NumberGreaterThanAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberGreaterThan' (必須)
value フィルター値。 INT

NumberGreaterThanOrEqualsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberGreaterThanOrEquals' (必須)
value フィルター値。 INT

NumberInAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberIn' (必須)
値 フィルター値のセット。 int[]

NumberInRangeAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberInRange' (必須)
値 フィルター値のセット。 int[][]

NumberLessThanAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberLessThan' (必須)
value フィルター値。 INT

NumberLessThanOrEqualsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberLessThanOrEquals' (必須)
value フィルター値。 INT

NumberNotInAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberNotIn' (必須)
値 フィルター値のセット。 int[]

NumberNotInRangeAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'NumberNotInRange' (必須)
値 フィルター値のセット。 int[][]

StringBeginsWithAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringBeginsWith' (必須)
値 フィルター値のセット。 string[]

StringContainsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringContains' (必須)
値 フィルター値のセット。 string[]

StringEndsWithAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringEndsWith' (必須)
値 フィルター値のセット。 string[]

StringInAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringIn' (必須)
値 フィルター値のセット。 string[]

StringNotBeginsWithAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringNotBeginsWith' (必須)
値 フィルター値のセット。 string[]

StringNotContainsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringNotContains' (必須)
値 フィルター値のセット。 string[]

StringNotEndsWithAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringNotEndsWith' (必須)
値 フィルター値のセット。 string[]

StringNotInAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 'StringNotIn' (必須)
値 フィルター値のセット。 string[]

RetryPolicy

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

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
カスタム トピックとサブスクリプションAzure Event Grid作成する

Azure にデプロイする		 Azure Event Gridカスタム トピックと Webhook サブスクリプションを作成します。 最初に John Downs によって作成されたテンプレート。
CloudEvents を使用したカスタム Azure Event Grid トピック/サブスクリプション

Azure にデプロイする		 カスタム Azure Event Grid トピック、CloudEvents スキーマを持つ Webhook サブスクリプション、およびイベント ハンドラーとしてのロジック アプリを作成します。 テンプレートは、もともと Justin Yoo によって作成されました。
Event Grid カスタム トピックとイベント ハブ ハンドラーを作成する

Azure にデプロイする		 イベントを処理Azure Event Gridカスタム トピックとイベント ハブを作成します。
リソース イベントの Event Grid サブスクリプションを作成する

Azure にデプロイする		 リソース グループまたは Azure サブスクリプションのいずれかに Event Grid サブスクリプションを作成します。
カスタム トピックとキュー サブスクリプションAzure Event Grid作成する

Azure にデプロイする		 Azure Event Gridカスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートは、もともと Markus Meyer によって作成されました。
カスタム トピック サブスクリプションAzure Event Grid作成する

Azure にデプロイする		 Azure Event Gridカスタム トピックと Service Bus トピック サブスクリプションを作成します。 テンプレートは、もともと Markus Meyer によって作成されました。

Terraform (AzAPI プロバイダー) リソース定義

eventSubscriptions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。

このリソースの プロパティを parent_id 使用して、このリソースのスコープを設定します。

eventSubscriptions リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループ
  • サブスクリプション

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.EventGrid/eventSubscriptions リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2021-12-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      deadLetterWithResourceIdentity = {
        deadLetterDestination = {
          endpointType = "string"
          // For remaining properties, see DeadLetterDestination objects
        }
        identity = {
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      deliveryWithResourceIdentity = {
        destination = {
          endpointType = "string"
          // For remaining properties, see EventSubscriptionDestination objects
        }
        identity = {
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      destination = {
        endpointType = "string"
        // For remaining properties, see EventSubscriptionDestination objects
      }
      eventDeliverySchema = "string"
      expirationTimeUtc = "string"
      filter = {
        advancedFilters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see AdvancedFilter objects
          }
        ]
        enableAdvancedFilteringOnArrays = bool
        includedEventTypes = [
          "string"
        ]
        isSubjectCaseSensitive = bool
        subjectBeginsWith = "string"
        subjectEndsWith = "string"
      }
      labels = [
        "string"
      ]
      retryPolicy = {
        eventTimeToLiveInMinutes = int
        maxDeliveryAttempts = int
      }
    }
  })
}

DeadLetterDestination オブジェクト

endpointType プロパティを設定して、オブジェクトの種類を指定します。

StorageBlob の場合は、次の値を使用します。

  endpointType = "StorageBlob"
  properties = {
    blobContainerName = "string"
    resourceId = "string"
  }

EventSubscriptionDestination オブジェクト

endpointType プロパティを設定して、オブジェクトの種類を指定します。

AzureFunction の場合は、次を使用します。

  endpointType = "AzureFunction"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    maxEventsPerBatch = int
    preferredBatchSizeInKilobytes = int
    resourceId = "string"
  }

EventHub の場合は、次の値を使用します。

  endpointType = "EventHub"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }

HybridConnection の場合は、次の値を使用します。

  endpointType = "HybridConnection"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }

ServiceBusQueue の場合は、次の値を使用します。

  endpointType = "ServiceBusQueue"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }

ServiceBusTopic の場合は、次の値を使用します。

  endpointType = "ServiceBusTopic"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }

StorageQueue の場合は、次の値を使用します。

  endpointType = "StorageQueue"
  properties = {
    queueMessageTimeToLiveInSeconds = int
    queueName = "string"
    resourceId = "string"
  }

WebHook の場合は、次の値を使用します。

  endpointType = "WebHook"
  properties = {
    azureActiveDirectoryApplicationIdOrUri = "string"
    azureActiveDirectoryTenantId = "string"
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl = "string"
    maxEventsPerBatch = int
    preferredBatchSizeInKilobytes = int
  }

DeliveryAttributeMapping オブジェクト

オブジェクトの 型 を指定するには、type プロパティを設定します。

Dynamic の場合は、次の値を使用します。

  type = "Dynamic"
  properties = {
    sourceField = "string"
  }

Static の場合は、次の値を使用します。

  type = "Static"
  properties = {
    isSecret = bool
    value = "string"
  }

AdvancedFilter オブジェクト

オブジェクトの種類を指定するには、 operatorType プロパティを設定します。

BoolEquals の場合は、次の値を使用します。

  operatorType = "BoolEquals"
  value = bool

IsNotNull の場合は、次の値を使用します。

  operatorType = "IsNotNull"

IsNullOrUndefined の場合は、次の値を使用します。

  operatorType = "IsNullOrUndefined"

NumberGreaterThan の場合は、次の値を使用します。

  operatorType = "NumberGreaterThan"
  value = int

NumberGreaterThanOrEquals の場合は、次の値を使用します。

  operatorType = "NumberGreaterThanOrEquals"
  value = int

NumberIn の場合は、次の値を使用します。

  operatorType = "NumberIn"
  values = [
    int
  ]

NumberInRange の場合は、次の値を使用します。

  operatorType = "NumberInRange"
  values = [
    [
      int
    ]
  ]

NumberLessThan の場合は、次の値を使用します。

  operatorType = "NumberLessThan"
  value = int

NumberLessThanOrEquals の場合は、次の値を使用します。

  operatorType = "NumberLessThanOrEquals"
  value = int

NumberNotIn の場合は、次の値を使用します。

  operatorType = "NumberNotIn"
  values = [
    int
  ]

NumberNotInRange の場合は、次の値を使用します。

  operatorType = "NumberNotInRange"
  values = [
    [
      int
    ]
  ]

StringBeginsWith の場合は、次の値を使用します。

  operatorType = "StringBeginsWith"
  values = [
    "string"
  ]

StringContains の場合は、次の値を使用します。

  operatorType = "StringContains"
  values = [
    "string"
  ]

StringEndsWith の場合は、次の値を使用します。

  operatorType = "StringEndsWith"
  values = [
    "string"
  ]

StringIn の場合は、次の値を使用します。

  operatorType = "StringIn"
  values = [
    "string"
  ]

StringNotBeginsWith の場合は、次の値を使用します。

  operatorType = "StringNotBeginsWith"
  values = [
    "string"
  ]

StringNotContains の場合は、次の値を使用します。

  operatorType = "StringNotContains"
  values = [
    "string"
  ]

StringNotEndsWith の場合は、次の値を使用します。

  operatorType = "StringNotEndsWith"
  values = [
    "string"
  ]

StringNotIn の場合は、次の値を使用します。

  operatorType = "StringNotIn"
  values = [
    "string"
  ]

プロパティ値

eventSubscriptions

名前 説明 値
type リソースの種類 "Microsoft.EventGrid/eventSubscriptions@2021-12-01"
name リソース名 string (必須)

文字制限: 3 から 64

有効な文字:
英数字とハイフン。
parent_id この拡張機能リソースを適用するリソースの ID。 string (必須)
properties イベント サブスクリプションのプロパティ。 EventSubscriptionProperties

EventSubscriptionProperties

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

DeadLetterDestination

名前 説明 値
endpointType オブジェクトの種類を設定する StorageBlob (必須)

StorageBlobDeadLetterDestination

名前 説明 値
endpointType 配信不能の宛先のエンドポイントの種類 "StorageBlob" (必須)
properties ストレージ BLOB ベースの配信不能宛先のプロパティ StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名前 説明 値
blobContainerName 配信不能イベントの宛先であるストレージ BLOB コンテナーの名前 string
resourceId 配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID string

DeadLetterWithResourceIdentity

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

EventSubscriptionIdentity

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

DeliveryWithResourceIdentity

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

EventSubscriptionDestination

名前 説明 値
endpointType オブジェクトの種類を設定する AzureFunction
EventHub
HybridConnection
ServiceBusQueue
ServiceBusTopic
StorageQueue
WebHook (必須)

AzureFunctionEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類。 "AzureFunction" (必須)
properties イベント サブスクリプションの送信先の Azure 関数のプロパティ。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
maxEventsPerBatch バッチあたりのイベントの最大数。 INT
preferredBatchSizeInKilobytes 推奨されるバッチ サイズ (キロバイト単位)。 INT
resourceId イベント サブスクリプションの Azure 関数の宛先のエンドポイントを表す Azure リソース ID。 string

DeliveryAttributeMapping

名前 説明 値
name 配信属性またはヘッダーの名前。 string
type オブジェクトの種類を設定する 動的
静的 (必須)

DynamicDeliveryAttributeMapping

名前 説明 値
type 配信属性またはヘッダー名の種類。 "動的" (必須)
properties 動的配信属性マッピングのプロパティ。 DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

名前 説明 値
sourceField 属性値を含むイベント内の JSON パス。 string

StaticDeliveryAttributeMapping

名前 説明 値
type 配信属性またはヘッダー名の種類。 "Static" (必須)
properties 静的配信属性マッピングのプロパティ。 StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

名前 説明 値
isSecret 属性に機密情報が含まれているかどうかを示すブール型 (Boolean) フラグ。 [bool]
value 配信属性の値。 string

EventHubEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの宛先のエンドポイントの種類。 "EventHub" (必須)
properties イベント サブスクリプションの送信先の Event Hub プロパティ。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
resourceId イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。 string

HybridConnectionEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの宛先のエンドポイントの種類。 "HybridConnection" (必須)
properties ハイブリッド接続 イベント サブスクリプションの送信先のプロパティ。 HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
resourceId イベント サブスクリプションの宛先であるハイブリッド接続の Azure リソース ID。 string

ServiceBusQueueEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの宛先のエンドポイントの種類。 "ServiceBusQueue" (必須)
properties イベント サブスクリプションの送信先の Service Bus プロパティ。 ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
resourceId イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。 string

ServiceBusTopicEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの宛先のエンドポイントの種類。 "ServiceBusTopic" (必須)
properties イベント サブスクリプションの宛先の Service Bus トピックのプロパティ。 ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

名前 説明 値
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
resourceId イベント サブスクリプションの Service Bus トピックの宛先のエンドポイントを表す Azure リソース ID。 string

StorageQueueEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの宛先のエンドポイントの種類。 "StorageQueue" (必須)
properties イベント サブスクリプションの宛先のストレージ キューのプロパティ。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

名前 説明 値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類。 "WebHook" (必須)
properties イベント サブスクリプションの宛先の WebHook プロパティ。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名前 説明 値
azureActiveDirectoryApplicationIdOrUri 配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory アプリケーション ID または URI。 string
azureActiveDirectoryTenantId 配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory テナント ID。 string
deliveryAttributeMappings 配信属性の詳細。 DeliveryAttributeMapping[]
endpointUrl イベント サブスクリプションの送信先のエンドポイントを表す URL。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
maxEventsPerBatch バッチあたりのイベントの最大数。 INT
preferredBatchSizeInKilobytes 推奨されるバッチ サイズ (キロバイト単位)。 INT

EventSubscriptionFilter

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

AdvancedFilter

名前 説明 値
キー フィルター処理するイベントのフィールド/プロパティ。 string
operatorType オブジェクトの種類を設定する BoolEquals です。
IsNotNull
IsNullOrUndefined
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberInRange
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
NumberNotInRange
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (必須)

BoolEqualsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "BoolEquals" (必須)
value ブール値フィルター値。 [bool]

IsNotNullAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "IsNotNull" (必須)

IsNullOrUndefinedAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "IsNullOrUndefined" (必須)

NumberGreaterThanAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "NumberGreaterThan" (必須)
value フィルター値。 INT

NumberGreaterThanOrEqualsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "NumberGreaterThanOrEquals" (必須)
value フィルター値。 INT

NumberInAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "NumberIn" (必須)
値 フィルター値のセット。 int[]

NumberInRangeAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "NumberInRange" (必須)
値 フィルター値のセット。 int[][]

NumberLessThanAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "NumberLessThan" (必須)
value フィルター値。 INT

NumberLessThanOrEqualsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "NumberLessThanOrEquals" (必須)
value フィルター値。 INT

NumberNotInAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "NumberNotIn" (必須)
値 フィルター値のセット。 int[]

NumberNotInRangeAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "NumberNotInRange" (必須)
値 フィルター値のセット。 int[][]

StringBeginsWithAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "StringBeginsWith" (必須)
値 フィルター値のセット。 string[]

StringContainsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "StringContains" (必須)
値 フィルター値のセット。 string[]

StringEndsWithAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "StringEndsWith" (必須)
値 フィルター値のセット。 string[]

StringInAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "StringIn" (必須)
値 フィルター値のセット。 string[]

StringNotBeginsWithAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "StringNotBeginsWith" (必須)
値 フィルター値のセット。 string[]

StringNotContainsAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "StringNotContains" (必須)
値 フィルター値のセット。 string[]

StringNotEndsWithAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "StringNotEndsWith" (必須)
値 フィルター値のセット。 string[]

StringNotInAdvancedFilter

名前 説明 値
operatorType フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 "StringNotIn" (必須)
値 フィルター値のセット。 string[]

RetryPolicy

名前 説明 値
eventTimeToLiveInMinutes イベントの Time To Live (分単位)。 INT
maxDeliveryAttempts イベントの配信再試行の最大数。 int