次の方法で共有


Microsoft.EventGrid eventSubscriptions 2018-05-01-preview

Bicep リソース定義

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

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

リソースの形式

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2018-05-01-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    eventDeliverySchema: 'string'
    filter: {
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
    retryPolicy: {
      eventTimeToLiveInMinutes: int
      maxDeliveryAttempts: int
    }
  }
}

EventSubscriptionDestination オブジェクト

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

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

{
  endpointType: 'EventHub'
  properties: {
    resourceId: 'string'
  }
}

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

{
  endpointType: 'HybridConnection'
  properties: {
    resourceId: 'string'
  }
}

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

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

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

{
  endpointType: 'WebHook'
  properties: {
    endpointUrl: 'string'
  }
}

DeadLetterDestination オブジェクト

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

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

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

プロパティ値

DeadLetterDestination

名前 形容 価値
endpointType StorageBlobDeadLetterDestinationの種類 'StorageBlob' に設定します。 'StorageBlob' (必須)

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

名前 形容 価値
resourceId イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。

EventSubscriptionDestination

名前 形容 価値
endpointType EventHubEventSubscriptionDestination型として 'EventHub' に設定します。 HybridConnectionEventSubscriptionDestinationの種類 'HybridConnection' に設定します。 StorageQueueEventSubscriptionDestination種類として 'StorageQueue' に設定します。 WebHookEventSubscriptionDestination型として 'WebHook' に設定します。 'EventHub'
'HybridConnection'
'StorageQueue'
'WebHook' (必須)

EventSubscriptionFilter

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

EventSubscriptionProperties

名前 形容 価値
deadLetterDestination イベント サブスクリプションの DeadLetter 変換先。 DeadLetterDestination
行き先 イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 EventSubscriptionDestination
eventDeliverySchema イベント サブスクリプションのイベント配信スキーマ。 'CloudEventV01Schema'
'EventGridSchema'
'InputEventSchema'
フィルター イベント サブスクリプションのフィルターに関する情報。 EventSubscriptionFilter
ラベル ユーザー定義ラベルの一覧。 string[]
retryPolicy イベントの再試行ポリシー。 これを使用して、イベントの配信試行の最大数と有効期間を構成できます。 RetryPolicy

HybridConnectionEventSubscriptionDestination

名前 形容 価値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類 'HybridConnection' (必須)
プロパティ イベント サブスクリプションの送信先のハイブリッド接続プロパティ HybridConnectionEventSubscriptionDestinationProperties の

HybridConnectionEventSubscriptionDestinationProperties

名前 形容 価値
resourceId イベント サブスクリプションの宛先であるハイブリッド接続の Azure リソース ID。

Microsoft.EventGrid/eventSubscriptions

名前 形容 価値
名前 リソース名 string (必須)
プロパティ イベント サブスクリプションのプロパティ EventSubscriptionProperties
スコープ デプロイ スコープとは異なるスコープでリソースを作成するときに使用します。 このプロパティをリソースのシンボリック名に設定して、拡張リソースを適用します。

RetryPolicy

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

名前 形容 価値
queueName イベント サブスクリプションの宛先であるストレージ アカウントのストレージ キューの名前。
resourceId イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名前 形容 価値
endpointUrl イベント サブスクリプションの送信先のエンドポイントを表す URL。

クイック スタートのサンプル

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

Bicep ファイル 形容
Azure Event Grid カスタム トピックとキュー サブスクリプション を作成する Azure Event Grid カスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。
Azure Event Grid カスタム トピックとサブスクリプション を作成する Azure Event Grid カスタム トピックと Webhook サブスクリプションを作成します。 元は John Downs によって作成されたテンプレートです。

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

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

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

リソースの形式

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2018-05-01-preview",
  "name": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "eventDeliverySchema": "string",
    "filter": {
      "includedEventTypes": [ "string" ],
      "isSubjectCaseSensitive": "bool",
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string"
    },
    "labels": [ "string" ],
    "retryPolicy": {
      "eventTimeToLiveInMinutes": "int",
      "maxDeliveryAttempts": "int"
    }
  }
}

EventSubscriptionDestination オブジェクト

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

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

{
  "endpointType": "EventHub",
  "properties": {
    "resourceId": "string"
  }
}

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

{
  "endpointType": "HybridConnection",
  "properties": {
    "resourceId": "string"
  }
}

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

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

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

{
  "endpointType": "WebHook",
  "properties": {
    "endpointUrl": "string"
  }
}

DeadLetterDestination オブジェクト

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

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

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

プロパティ値

DeadLetterDestination

名前 形容 価値
endpointType StorageBlobDeadLetterDestinationの種類 'StorageBlob' に設定します。 'StorageBlob' (必須)

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

名前 形容 価値
resourceId イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。

EventSubscriptionDestination

名前 形容 価値
endpointType EventHubEventSubscriptionDestination型として 'EventHub' に設定します。 HybridConnectionEventSubscriptionDestinationの種類 'HybridConnection' に設定します。 StorageQueueEventSubscriptionDestination種類として 'StorageQueue' に設定します。 WebHookEventSubscriptionDestination型として 'WebHook' に設定します。 'EventHub'
'HybridConnection'
'StorageQueue'
'WebHook' (必須)

EventSubscriptionFilter

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

EventSubscriptionProperties

名前 形容 価値
deadLetterDestination イベント サブスクリプションの DeadLetter 変換先。 DeadLetterDestination
行き先 イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 EventSubscriptionDestination
eventDeliverySchema イベント サブスクリプションのイベント配信スキーマ。 'CloudEventV01Schema'
'EventGridSchema'
'InputEventSchema'
フィルター イベント サブスクリプションのフィルターに関する情報。 EventSubscriptionFilter
ラベル ユーザー定義ラベルの一覧。 string[]
retryPolicy イベントの再試行ポリシー。 これを使用して、イベントの配信試行の最大数と有効期間を構成できます。 RetryPolicy

HybridConnectionEventSubscriptionDestination

名前 形容 価値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類 'HybridConnection' (必須)
プロパティ イベント サブスクリプションの送信先のハイブリッド接続プロパティ HybridConnectionEventSubscriptionDestinationProperties の

HybridConnectionEventSubscriptionDestinationProperties

名前 形容 価値
resourceId イベント サブスクリプションの宛先であるハイブリッド接続の Azure リソース ID。

Microsoft.EventGrid/eventSubscriptions

名前 形容 価値
apiVersion API のバージョン '2018-05-01-preview'
名前 リソース名 string (必須)
プロパティ イベント サブスクリプションのプロパティ EventSubscriptionProperties
種類 リソースの種類 'Microsoft.EventGrid/eventSubscriptions'

RetryPolicy

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

名前 形容 価値
queueName イベント サブスクリプションの宛先であるストレージ アカウントのストレージ キューの名前。
resourceId イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名前 形容 価値
endpointUrl イベント サブスクリプションの送信先のエンドポイントを表す URL。

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

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

テンプレート 形容
Azure Event Grid カスタム トピックとキュー サブスクリプション を作成する

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

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

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

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

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

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

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

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

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2018-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      destination = {
        endpointType = "string"
        // For remaining properties, see EventSubscriptionDestination objects
      }
      eventDeliverySchema = "string"
      filter = {
        includedEventTypes = [
          "string"
        ]
        isSubjectCaseSensitive = bool
        subjectBeginsWith = "string"
        subjectEndsWith = "string"
      }
      labels = [
        "string"
      ]
      retryPolicy = {
        eventTimeToLiveInMinutes = int
        maxDeliveryAttempts = int
      }
    }
  })
}

EventSubscriptionDestination オブジェクト

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

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

{
  endpointType = "EventHub"
  properties = {
    resourceId = "string"
  }
}

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

{
  endpointType = "HybridConnection"
  properties = {
    resourceId = "string"
  }
}

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

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

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

{
  endpointType = "WebHook"
  properties = {
    endpointUrl = "string"
  }
}

DeadLetterDestination オブジェクト

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

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

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

プロパティ値

DeadLetterDestination

名前 形容 価値
endpointType StorageBlobDeadLetterDestinationの種類 'StorageBlob' に設定します。 'StorageBlob' (必須)

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

名前 形容 価値
resourceId イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。

EventSubscriptionDestination

名前 形容 価値
endpointType EventHubEventSubscriptionDestination型として 'EventHub' に設定します。 HybridConnectionEventSubscriptionDestinationの種類 'HybridConnection' に設定します。 StorageQueueEventSubscriptionDestination種類として 'StorageQueue' に設定します。 WebHookEventSubscriptionDestination型として 'WebHook' に設定します。 'EventHub'
'HybridConnection'
'StorageQueue'
'WebHook' (必須)

EventSubscriptionFilter

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

EventSubscriptionProperties

名前 形容 価値
deadLetterDestination イベント サブスクリプションの DeadLetter 変換先。 DeadLetterDestination
行き先 イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 EventSubscriptionDestination
eventDeliverySchema イベント サブスクリプションのイベント配信スキーマ。 'CloudEventV01Schema'
'EventGridSchema'
'InputEventSchema'
フィルター イベント サブスクリプションのフィルターに関する情報。 EventSubscriptionFilter
ラベル ユーザー定義ラベルの一覧。 string[]
retryPolicy イベントの再試行ポリシー。 これを使用して、イベントの配信試行の最大数と有効期間を構成できます。 RetryPolicy

HybridConnectionEventSubscriptionDestination

名前 形容 価値
endpointType イベント サブスクリプションの送信先のエンドポイントの種類 'HybridConnection' (必須)
プロパティ イベント サブスクリプションの送信先のハイブリッド接続プロパティ HybridConnectionEventSubscriptionDestinationProperties の

HybridConnectionEventSubscriptionDestinationProperties

名前 形容 価値
resourceId イベント サブスクリプションの宛先であるハイブリッド接続の Azure リソース ID。

Microsoft.EventGrid/eventSubscriptions

名前 形容 価値
名前 リソース名 string (必須)
parent_id この拡張リソースを適用するリソースの ID。 string (必須)
プロパティ イベント サブスクリプションのプロパティ EventSubscriptionProperties
種類 リソースの種類 "Microsoft.EventGrid/eventSubscriptions@2018-05-01-preview"

RetryPolicy

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

名前 形容 価値
queueName イベント サブスクリプションの宛先であるストレージ アカウントのストレージ キューの名前。
resourceId イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名前 形容 価値
endpointUrl イベント サブスクリプションの送信先のエンドポイントを表す URL。