Microsoft.EventGrid eventSubscriptions 2020-06-01

[アーティクル]
12/20/2024

Bicep リソース定義

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

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

リソースの形式

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2020-06-01' = {
  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'
    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'
  ]
}

プロパティ値

AdvancedFilter

名前	形容	価値
鍵	フィルター処理するイベントのフィールド/プロパティ。	糸
operatorType	BoolEqualsAdvancedFilter型 'BoolEquals' に設定します。 NumberGreaterThanAdvancedFilter型の 'NumberGreaterThan' に設定します。 NumberGreaterThanOrEqualsAdvancedFilter型 'NumberGreaterThanOrEquals' に設定します。 NumberInAdvancedFilter型 'NumberIn' に設定します。 NumberLessThanAdvancedFilter型 'NumberLessThan' に設定します。 NumberLessThanOrEqualsAdvancedFilter型 'NumberLessThanOrEquals' に設定します。 NumberNotInAdvancedFilter型 'NumberNotIn' に設定します。 StringBeginsWithAdvancedFilterの型 'StringBeginsWith' に設定します。 StringContainsAdvancedFilter型 'StringContains' に設定します。 StringEndsWithAdvancedFilterの型 'StringEndsWith' に設定します。 StringInAdvancedFilter型 'StringIn' に設定します。 StringNotInAdvancedFilter型 'StringNotIn' に設定します。	'BoolEquals' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotIn' (必須)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

名前	形容	価値
maxEventsPerBatch	バッチあたりのイベントの最大数。	int
preferredBatchSizeInKilobytes	推奨されるバッチサイズ (KB 単位)。	int
resourceId	イベントサブスクリプションの Azure 関数の送信先のエンドポイントを表す Azure リソース ID。	糸

BoolEqualsAdvancedFilter

名前	形容	価値
operatorType	フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。	'BoolEquals' (必須)
価値	ブール値のフィルター値。	bool

DeadLetterDestination

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

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

EventSubscriptionFilter

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

EventSubscriptionProperties

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

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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