Microsoft.EventGrid 名前空間/topics/eventSubscriptions

• 最新
• 2023-12-15-preview
• 2023-06-01-preview

Bicep リソース定義

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

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

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

リソース形式

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

resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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'
          }
        }
        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: 'CloudEventSchemaV1_0'
    filtersConfiguration: {
      filters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see Filter objects
        }
      ]
      includedEventTypes: [
        'string'
      ]
    }
  }
}

DeadLetterDestination オブジェクト

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

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

  endpointType: 'StorageBlob'
  properties: {
    blobContainerName: 'string'
    resourceId: '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
  }

DeliveryAttributeMapping オブジェクト

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

[動的] には、次の値を使用します。

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

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

  type: 'Static'
  properties: {
    isSecret: bool
    value: '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'
  ]

プロパティ値

namespaces/topics/eventSubscriptions

名前	説明	値
name	リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。	string (必須)
parent	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。	種類のリソースのシンボル名: トピック
properties	イベント サブスクリプションのプロパティ。	SubscriptionProperties

SubscriptionProperties

名前	説明	値
deliveryConfiguration	イベント サブスクリプションの配信構成に関する情報。	DeliveryConfiguration
eventDeliverySchema	イベント サブスクリプションのイベント配信スキーマ。	'CloudEventSchemaV1_0'
filtersConfiguration	イベント サブスクリプションのフィルターに関する情報。	FiltersConfiguration

DeliveryConfiguration

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

PushInfo

名前	説明	値
deadLetterDestinationWithResourceIdentity	イベント サブスクリプションの配信不能の宛先。 送信先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (つまり名前空間) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。	DeliveryWithResourceIdentity
eventTimeToLive	メッセージが発行された時点からサブスクリプションで使用できるメッセージの長さを決定する ISO 8601 形式の期間。 この期間の値は、'P(n)Y(n)M(n)DT(n)H(n)M(n)S' の形式で表されます。ここで、 - (n) は、 (n) に続く各 time 要素の値に置き換えられます。 - P は期間 (または期間) 指定子であり、常に期間の先頭に配置されます。 - Y は年の指定子であり、年数の値に従います。 - M は月の指定子であり、月数の値に従います。 - W は週指定子であり、週数の値に従います。 - D は日指定子であり、日数の値に従います。 - T は時間指定子であり、時間コンポーネントの前に置きます。 - H は時間指定子であり、時間数の値に従います。 - M は分指定子であり、分数の値に従います。 - S は 2 番目の指定子であり、秒数の値に従います。 この期間の値は、トピックの EventRetentionInDays より大きく設定することはできません。 これは、最小値が 1 分で、最大値が決定される省略可能なフィールドです トピックの EventRetentionInDays 値によって。 有効な値の例を次に示します。 - 'P0DT23H12M' または 'PT23H12M': 23 時間 12 分の期間。 - 'P1D' または 'P1DT0H0M0S': 1 日の期間。	string
maxDeliveryCount	イベントの最大配信数。	INT

DeadLetterWithResourceIdentity

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

DeadLetterDestination

名前	説明	値
endpointType	オブジェクトの種類を設定する	StorageBlob (必須)

StorageBlobDeadLetterDestination

名前	説明	値
endpointType	配信不能の宛先のエンドポイントの種類	'StorageBlob' (必須)
properties	ストレージ BLOB ベースの配信不能宛先のプロパティ	StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名前	説明	値
blobContainerName	配信不能イベントの送信先であるストレージ BLOB コンテナーの名前	string
resourceId	配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID	string

EventSubscriptionIdentity

名前	説明	値
type	使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	リソースに関連付けられているユーザー ID。	string

DeliveryWithResourceIdentity

名前	説明	値
destination	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 Azure Event Gridの ID を使用して、配信/配信不能時に使用される認証トークンを取得します。	EventSubscriptionDestination
identity	イベントを配信するときに使用する ID。	EventSubscriptionIdentity

EventSubscriptionDestination

名前	説明	値
endpointType	オブジェクトの種類を設定する	AzureFunction EventHub HybridConnection MonitorAlert NamespaceTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook (必須)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

DeliveryAttributeMapping

名前	説明	値
name	配信属性またはヘッダーの名前。	string
type	オブジェクトの種類を設定する	動的 静的 (必須)

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

名前	説明	値
sourceField	属性値を含むイベント内の JSON パス。	string

StaticDeliveryAttributeMapping

名前	説明	値
type	配信属性またはヘッダー名の種類。	'Static' (必須)
properties	静的配信属性マッピングのプロパティ。	StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

名前	説明	値
isSecret	属性に機密情報が含まれているかどうかを示すブール型フラグ。	[bool]
value	配信属性の値。	string

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

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

MonitorAlertEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの宛先のエンドポイントの種類。	'MonitorAlert' (必須)
properties	イベント サブスクリプションの送信先の Alert プロパティを監視します。	MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

名前	説明	値
actionGroups	このイベント サブスクリプションを通じて発生するすべてのアラートでトリガーされるアクション グループの ARM ID の一覧。 各リソース ARM ID は、/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName} というパターンに従う必要があります。	string[]
description	このイベント サブスクリプションを通じて発生したすべてのアラートにアタッチされる説明。	string
severity	このイベント サブスクリプションを通じて発生したすべてのアラートにアタッチされる重大度。 このフィールドは指定する必要があります。	'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4'

NamespaceTopicEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの宛先のエンドポイントの種類。	'NamespaceTopic' (必須)
properties	イベント サブスクリプションの宛先の名前空間トピック のプロパティ。	NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

名前	説明	値
resourceId	イベント サブスクリプションの Event Grid 名前空間トピックの宛先のエンドポイントを表す Azure リソース ID。 このフィールドは必須であり、一覧表示されている名前空間トピック リソースが既に存在している必要があります。 リソース ARM ID は、/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName} というパターンに従う必要があります。	string

PartnerEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの宛先のエンドポイントの種類。	'PartnerDestination' (必須)
properties	イベント サブスクリプションの送信先のパートナーの宛先のプロパティ。	PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

名前	説明	値
resourceId	イベント サブスクリプションのパートナーの宛先のエンドポイントを表す Azure リソース ID。	string

ServiceBusQueueEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの宛先のエンドポイントの種類。	'ServiceBusQueue' (必須)
properties	イベント サブスクリプションの送信先の Service Bus プロパティ。	ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名前	説明	値
deliveryAttributeMappings	配信属性の詳細。	DeliveryAttributeMapping[]
resourceId	イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。	string

ServiceBusTopicEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	'ServiceBusTopic' (必須)
properties	イベント サブスクリプションの送信先の Service Bus トピックのプロパティ。	ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

名前	説明	値
deliveryAttributeMappings	配信属性の詳細。	DeliveryAttributeMapping[]
resourceId	イベント サブスクリプションの Service Bus トピックの送信先のエンドポイントを表す Azure リソース ID。	string

StorageQueueEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	'StorageQueue' (必須)
properties	イベント サブスクリプションの送信先のストレージ キューのプロパティ。	StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名前	説明	値
queueMessageTimeToLiveInSeconds	ストレージ キュー メッセージの有効期間 (秒単位)。 メッセージの Time To Live が Infinite であることを示すために -1 を使用する場合を除き、この値を 0 または負の値にすることはできません。	INT
queueName	イベント サブスクリプションの送信先であるストレージ アカウントの下にあるストレージ キューの名前。	string
resourceId	イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。	string

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名前	説明	値
azureActiveDirectoryApplicationIdOrUri	配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory アプリケーション ID または URI。	string
azureActiveDirectoryTenantId	配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory テナント ID。	string
deliveryAttributeMappings	配信属性の詳細。	DeliveryAttributeMapping[]
endpointUrl	イベント サブスクリプションの送信先のエンドポイントを表す URL。	string 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
maxEventsPerBatch	バッチあたりのイベントの最大数。	INT
minimumTlsVersionAllowed	Webhook エンドポイントでサポートされる必要がある最小 TLS バージョン	'1.0' '1.1' '1.2'
preferredBatchSizeInKilobytes	推奨されるバッチ サイズ (キロバイト単位)。	INT

QueueInfo

名前	説明	値
deadLetterDestinationWithResourceIdentity	イベント サブスクリプションの配信不能の宛先。 送信先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (つまり、トピック) のマネージド ID セットアップを使用して、配信/配信不能の間に使用される認証トークンを取得します。	DeadLetterWithResourceIdentity
eventTimeToLive	メッセージが発行された時点からサブスクリプションで使用できるメッセージの長さを決定する ISO 8601 形式の期間。 この期間の値は、'P(n)Y(n)M(n)DT(n)H(n)M(n)S' の形式で表されます。ここで、 - (n) は、 (n) に続く各 time 要素の値に置き換えられます。 - P は期間 (または期間) 指定子であり、常に期間の先頭に配置されます。 - Y は年の指定子であり、年数の値に従います。 - M は月の指定子であり、月数の値に従います。 - W は週指定子であり、週数の値に従います。 - D は日指定子であり、日数の値に従います。 - T は時間指定子であり、時間コンポーネントの前に置きます。 - H は時間指定子であり、時間数の値に従います。 - M は分指定子であり、分数の値に従います。 - S は 2 番目の指定子であり、秒数の値に従います。 この期間の値は、トピックの EventRetentionInDays より大きく設定することはできません。 これは、最小値が 1 分で、最大値が決定される省略可能なフィールドです トピックの EventRetentionInDays 値によって。 有効な値の例を次に示します。 - 'P0DT23H12M' または 'PT23H12M': 23 時間 12 分の期間。 - 'P1D' または 'P1DT0H0M0S': 1 日の期間。	string
maxDeliveryCount	イベントの最大配信数。	INT
receiveLockDurationInSeconds	メッセージが (クライアントによって) 受信され、受け入れ、解放、または拒否されるのを待機している最大期間 (秒単位)。 クライアントがメッセージを受信した後にこの時間が経過し、受け入れ済み (処理されていない)、リリースまたは拒否に移行されなかった場合は、 メッセージは再配信に使用できます。 これは省略可能なフィールドです。既定値は 60 秒、最小値は 60 秒、最大値は 300 秒です。	INT

FiltersConfiguration

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

フィルター

名前	説明	値
キー	フィルター処理するイベントのフィールド/プロパティ。	string
operatorType	オブジェクトの種類を設定する	BoolEquals です。 IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (必須)

BoolEqualsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'BoolEquals' (必須)
value	ブール値フィルター値。	[bool]

IsNotNullFilter

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

IsNullOrUndefinedFilter

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

NumberGreaterThanFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberGreaterThan' (必須)
value	フィルター値。	INT

NumberGreaterThanOrEqualsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberGreaterThanOrEquals' (必須)
value	フィルター値。	INT

NumberInFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberIn' (必須)
値	フィルター値のセット。	int[]

NumberInRangeFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberInRange' (必須)
値	フィルター値のセット。	int[][]

NumberLessThanFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberLessThan' (必須)
value	フィルター値。	INT

NumberLessThanOrEqualsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberLessThanOrEquals' (必須)
value	フィルター値。	INT

NumberNotInFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberNotIn' (必須)
値	フィルター値のセット。	int[]

NumberNotInRangeFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberNotInRange' (必須)
値	フィルター値のセット。	int[][]

StringBeginsWithFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringBeginsWith' (必須)
値	フィルター値のセット。	string[]

StringContainsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringContains' (必須)
値	フィルター値のセット。	string[]

StringEndsWithFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringEndsWith' (必須)
値	フィルター値のセット。	string[]

StringInFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringIn' (必須)
値	フィルター値のセット。	string[]

StringNotBeginsWithFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringNotBeginsWith' (必須)
値	フィルター値のセット。	string[]

StringNotContainsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringNotContains' (必須)
値	フィルター値のセット。	string[]

StringNotEndsWithFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringNotEndsWith' (必須)
値	フィルター値のセット。	string[]

StringNotInFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringNotIn' (必須)
値	フィルター値のセット。	string[]

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

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

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

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

リソース形式

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

{
  "type": "Microsoft.EventGrid/namespaces/topics/eventSubscriptions",
  "apiVersion": "2023-12-15-preview",
  "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"
          }
        },
        "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": "CloudEventSchemaV1_0",
    "filtersConfiguration": {
      "filters": [
        {
          "key": "string",
          "operatorType": "string"
          // For remaining properties, see Filter objects
        }
      ],
      "includedEventTypes": [ "string" ]
    }
  }
}

DeadLetterDestination オブジェクト

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

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

  "endpointType": "StorageBlob",
  "properties": {
    "blobContainerName": "string",
    "resourceId": "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"
  }

DeliveryAttributeMapping オブジェクト

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

[動的] には、次の値を使用します。

  "type": "Dynamic",
  "properties": {
    "sourceField": "string"
  }

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

  "type": "Static",
  "properties": {
    "isSecret": "bool",
    "value": "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" ]

プロパティ値

namespaces/topics/eventSubscriptions

名前	説明	値
type	リソースの種類	'Microsoft.EventGrid/namespaces/topics/eventSubscriptions'
apiVersion	リソース API のバージョン	'2023-12-15-preview'
name	リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。	string (必須)
properties	イベント サブスクリプションのプロパティ。	SubscriptionProperties

SubscriptionProperties

名前	説明	値
deliveryConfiguration	イベント サブスクリプションの配信構成に関する情報。	DeliveryConfiguration
eventDeliverySchema	イベント サブスクリプションのイベント配信スキーマ。	'CloudEventSchemaV1_0'
filtersConfiguration	イベント サブスクリプションのフィルターに関する情報。	FiltersConfiguration

DeliveryConfiguration

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

PushInfo

名前	説明	値
deadLetterDestinationWithResourceIdentity	イベント サブスクリプションの配信不能の宛先。 送信先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (つまり名前空間) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。	DeliveryWithResourceIdentity
eventTimeToLive	メッセージが発行された時点からサブスクリプションで使用できるメッセージの長さを決定する ISO 8601 形式の期間。 この期間の値は、'P(n)Y(n)M(n)DT(n)H(n)M(n)S' の形式で表されます。ここで、 - (n) は、 (n) に続く各 time 要素の値に置き換えられます。 - P は期間 (または期間) 指定子であり、常に期間の先頭に配置されます。 - Y は年の指定子であり、年数の値に従います。 - M は月の指定子であり、月数の値に従います。 - W は週指定子であり、週数の値に従います。 - D は日指定子であり、日数の値に従います。 - T は時間指定子であり、時間コンポーネントの前に置きます。 - H は時間指定子であり、時間数の値に従います。 - M は分指定子であり、分数の値に従います。 - S は 2 番目の指定子であり、秒数の値に従います。 この期間の値は、トピックの EventRetentionInDays より大きく設定することはできません。 これは、最小値が 1 分で、最大値が決定される省略可能なフィールドです トピックの EventRetentionInDays 値によって。 有効な値の例を次に示します。 - 'P0DT23H12M' または 'PT23H12M': 23 時間 12 分の期間。 - 'P1D' または 'P1DT0H0M0S': 1 日の期間。	string
maxDeliveryCount	イベントの最大配信数。	INT

DeadLetterWithResourceIdentity

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

DeadLetterDestination

名前	説明	値
endpointType	オブジェクトの種類を設定する	StorageBlob (必須)

StorageBlobDeadLetterDestination

名前	説明	値
endpointType	配信不能の宛先のエンドポイントの種類	'StorageBlob' (必須)
properties	ストレージ BLOB ベースの配信不能宛先のプロパティ	StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名前	説明	値
blobContainerName	配信不能イベントの宛先であるストレージ BLOB コンテナーの名前	string
resourceId	配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID	string

EventSubscriptionIdentity

名前	説明	値
type	使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	リソースに関連付けられているユーザー ID。	string

DeliveryWithResourceIdentity

名前	説明	値
destination	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 Azure Event Gridの ID を使用して、配信/配信不能時に使用される認証トークンを取得します。	EventSubscriptionDestination
identity	イベントの配信時に使用する ID。	EventSubscriptionIdentity

EventSubscriptionDestination

名前	説明	値
endpointType	オブジェクトの種類を設定する	AzureFunction EventHub HybridConnection MonitorAlert NamespaceTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook (必須)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

DeliveryAttributeMapping

名前	説明	値
name	配信属性またはヘッダーの名前。	string
type	オブジェクトの種類を設定する	動的 静的 (必須)

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

名前	説明	値
sourceField	属性値を含むイベント内の JSON パス。	string

StaticDeliveryAttributeMapping

名前	説明	値
type	配信属性またはヘッダー名の種類。	'Static' (必須)
properties	静的配信属性マッピングのプロパティ。	StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

名前	説明	値
isSecret	属性に機密情報が含まれているかどうかを示すブール型 (Boolean) フラグ。	[bool]
value	配信属性の値。	string

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

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

MonitorAlertEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの宛先のエンドポイントの種類。	'MonitorAlert' (必須)
properties	イベント サブスクリプションの送信先の Alert プロパティを監視します。	MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

名前	説明	値
actionGroups	このイベント サブスクリプションを通じて発生するすべてのアラートでトリガーされるアクション グループの ARM ID の一覧。 各リソース ARM ID は、/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName} というパターンに従う必要があります。	string[]
description	このイベント サブスクリプションを通じて発生したすべてのアラートにアタッチされる説明。	string
severity	このイベント サブスクリプションを通じて発生したすべてのアラートにアタッチされる重大度。 このフィールドは指定する必要があります。	'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4'

NamespaceTopicEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	'NamespaceTopic' (必須)
properties	イベント サブスクリプションの送信先の名前空間トピック のプロパティ。	NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

名前	説明	値
resourceId	イベント サブスクリプションの Event Grid 名前空間トピックの送信先のエンドポイントを表す Azure リソース ID。 このフィールドは必須であり、一覧表示されている名前空間トピック リソースは既に存在している必要があります。 リソース ARM ID は、/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName} というパターンに従う必要があります。	string

PartnerEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	'PartnerDestination' (必須)
properties	イベント サブスクリプションの送信先のパートナーの宛先プロパティ。	PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

名前	説明	値
resourceId	イベント サブスクリプションのパートナーの宛先のエンドポイントを表す Azure リソース ID。	string

ServiceBusQueueEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	'ServiceBusQueue' (必須)
properties	イベント サブスクリプションの送信先の Service Bus プロパティ。	ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名前	説明	値
deliveryAttributeMappings	配信属性の詳細。	DeliveryAttributeMapping[]
resourceId	イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。	string

ServiceBusTopicEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	'ServiceBusTopic' (必須)
properties	イベント サブスクリプションの送信先の Service Bus トピックのプロパティ。	ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

名前	説明	値
deliveryAttributeMappings	配信属性の詳細。	DeliveryAttributeMapping[]
resourceId	イベント サブスクリプションの Service Bus トピックの送信先のエンドポイントを表す Azure リソース ID。	string

StorageQueueEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	'StorageQueue' (必須)
properties	イベント サブスクリプションの送信先のストレージ キューのプロパティ。	StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名前	説明	値
queueMessageTimeToLiveInSeconds	ストレージ キュー メッセージの有効期間 (秒単位)。 メッセージの Time To Live が Infinite であることを示すために -1 を使用する場合を除き、この値を 0 または負の値にすることはできません。	INT
queueName	イベント サブスクリプションの送信先であるストレージ アカウントの下にあるストレージ キューの名前。	string
resourceId	イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。	string

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名前	説明	値
azureActiveDirectoryApplicationIdOrUri	配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory アプリケーション ID または URI。	string
azureActiveDirectoryTenantId	配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory テナント ID。	string
deliveryAttributeMappings	配信属性の詳細。	DeliveryAttributeMapping[]
endpointUrl	イベント サブスクリプションの送信先のエンドポイントを表す URL。	string 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
maxEventsPerBatch	バッチあたりのイベントの最大数。	INT
minimumTlsVersionAllowed	Webhook エンドポイントでサポートされる必要がある最小 TLS バージョン	'1.0' '1.1' '1.2'
preferredBatchSizeInKilobytes	推奨されるバッチ サイズ (キロバイト単位)。	INT

QueueInfo

名前	説明	値
deadLetterDestinationWithResourceIdentity	イベント サブスクリプションの配信不能の宛先。 送信先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (つまり、トピック) のマネージド ID セットアップを使用して、配信/配信不能の間に使用される認証トークンを取得します。	DeadLetterWithResourceIdentity
eventTimeToLive	メッセージが発行された時点からサブスクリプションで使用できるメッセージの長さを決定する ISO 8601 形式の期間。 この期間の値は、'P(n)Y(n)M(n)DT(n)H(n)M(n)S' の形式で表されます。ここで、 - (n) は、 (n) に続く各 time 要素の値に置き換えられます。 - P は期間 (または期間) 指定子であり、常に期間の先頭に配置されます。 - Y は年の指定子であり、年数の値に従います。 - M は月の指定子であり、月数の値に従います。 - W は週指定子であり、週数の値に従います。 - D は日指定子であり、日数の値に従います。 - T は時間指定子であり、時間コンポーネントの前に置きます。 - H は時間指定子であり、時間数の値に従います。 - M は分指定子であり、分数の値に従います。 - S は 2 番目の指定子であり、秒数の値に従います。 この期間の値は、トピックの EventRetentionInDays より大きく設定することはできません。 これは、最小値が 1 分で、最大値が決定される省略可能なフィールドです トピックの EventRetentionInDays 値によって。 有効な値の例を次に示します。 - 'P0DT23H12M' または 'PT23H12M': 23 時間 12 分の期間。 - 'P1D' または 'P1DT0H0M0S': 1 日の期間。	string
maxDeliveryCount	イベントの最大配信数。	INT
receiveLockDurationInSeconds	メッセージが (クライアントによって) 受信され、受け入れ、解放、または拒否されるのを待機している最大期間 (秒単位)。 クライアントがメッセージを受信した後にこの時間が経過し、受け入れ済み (処理されていない)、リリースまたは拒否に移行されなかった場合は、 メッセージは再配信に使用できます。 これは省略可能なフィールドです。既定値は 60 秒、最小値は 60 秒、最大値は 300 秒です。	INT

FiltersConfiguration

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

フィルター

名前	説明	値
キー	フィルター処理するイベントのフィールド/プロパティ。	string
operatorType	オブジェクトの種類を設定する	BoolEquals です。 IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (必須)

BoolEqualsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'BoolEquals' (必須)
value	ブール値フィルター値。	[bool]

IsNotNullFilter

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

IsNullOrUndefinedFilter

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

NumberGreaterThanFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberGreaterThan' (必須)
value	フィルター値。	INT

NumberGreaterThanOrEqualsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberGreaterThanOrEquals' (必須)
value	フィルター値。	INT

NumberInFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberIn' (必須)
値	フィルター値のセット。	int[]

NumberInRangeFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberInRange' (必須)
値	フィルター値のセット。	int[][]

NumberLessThanFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberLessThan' (必須)
value	フィルター値。	INT

NumberLessThanOrEqualsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberLessThanOrEquals' (必須)
value	フィルター値。	INT

NumberNotInFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberNotIn' (必須)
値	フィルター値のセット。	int[]

NumberNotInRangeFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'NumberNotInRange' (必須)
値	フィルター値のセット。	int[][]

StringBeginsWithFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringBeginsWith' (必須)
値	フィルター値のセット。	string[]

StringContainsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringContains' (必須)
値	フィルター値のセット。	string[]

StringEndsWithFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringEndsWith' (必須)
値	フィルター値のセット。	string[]

StringInFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringIn' (必須)
値	フィルター値のセット。	string[]

StringNotBeginsWithFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringNotBeginsWith' (必須)
値	フィルター値のセット。	string[]

StringNotContainsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringNotContains' (必須)
値	フィルター値のセット。	string[]

StringNotEndsWithFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringNotEndsWith' (必須)
値	フィルター値のセット。	string[]

StringNotInFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	'StringNotIn' (必須)
値	フィルター値のセット。	string[]

Terraform (AzAPI プロバイダー) リソース定義

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

• リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    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"
            }
          }
          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 = "CloudEventSchemaV1_0"
      filtersConfiguration = {
        filters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see Filter objects
          }
        ]
        includedEventTypes = [
          "string"
        ]
      }
    }
  })
}

DeadLetterDestination オブジェクト

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

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

  endpointType = "StorageBlob"
  properties = {
    blobContainerName = "string"
    resourceId = "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
  }

DeliveryAttributeMapping オブジェクト

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

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

  type = "Dynamic"
  properties = {
    sourceField = "string"
  }

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

  type = "Static"
  properties = {
    isSecret = bool
    value = "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"
  ]

プロパティ値

namespaces/topics/eventSubscriptions

名前	説明	値
type	リソースの種類	"Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview"
name	リソース名	string (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: トピック
properties	イベント サブスクリプションのプロパティ。	SubscriptionProperties

SubscriptionProperties

名前	説明	値
deliveryConfiguration	イベント サブスクリプションの配信構成に関する情報。	DeliveryConfiguration
eventDeliverySchema	イベント サブスクリプションのイベント配信スキーマ。	"CloudEventSchemaV1_0"
filtersConfiguration	イベント サブスクリプションのフィルターに関する情報。	FiltersConfiguration

DeliveryConfiguration

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

PushInfo

名前	説明	値
deadLetterDestinationWithResourceIdentity	イベント サブスクリプションの配信不能の宛先。 配信先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (名前空間) のマネージド ID セットアップを使用して、配信/配信不能中に使用される認証トークンを取得します。	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID 設定を使用して、配信/配信不能時に使用される認証トークンを取得します。	DeliveryWithResourceIdentity
eventTimeToLive	メッセージが発行された時点からサブスクリプションで使用できるメッセージの長さを決定する ISO 8601 形式の期間。 この期間の値は、'P(n)Y(n)M(n)DT(n)H(n)M(n)S' の形式で表されます。ここで、 - (n) は、(n) に続く各 time 要素の値に置き換えられます。 - P は期間 (または期間) 指定子であり、常に期間の先頭に配置されます。 - Y は年指定子であり、年数の値に従います。 - M は月の指定子であり、月数の値に従います。 - W は週指定子であり、週数の値に従います。 - D は日指定子であり、日数の値に従います。 - T は時間指定子であり、時間コンポーネントの前に置きます。 - H は時間指定子であり、時間数の値に従います。 - M は分指定子であり、分数の値に従います。 - S は 2 番目の指定子であり、秒数の値に従います。 この期間の値は、トピックの EventRetentionInDays より大きく設定することはできません。 これは省略可能なフィールドであり、最小値は 1 分で、最大値は決定されます トピックの EventRetentionInDays 値で指定します。 有効な値の例を次に示します。 - 'P0DT23H12M' または 'PT23H12M': 23 時間 12 分の期間。 - 'P1D' または 'P1DT0H0M0S': 1 日の期間。	string
maxDeliveryCount	イベントの最大配信数。	INT

DeadLetterWithResourceIdentity

名前	説明	値
deadLetterDestination	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID 設定を使用して、配信/配信不能時に使用される認証トークンを取得します。	DeadLetterDestination
identity	配信不能イベントの際に使用する ID。	EventSubscriptionIdentity

DeadLetterDestination

名前	説明	値
endpointType	オブジェクトの種類を設定する	StorageBlob (必須)

StorageBlobDeadLetterDestination

名前	説明	値
endpointType	配信不能の宛先のエンドポイントの種類	"StorageBlob" (必須)
properties	ストレージ BLOB ベースの配信不能宛先のプロパティ	StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名前	説明	値
blobContainerName	配信不能イベントの宛先であるストレージ BLOB コンテナーの名前	string
resourceId	配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID	string

EventSubscriptionIdentity

名前	説明	値
type	使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。	"SystemAssigned" "UserAssigned"
userAssignedIdentity	リソースに関連付けられているユーザー ID。	string

DeliveryWithResourceIdentity

名前	説明	値
destination	イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 Azure Event Gridの ID を使用して、配信/配信不能時に使用される認証トークンを取得します。	EventSubscriptionDestination
identity	イベントの配信時に使用する ID。	EventSubscriptionIdentity

EventSubscriptionDestination

名前	説明	値
endpointType	オブジェクトの種類を設定する	AzureFunction EventHub HybridConnection MonitorAlert NamespaceTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook (必須)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

DeliveryAttributeMapping

名前	説明	値
name	配信属性またはヘッダーの名前。	string
type	オブジェクトの種類を設定する	動的 静的 (必須)

DynamicDeliveryAttributeMapping

名前	説明	値
type	配信属性またはヘッダー名の種類。	"動的" (必須)
properties	動的配信属性マッピングのプロパティ。	DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

名前	説明	値
sourceField	属性値を含むイベント内の JSON パス。	string

StaticDeliveryAttributeMapping

名前	説明	値
type	配信属性またはヘッダー名の種類。	"Static" (必須)
properties	静的配信属性マッピングのプロパティ。	StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

名前	説明	値
isSecret	属性に機密情報が含まれているかどうかを示すブール型フラグ。	[bool]
value	配信属性の値。	string

EventHubEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	"EventHub" (必須)
properties	イベント サブスクリプションの送信先のイベント ハブのプロパティ。	EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	"HybridConnection" (必須)
properties	イベント サブスクリプションの送信先のハイブリッド接続プロパティ。	HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

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

MonitorAlertEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	"MonitorAlert" (必須)
properties	イベント サブスクリプションの送信先のアラート プロパティを監視します。	MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

名前	説明	値
actionGroups	このイベント サブスクリプションを通じて発生したすべてのアラートでトリガーされるアクション グループの ARM ID の一覧。 各リソース ARM ID は、/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName} というパターンに従う必要があります。	string[]
description	このイベント サブスクリプションを通じて発生するすべてのアラートにアタッチされる説明。	string
severity	このイベント サブスクリプションを通じて発生したすべてのアラートにアタッチされる重大度。 このフィールドは指定する必要があります。	"Sev0" "Sev1" "Sev2" "Sev3" "Sev4"

NamespaceTopicEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	"NamespaceTopic" (必須)
properties	イベント サブスクリプションの送信先の名前空間トピック のプロパティ。	NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

名前	説明	値
resourceId	イベント サブスクリプションの Event Grid 名前空間トピックの送信先のエンドポイントを表す Azure リソース ID。 このフィールドは必須であり、一覧表示されている名前空間トピック リソースは既に存在している必要があります。 リソース ARM ID は、/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName} というパターンに従う必要があります。	string

PartnerEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	"PartnerDestination" (必須)
properties	イベント サブスクリプションの送信先のパートナーの宛先プロパティ。	PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

名前	説明	値
resourceId	イベント サブスクリプションのパートナーの宛先のエンドポイントを表す Azure リソース ID。	string

ServiceBusQueueEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの送信先のエンドポイントの種類。	"ServiceBusQueue" (必須)
properties	イベント サブスクリプションの送信先の Service Bus プロパティ。	ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名前	説明	値
deliveryAttributeMappings	配信属性の詳細。	DeliveryAttributeMapping[]
resourceId	イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。	string

ServiceBusTopicEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの宛先のエンドポイントの種類。	"ServiceBusTopic" (必須)
properties	イベント サブスクリプションの宛先の Service Bus トピックのプロパティ。	ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

名前	説明	値
deliveryAttributeMappings	配信属性の詳細。	DeliveryAttributeMapping[]
resourceId	イベント サブスクリプションの Service Bus トピックの宛先のエンドポイントを表す Azure リソース ID。	string

StorageQueueEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの宛先のエンドポイントの種類。	"StorageQueue" (必須)
properties	イベント サブスクリプションの宛先のストレージ キューのプロパティ。	StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名前	説明	値
queueMessageTimeToLiveInSeconds	ストレージ キュー メッセージの有効期間 (秒単位)。 メッセージの Time To Live が Infinite であることを示すために -1 を使用する場合を除き、この値を 0 または負にすることはできません。	INT
queueName	イベント サブスクリプションの宛先であるストレージ アカウントのストレージ キューの名前。	string
resourceId	イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。	string

WebHookEventSubscriptionDestination

名前	説明	値
endpointType	イベント サブスクリプションの宛先のエンドポイントの種類。	"WebHook" (必須)
properties	イベント サブスクリプションの宛先の WebHook プロパティ。	WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名前	説明	値
azureActiveDirectoryApplicationIdOrUri	配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Azure Active Directory アプリケーション ID または URI。	string
azureActiveDirectoryTenantId	配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Azure Active Directory テナント ID。	string
deliveryAttributeMappings	配信属性の詳細。	DeliveryAttributeMapping[]
endpointUrl	イベント サブスクリプションの送信先のエンドポイントを表す URL。	string 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
maxEventsPerBatch	バッチあたりのイベントの最大数。	INT
minimumTlsVersionAllowed	Webhook エンドポイントでサポートされる必要がある TLS の最小バージョン	"1.0" "1.1" "1.2"
preferredBatchSizeInKilobytes	推奨されるバッチ サイズ (キロバイト単位)。	INT

QueueInfo

名前	説明	値
deadLetterDestinationWithResourceIdentity	イベント サブスクリプションの配信不能の宛先。 配信先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (つまりトピック) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。	DeadLetterWithResourceIdentity
eventTimeToLive	メッセージが発行された時点からサブスクリプションで使用できるメッセージの長さを決定する ISO 8601 形式の期間。 この期間の値は、'P(n)Y(n)M(n)DT(n)H(n)M(n)S' の形式で表されます。ここで、 - (n) は、(n) に続く各 time 要素の値に置き換えられます。 - P は期間 (または期間) 指定子であり、常に期間の先頭に配置されます。 - Y は年指定子であり、年数の値に従います。 - M は月の指定子であり、月数の値に従います。 - W は週指定子であり、週数の値に従います。 - D は日指定子であり、日数の値に従います。 - T は時間指定子であり、時間コンポーネントの前に置きます。 - H は時間指定子であり、時間数の値に従います。 - M は分指定子であり、分数の値に従います。 - S は 2 番目の指定子であり、秒数の値に従います。 この期間の値は、トピックの EventRetentionInDays より大きく設定することはできません。 これは省略可能なフィールドであり、最小値は 1 分で、最大値は決定されます トピックの EventRetentionInDays 値で指定します。 有効な値の例を次に示します。 - 'P0DT23H12M' または 'PT23H12M': 23 時間 12 分の期間。 - 'P1D' または 'P1DT0H0M0S': 1 日の期間。	string
maxDeliveryCount	イベントの最大配信数。	INT
receiveLockDurationInSeconds	メッセージが (クライアントによって) 受信され、受け入れ、解放、または拒否されるのを待機している最大期間 (秒単位)。 クライアントがメッセージを受信した後にこの時間が経過し、受け入れ済み (未処理)、リリース済み、または拒否に移行されていない場合は、 メッセージは再配信に使用できます。 これは省略可能なフィールドです。既定値は 60 秒、最小値は 60 秒、最大は 300 秒です。	INT

FiltersConfiguration

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

フィルター

名前	説明	値
キー	フィルター処理するイベントのフィールド/プロパティ。	string
operatorType	オブジェクトの種類を設定する	BoolEquals です。 IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (必須)

BoolEqualsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"BoolEquals" (必須)
value	ブール値フィルター値。	[bool]

IsNotNullFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"IsNotNull" (必須)

IsNullOrUndefinedFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"IsNullOrUndefined" (必須)

NumberGreaterThanFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"NumberGreaterThan" (必須)
value	フィルター値。	INT

NumberGreaterThanOrEqualsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"NumberGreaterThanOrEquals" (必須)
value	フィルター値。	INT

NumberInFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"NumberIn" (必須)
値	フィルター値のセット。	int[]

NumberInRangeFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"NumberInRange" (必須)
値	フィルター値のセット。	int[][]

NumberLessThanFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"NumberLessThan" (必須)
value	フィルター値。	INT

NumberLessThanOrEqualsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"NumberLessThanOrEquals" (必須)
value	フィルター値。	INT

NumberNotInFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"NumberNotIn" (必須)
値	フィルター値のセット。	int[]

NumberNotInRangeFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"NumberNotInRange" (必須)
値	フィルター値のセット。	int[][]

StringBeginsWithFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"StringBeginsWith" (必須)
値	フィルター値のセット。	string[]

StringContainsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"StringContains" (必須)
値	フィルター値のセット。	string[]

StringEndsWithFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"StringEndsWith" (必須)
値	フィルター値のセット。	string[]

StringInFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"StringIn" (必須)
値	フィルター値のセット。	string[]

StringNotBeginsWithFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"StringNotBeginsWith" (必須)
値	フィルター値のセット。	string[]

StringNotContainsFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"StringNotContains" (必須)
値	フィルター値のセット。	string[]

StringNotEndsWithFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"StringNotEndsWith" (必須)
値	フィルター値のセット。	string[]

StringNotInFilter

名前	説明	値
operatorType	フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。	"StringNotIn" (必須)
値	フィルター値のセット。	string[]