Microsoft.EventGrid eventSubscriptions 2017-09-15-preview

• 最新の を する
• 2024-12-15-preview
• 2024-06-01-preview
• 2023-12-15-preview
• 2023-06-01-preview
• 2022-06-15
• 2021-12-01
• 2021-10-15-preview
• 2021-06-01-preview
• 2020-10-15-preview
• 2020-06-01
• 2020-04-01-preview
• 2020-01-01-preview
• 2019-06-01
• 2019-02-01-preview
• 2019-01-01
• 2018-09-15-preview
• 2018-05-01-preview
• 2018-01-01
• 2017-09-15-preview
• 2017-06-15-preview

Bicep リソース定義

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

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

リソースの形式

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2017-09-15-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    filter: {
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
  }
}

EventSubscriptionDestination オブジェクト

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

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

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

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

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

プロパティ値

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

名前	形容	価値
endpointType	EventHubEventSubscriptionDestination型として 'EventHub' に設定します。 WebHookEventSubscriptionDestination型として 'WebHook' に設定します。	'EventHub' 'WebHook' (必須)

EventSubscriptionFilter

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

EventSubscriptionProperties

名前	形容	価値
行き先	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。	EventSubscriptionDestination
フィルター	イベント サブスクリプションのフィルターに関する情報。	EventSubscriptionFilter
ラベル	ユーザー定義ラベルの一覧。	string[]

Microsoft.EventGrid/eventSubscriptions

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

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": "2017-09-15-preview",
  "name": "string",
  "properties": {
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "filter": {
      "includedEventTypes": [ "string" ],
      "isSubjectCaseSensitive": "bool",
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string"
    },
    "labels": [ "string" ]
  }
}

EventSubscriptionDestination オブジェクト

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

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

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

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

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

プロパティ値

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

名前	形容	価値
endpointType	EventHubEventSubscriptionDestination型として 'EventHub' に設定します。 WebHookEventSubscriptionDestination型として 'WebHook' に設定します。	'EventHub' 'WebHook' (必須)

EventSubscriptionFilter

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

EventSubscriptionProperties

名前	形容	価値
行き先	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。	EventSubscriptionDestination
フィルター	イベント サブスクリプションのフィルターに関する情報。	EventSubscriptionFilter
ラベル	ユーザー定義ラベルの一覧。	string[]

Microsoft.EventGrid/eventSubscriptions

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

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@2017-09-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      destination = {
        endpointType = "string"
        // For remaining properties, see EventSubscriptionDestination objects
      }
      filter = {
        includedEventTypes = [
          "string"
        ]
        isSubjectCaseSensitive = bool
        subjectBeginsWith = "string"
        subjectEndsWith = "string"
      }
      labels = [
        "string"
      ]
    }
  })
}

EventSubscriptionDestination オブジェクト

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

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

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

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

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

プロパティ値

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

名前	形容	価値
endpointType	EventHubEventSubscriptionDestination型として 'EventHub' に設定します。 WebHookEventSubscriptionDestination型として 'WebHook' に設定します。	'EventHub' 'WebHook' (必須)

EventSubscriptionFilter

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

EventSubscriptionProperties

名前	形容	価値
行き先	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。	EventSubscriptionDestination
フィルター	イベント サブスクリプションのフィルターに関する情報。	EventSubscriptionFilter
ラベル	ユーザー定義ラベルの一覧。	string[]

Microsoft.EventGrid/eventSubscriptions

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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