Microsoft.EventGrid namespaces/topics/eventSubscriptions 2024-06-01-preview

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

Bicep リソース定義

namespaces/topics/eventSubscriptions リソースの種類は、次を対象とする操作と共にデプロイできます。

リソースグループの - リソースグループのデプロイコマンド参照

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

リソースの形式

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

resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    deliveryConfiguration: {
      deliveryMode: 'string'
      push: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        deliveryWithResourceIdentity: {
          destination: {
            endpointType: 'string'
            // For remaining properties, see EventSubscriptionDestination objects
          }
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        destination: {
          endpointType: 'string'
          // For remaining properties, see EventSubscriptionDestination objects
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
      }
      queue: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
        receiveLockDurationInSeconds: int
      }
    }
    eventDeliverySchema: 'string'
    expirationTimeUtc: 'string'
    filtersConfiguration: {
      filters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see Filter objects
        }
      ]
      includedEventTypes: [
        'string'
      ]
    }
  }
}

オブジェクトのフィルター処理

オブジェクトの型を指定するには、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'
  ]
}

DeliveryAttributeMapping オブジェクト

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

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

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

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

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

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

DeadLetterDestination オブジェクト

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

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

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

プロパティ値

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsFilter

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

DeadLetterDestination

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

DeadLetterWithResourceIdentity

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

DeliveryAttributeMapping

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

DeliveryConfiguration

名前	形容	価値
deliveryMode	イベントサブスクリプションの配信モード。	'Push' 'Queue'
押す	このプロパティは、deliveryMode がプッシュ時に設定され、プッシュサブスクリプションに関する情報を表します。	PushInfo の
列	このプロパティは、deliveryMode がキューであり、キューサブスクリプションに関する情報を表す場合に設定する必要があります。	QueueInfo の

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' (必須)

EventSubscriptionIdentity

名前	形容	価値
種類	使用されるマネージド ID の種類。 'SystemAssigned' または 'UserAssigned' のいずれかを指定できます。	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	リソースに関連付けられているユーザー ID。	糸

フィルター

名前	形容	価値
鍵	フィルター処理するイベントのフィールド/プロパティ。	糸
operatorType	BoolEqualsFilter型 'BoolEquals' に設定します。 IsNotNullFilterの型 'IsNotNull' に設定します。 IsNullOrUndefinedFilter型 'IsNullOrUndefined' に設定します。 NumberGreaterThanFilter型 'NumberGreaterThan' に設定します。 NumberGreaterThanOrEqualsFilter型 'NumberGreaterThanOrEquals' に設定します。 NumberInFilter型 'NumberIn' に設定します。 NumberInRangeFilter型 'NumberInRange' に設定します。 NumberLessThanFilter型 'NumberLessThan' に設定します。 NumberLessThanOrEqualsFilterの型 'NumberLessThanOrEquals' に設定します。 NumberNotInFilter型 'NumberNotIn' に設定します。 NumberNotInRangeFilter型 'NumberNotInRange' に設定します。 StringBeginsWithFilterの型 'StringBeginsWith' に設定します。 StringContainsFilter型 'StringContains' に設定します。 StringEndsWithFilter型 'StringEndsWith' に設定します。 StringInFilterの型 'StringIn' に設定します。 StringNotBeginsWithFilterの型 'StringNotBeginsWith' に設定します。 StringNotContainsFilterの型 'StringNotContains' に設定します。 StringNotEndsWithFilter型 'StringNotEndsWith' に設定します。 StringNotInFilterの型 'StringNotIn' に設定します。	'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (必須)

FiltersConfiguration

名前	形容	価値
フィルター	イベントサブスクリプションのフィルター処理に使用されるフィルターの配列。	フィルター[]
includedEventTypes	イベントサブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。すべての既定のイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。	string[]

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullFilter

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

IsNullOrUndefinedFilter

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