Microsoft.EventGrid eventSubscriptions

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

Bicep リソース定義

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

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

リソースの形式

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2024-12-15-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        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'
  }
}

DeliveryAttributeMapping オブジェクト

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

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

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

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

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

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'
  ]
}

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'
  }
}

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

{
  endpointType: 'MonitorAlert'
  properties: {
    actionGroups: [
      'string'
    ]
    description: 'string'
    severity: 'string'
  }
}

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

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

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

{
  endpointType: 'PartnerDestination'
  properties: {
    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
    minimumTlsVersionAllowed: 'string'
    preferredBatchSizeInKilobytes: int
  }
}

プロパティ値

AdvancedFilter

名前	形容	価値
鍵	フィルター処理するイベントのフィールド/プロパティ。	糸
operatorType	BoolEqualsAdvancedFilter型 'BoolEquals' に設定します。 IsNotNullAdvancedFilterの型 'IsNotNull' に設定します。 IsNullOrUndefinedAdvancedFilter型の場合は 'IsNullOrUndefined' に設定します。 NumberGreaterThanAdvancedFilter型の 'NumberGreaterThan' に設定します。 NumberGreaterThanOrEqualsAdvancedFilter型 'NumberGreaterThanOrEquals' に設定します。 NumberInAdvancedFilter型 'NumberIn' に設定します。 NumberInRangeAdvancedFilter型 'NumberInRange' に設定します。 NumberLessThanAdvancedFilter型 'NumberLessThan' に設定します。 NumberLessThanOrEqualsAdvancedFilter型 'NumberLessThanOrEquals' に設定します。 NumberNotInAdvancedFilter型 'NumberNotIn' に設定します。 NumberNotInRangeAdvancedFilter型 'NumberNotInRange' に設定します。 StringBeginsWithAdvancedFilterの型 'StringBeginsWith' に設定します。 StringContainsAdvancedFilter型 'StringContains' に設定します。 StringEndsWithAdvancedFilterの型 'StringEndsWith' に設定します。 StringInAdvancedFilter型 'StringIn' に設定します。 StringNotBeginsWithAdvancedFilterの型 'StringNotBeginsWith' に設定します。 StringNotContainsAdvancedFilterの型 'StringNotContains' に設定します。 StringNotEndsWithAdvancedFilterの型 'StringNotEndsWith' に設定します。 StringNotInAdvancedFilter型 'StringNotIn' に設定します。	'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (必須)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

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

DeadLetterDestination

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

DeadLetterWithResourceIdentity

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

DeliveryAttributeMapping

名前	形容	価値
名前	配信属性またはヘッダーの名前。	糸
種類	DynamicDeliveryAttributeMapping型 'Dynamic' に設定します。 StaticDeliveryAttributeMapping型の場合は 'Static' に設定します。	'Dynamic' 'Static' (必須)

DeliveryWithResourceIdentity

名前	形容	価値
行き先	イベントサブスクリプションに対してイベントを配信する必要がある送信先に関する情報。親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信中に使用される認証トークンを取得します。	EventSubscriptionDestination
同一性	イベントを配信するときに使用する ID。	EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

名前	形容	価値
sourceField	属性値を含むイベントの JSON パス。	糸

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

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

EventSubscriptionFilter

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

EventSubscriptionIdentity

名前	形容	価値
federatedIdentityCredentialInfo	リソース配信で使用されるフェデレーション ID 資格情報 (FIC) の詳細。	FederatedIdentityCredentialInfo
種類	使用されるマネージド ID の種類。 'SystemAssigned' または 'UserAssigned' のいずれかを指定できます。	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	リソースに関連付けられているユーザー ID。	糸

EventSubscriptionProperties

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

FederatedIdentityCredentialInfo

名前	形容	価値
federatedClientId	フェデレーション ID 資格情報 (FIC) が関連付けられているマルチテナント AAD アプリケーション。	糸制約：最小長 = 36 最大長 = 36 パターン = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (必須)

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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