Microsoft.EventGrid eventSubscriptions 2020-01-01-preview

Bicep リソース定義

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

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

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

• リソース グループ - リソース グループのデプロイ コマンドを参照してください
• サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください

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

リソース形式

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2020-01-01-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    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
        }
      ]
      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: {
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
    resourceId: 'string'
  }

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

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

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

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

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

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

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

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

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

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

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

  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    endpointUrl: 'string'
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
  }

AdvancedFilter オブジェクト

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

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

  operatorType: 'BoolEquals'
  value: bool

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

  operatorType: 'NumberGreaterThan'
  value: int

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

  operatorType: 'NumberGreaterThanOrEquals'
  value: int

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

  operatorType: 'NumberIn'
  values: [
    int
  ]

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

  operatorType: 'NumberLessThan'
  value: int

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

  operatorType: 'NumberLessThanOrEquals'
  value: int

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

  operatorType: 'NumberNotIn'
  values: [
    int
  ]

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

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

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

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

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

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

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

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

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

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

プロパティ値

eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

EventSubscriptionDestination

AzureFunctionEventSubscriptionDestination

AzureFunctionEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

ServiceBusQueueEventSubscriptionDestination

ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestination

ServiceBusTopicEventSubscriptionDestinationPropertie...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

AdvancedFilter

BoolEqualsAdvancedFilter

NumberGreaterThanAdvancedFilter

NumberGreaterThanOrEqualsAdvancedFilter

NumberInAdvancedFilter

NumberLessThanAdvancedFilter

NumberLessThanOrEqualsAdvancedFilter

NumberNotInAdvancedFilter

StringBeginsWithAdvancedFilter

StringContainsAdvancedFilter

StringEndsWithAdvancedFilter

StringInAdvancedFilter

StringNotInAdvancedFilter

RetryPolicy

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

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

Template	説明
カスタム トピックとサブスクリプションAzure Event Grid作成する	Azure Event Gridカスタム トピックと Webhook サブスクリプションを作成します。 最初に John Downs によって作成されたテンプレート。
CloudEvents を使用したカスタム Azure Event Grid トピック/サブスクリプション	カスタム Azure Event Grid トピック、CloudEvents スキーマを持つ Webhook サブスクリプション、およびイベント ハンドラーとしてのロジック アプリを作成します。 テンプレートは、もともと Justin Yoo によって作成されました。
Event Grid カスタム トピックとイベント ハブ ハンドラーを作成する	イベントを処理Azure Event Gridカスタム トピックとイベント ハブを作成します。
リソース イベントの Event Grid サブスクリプションを作成する	リソース グループまたは Azure サブスクリプションのいずれかに Event Grid サブスクリプションを作成します。
カスタム トピックとキュー サブスクリプションAzure Event Grid作成する	Azure Event Gridカスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートは、もともと Markus Meyer によって作成されました。
カスタム トピック サブスクリプションAzure Event Grid作成する	Azure Event Gridカスタム トピックと Service Bus トピック サブスクリプションを作成します。 テンプレートは、もともと Markus Meyer によって作成されました。

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

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

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

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

• リソース グループ - リソース グループのデプロイ コマンドを参照してください
• サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください

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

リソース形式

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2020-01-01-preview",
  "name": "string",
  "scope": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "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
        }
      ],
      "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": {
    "maxEventsPerBatch": "int",
    "preferredBatchSizeInKilobytes": "int",
    "resourceId": "string"
  }

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

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

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

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

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

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

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

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

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

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

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

  "endpointType": "WebHook",
  "properties": {
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string",
    "endpointUrl": "string",
    "maxEventsPerBatch": "int",
    "preferredBatchSizeInKilobytes": "int"
  }

AdvancedFilter オブジェクト

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

プロパティ値

eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

EventSubscriptionDestination

AzureFunctionEventSubscriptionDestination

AzureFunctionEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

ServiceBusQueueEventSubscriptionDestination

ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestination

ServiceBusTopicEventSubscriptionDestinationPropertie...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

AdvancedFilter

BoolEqualsAdvancedFilter

NumberGreaterThanAdvancedFilter

NumberGreaterThanOrEqualsAdvancedFilter

NumberInAdvancedFilter

NumberLessThanAdvancedFilter

NumberLessThanOrEqualsAdvancedFilter

NumberNotInAdvancedFilter

StringBeginsWithAdvancedFilter

StringContainsAdvancedFilter

StringEndsWithAdvancedFilter

StringInAdvancedFilter

StringNotInAdvancedFilter

RetryPolicy

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

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

Template	説明
カスタム トピックとサブスクリプションAzure Event Grid作成する	Azure Event Gridカスタム トピックと Webhook サブスクリプションを作成します。 最初に John Downs によって作成されたテンプレート。
CloudEvents を使用したカスタム Azure Event Grid トピック/サブスクリプション	カスタム Azure Event Grid トピック、CloudEvents スキーマを持つ Webhook サブスクリプション、およびイベント ハンドラーとしてのロジック アプリを作成します。 テンプレートは、もともと Justin Yoo によって作成されました。
Event Grid カスタム トピックとイベント ハブ ハンドラーを作成する	イベントを処理Azure Event Gridカスタム トピックとイベント ハブを作成します。
リソース イベントの Event Grid サブスクリプションを作成する	リソース グループまたは Azure サブスクリプションのいずれかに Event Grid サブスクリプションを作成します。
カスタム トピックとキュー サブスクリプションAzure Event Grid作成する	Azure Event Gridカスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートは、もともと Markus Meyer によって作成されました。
カスタム トピック サブスクリプションAzure Event Grid作成する	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@2020-01-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"
      expirationTimeUtc = "string"
      filter = {
        advancedFilters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see AdvancedFilter objects
          }
        ]
        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 = {
    maxEventsPerBatch = int
    preferredBatchSizeInKilobytes = int
    resourceId = "string"
  }

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

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

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

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

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

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

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

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

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

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

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

  endpointType = "WebHook"
  properties = {
    azureActiveDirectoryApplicationIdOrUri = "string"
    azureActiveDirectoryTenantId = "string"
    endpointUrl = "string"
    maxEventsPerBatch = int
    preferredBatchSizeInKilobytes = int
  }

AdvancedFilter オブジェクト

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

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

  operatorType = "BoolEquals"
  value = bool

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

  operatorType = "NumberGreaterThan"
  value = int

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

  operatorType = "NumberGreaterThanOrEquals"
  value = int

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

  operatorType = "NumberIn"
  values = [
    int
  ]

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

  operatorType = "NumberLessThan"
  value = int

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

  operatorType = "NumberLessThanOrEquals"
  value = int

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

  operatorType = "NumberNotIn"
  values = [
    int
  ]

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

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

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

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

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

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

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

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

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

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

プロパティ値

eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

EventSubscriptionDestination

AzureFunctionEventSubscriptionDestination

AzureFunctionEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

ServiceBusQueueEventSubscriptionDestination

ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestination

ServiceBusTopicEventSubscriptionDestinationPropertie...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

AdvancedFilter

BoolEqualsAdvancedFilter

NumberGreaterThanAdvancedFilter

NumberGreaterThanOrEqualsAdvancedFilter

NumberInAdvancedFilter

NumberLessThanAdvancedFilter

NumberLessThanOrEqualsAdvancedFilter

NumberNotInAdvancedFilter

StringBeginsWithAdvancedFilter

StringContainsAdvancedFilter

StringEndsWithAdvancedFilter

StringInAdvancedFilter

StringNotInAdvancedFilter

RetryPolicy