Bicep リソース定義
systemTopics/eventSubscriptions リソースの種類は、次を対象とする操作と共にデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソース形式
Microsoft.EventGrid/systemTopics/eventSubscriptions リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.EventGrid/systemTopics/eventSubscriptions@2025-04-01-preview' = {
parent: resourceSymbolicName
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
}
}
}
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
}
}
DeadLetterDestination オブジェクト
endpointType プロパティを設定して、オブジェクトのタイプを指定します。
StorageBlobを
{
endpointType: 'StorageBlob'
properties: {
blobContainerName: 'string'
resourceId: 'string'
}
}
DeliveryAttributeMapping オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
動的の場合は、以下を使用します。
{
properties: {
sourceField: 'string'
}
type: 'Dynamic'
}
静的の場合は、次を使用します。
{
properties: {
isSecret: bool
value: 'string'
}
type: 'Static'
}
プロパティ値
Microsoft.EventGrid/systemTopics/eventSubscriptions
| Name | Description | Value |
|---|---|---|
| name | リソース名 | 文字列 (必須) |
| 親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
タイプのリソースのシンボリック名: systemTopics |
| properties | イベント サブスクリプションのプロパティ。 | EventSubscriptionProperties |
AdvancedFilter
| Name | Description | Value |
|---|---|---|
| キー | フィルター処理するイベントのフィールド/プロパティ。 | 文字列 |
| operatorType | BoolEqualsAdvancedFilter型 |
'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (必須) |
AzureFunctionEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'AzureFunction' (必須) |
| properties | イベント サブスクリプションの送信先の Azure 関数プロパティ。 | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| maxEventsPerBatch | バッチあたりのイベントの最大数。 | int |
| preferredBatchSizeInKilobytes | 推奨されるバッチ サイズ (KB 単位)。 | int |
| resourceId | イベント サブスクリプションの Azure 関数の送信先のエンドポイントを表す Azure リソース ID。 | 文字列 |
BoolEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'BoolEquals' (必須) |
| value | ブール値のフィルター値。 | bool |
DeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | StorageBlobDeadLetterDestinationの種類 |
'StorageBlob' (必須) |
DeadLetterWithResourceIdentity
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信不能時に使用される認証トークンを取得します。 |
DeadLetterDestination |
| ID | 配信不能イベントの場合に使用する ID。 | EventSubscriptionIdentity |
DeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| name | 配信属性またはヘッダーの名前。 | 文字列 |
| 型 | DynamicDeliveryAttributeMapping 型を 'Dynamic' に設定します。 タイプ StaticDeliveryAttributeMapping を 'Static' に設定します。 | 'Dynamic' 'Static' (必須) |
DeliveryWithResourceIdentity
| Name | Description | Value |
|---|---|---|
| コピー先 | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信中に使用される認証トークンを取得します。 |
EventSubscriptionDestination |
| ID | イベントを配信するときに使用する ID。 | EventSubscriptionIdentity |
DynamicDeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| properties | 動的配信属性マッピングのプロパティ。 | DynamicDeliveryAttributeMappingProperties |
| 型 | 配信属性またはヘッダー名の種類。 | '動的' (必須) |
DynamicDeliveryAttributeMappingProperties
| Name | Description | Value |
|---|---|---|
| sourceField | 属性値を含むイベントの JSON パス。 | 文字列 |
EventHubEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'EventHub' (必須) |
| properties | イベント サブスクリプションの送信先の Event Hub プロパティ。 | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| resourceId | イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。 | 文字列 |
EventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType |
AzureFunctionEventSubscriptionDestination 型の 'AzureFunction' に設定します。 EventHubEventSubscriptionDestination |
'AzureFunction' 'EventHub' 'HybridConnection' 'MonitorAlert' 'NamespaceTopic' 'PartnerDestination' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' (必須) |
EventSubscriptionFilter
| Name | Description | Value |
|---|---|---|
| advancedFilters | イベント サブスクリプションのフィルター処理に使用される高度なフィルターの配列。 | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | 特異な値を期待するのではなく、値の配列に対して高度なフィルターを評価できるようにします。 | bool |
| includedEventTypes | イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 すべての既定のイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。 | string[] |
| isSubjectCaseSensitive | フィルターの SubjectBeginsWith プロパティと SubjectEndsWith プロパティを指定します。 は、大文字と小文字を区別して比較する必要があります。 |
bool |
| subjectBeginsWith | リソース パス プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 この形式は、イベントの発行元によって異なります。 このパスでは、ワイルドカード文字はサポートされていません。 |
文字列 |
| subjectEndsWith | リソース パス サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 このパスでは、ワイルドカード文字はサポートされていません。 |
文字列 |
EventSubscriptionIdentity
| Name | Description | Value |
|---|---|---|
| federatedIdentityCredentialInfo | リソース配信で使用されるフェデレーション ID 資格情報 (FIC) の詳細。 | FederatedIdentityCredentialInfo |
| 型 | 使用されるマネージド ID の種類。 'SystemAssigned' または 'UserAssigned' のいずれかを指定できます。 | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | リソースに関連付けられているユーザー ID。 | 文字列 |
EventSubscriptionProperties
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | イベント サブスクリプションの配信不能の宛先。 配信不能の宛先に配信できないイベントは、配信不能の宛先に送信されます。 Azure Event Grid の ID を使用して、配信/配信不能の間に使用される認証トークンを取得します。 |
DeadLetterDestination |
| deadLetterWithResourceIdentity | イベント サブスクリプションの配信不能の宛先。 配信不能の宛先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。 |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。 |
DeliveryWithResourceIdentity |
| コピー先 | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 Azure Event Grid の ID を使用して、配信/配信不能の間に使用される認証トークンを取得します。 |
EventSubscriptionDestination |
| eventDeliverySchema | イベント サブスクリプションのイベント配信スキーマ。 | 'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema' |
| expirationTimeUtc | イベント サブスクリプションの有効期限。 | 文字列 |
| フィルタ | イベント サブスクリプションのフィルターに関する情報。 | EventSubscriptionFilter |
| labels | ユーザー定義ラベルの一覧。 | string[] |
| retryPolicy | イベントの再試行ポリシー。 これを使用して、イベントの配信試行の最大数と有効期間を構成できます。 | RetryPolicy |
FederatedIdentityCredentialInfo
| Name | Description | Value |
|---|---|---|
| federatedClientId | フェデレーション ID 資格情報 (FIC) が関連付けられているマルチテナント Microsoft Entra ID アプリケーション。 | string Constraints: 最小長 = 36 最大長 = 36 パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (必須) |
HybridConnectionEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'HybridConnection' (必須) |
| properties | イベント サブスクリプションの送信先のハイブリッド接続プロパティ。 | HybridConnectionEventSubscriptionDestinationProperties |
HybridConnectionEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| resourceId | イベント サブスクリプションの宛先であるハイブリッド接続の Azure リソース ID。 | 文字列 |
IsNotNullAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'IsNotNull' (必須) |
IsNullOrUndefinedAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'IsNullOrUndefined' (必須) |
MonitorAlertEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'MonitorAlert' (必須) |
| properties | イベント サブスクリプションの送信先のアラート プロパティを監視します。 | MonitorAlertEventSubscriptionDestinationProperties |
MonitorAlertEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| actionGroups | このイベント サブスクリプションを通じて発生したすべてのアラートでトリガーされるアクション グループの ARM ID の一覧。 各リソース ARM ID は、/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName} というパターンに従う必要があります。 |
string[] |
| description | このイベント サブスクリプションを通じて発生したすべてのアラートにアタッチされる説明。 | 文字列 |
| severity | このイベント サブスクリプションを通じて発生したすべてのアラートにアタッチされる重大度。 このフィールドは指定する必要があります。 |
'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4' |
NamespaceTopicEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'NamespaceTopic' (必須) |
| properties | イベント サブスクリプションの送信先の名前空間トピックのプロパティ。 | NamespaceTopicEventSubscriptionDestinationProperties |
NamespaceTopicEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| resourceId | イベント サブスクリプションの Event Grid 名前空間トピックの宛先のエンドポイントを表す Azure リソース ID。 このフィールドは必須であり、一覧表示されている名前空間トピック リソースが既に存在している必要があります。 リソース ARM ID は、/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName} というパターンに従う必要があります。 |
文字列 |
NumberGreaterThanAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThan' (必須) |
| value | フィルター値。 | int |
NumberGreaterThanOrEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThanOrEquals' (必須) |
| value | フィルター値。 | int |
NumberInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberIn' (必須) |
| values | フィルター値のセット。 | int[] |
NumberInRangeAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberInRange' (必須) |
| values | フィルター値のセット。 | int[][] |
NumberLessThanAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThan' (必須) |
| value | フィルター値。 | int |
NumberLessThanOrEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThanOrEquals' (必須) |
| value | フィルター値。 | int |
NumberNotInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberNotIn' (必須) |
| values | フィルター値のセット。 | int[] |
NumberNotInRangeAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberNotInRange' (必須) |
| values | フィルター値のセット。 | int[][] |
PartnerEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'PartnerDestination' (必須) |
| properties | イベント サブスクリプションの送信先のパートナー変換先のプロパティ。 | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| resourceId | イベント サブスクリプションのパートナー宛先のエンドポイントを表す Azure リソース ID。 | 文字列 |
RetryPolicy
| Name | Description | Value |
|---|---|---|
| eventTimeToLiveInMinutes | イベントの Time To Live (分単位)。 | int |
| maxDeliveryAttempts | イベントの配信再試行の最大数。 | int |
ServiceBusQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'ServiceBusQueue' (必須) |
| properties | イベント サブスクリプションの送信先の Service Bus プロパティ。 | ServiceBusQueueEventSubscriptionDestinationProperties |
ServiceBusQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| resourceId | イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。 | 文字列 |
ServiceBusTopicEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'ServiceBusTopic' (必須) |
| properties | イベント サブスクリプションの送信先の Service Bus トピックのプロパティ。 | ServiceBusTopicEventSubscriptionDestinationProperties |
ServiceBusTopicEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| resourceId | イベント サブスクリプションの Service Bus トピックの宛先のエンドポイントを表す Azure リソース ID。 | 文字列 |
StaticDeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| properties | 静的配信属性マッピングのプロパティ。 | StaticDeliveryAttributeMappingProperties |
| 型 | 配信属性またはヘッダー名の種類。 | 'Static' (必須) |
StaticDeliveryAttributeMappingProperties
| Name | Description | Value |
|---|---|---|
| isSecret | 属性に機密情報が含まれているかどうかを示すブール型フラグ。 | bool |
| value | 配信属性の値。 | 文字列 |
StorageBlobDeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | 配信不能宛先のエンドポイントの種類 | 'StorageBlob' (必須) |
| properties | ストレージ BLOB ベースの配信不能宛先のプロパティ | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Name | Description | Value |
|---|---|---|
| blobContainerName | 配信不能イベントの宛先であるストレージ BLOB コンテナーの名前 | 文字列 |
| resourceId | 配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID | 文字列 |
StorageQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'StorageQueue' (必須) |
| properties | イベント サブスクリプションの宛先のストレージ キューのプロパティ。 | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| queueMessageTimeToLiveInSeconds | ストレージ キュー メッセージの有効期間 (秒単位)。 メッセージの Time To Live が Infinite であることを示すために -1 を使用する場合を除き、この値を 0 または負にすることはできません。 | int |
| queueName | イベント サブスクリプションの宛先であるストレージ アカウントのストレージ キューの名前。 | 文字列 |
| resourceId | イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。 | 文字列 |
StringBeginsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringBeginsWith' (必須) |
| values | フィルター値のセット。 | string[] |
StringContainsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringContains' (必須) |
| values | フィルター値のセット。 | string[] |
StringEndsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringEndsWith' (必須) |
| values | フィルター値のセット。 | string[] |
StringInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringIn' (必須) |
| values | フィルター値のセット。 | string[] |
StringNotBeginsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotBeginsWith' (必須) |
| values | フィルター値のセット。 | string[] |
StringNotContainsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotContains' (必須) |
| values | フィルター値のセット。 | string[] |
StringNotEndsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotEndsWith' (必須) |
| values | フィルター値のセット。 | string[] |
StringNotInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotIn' (必須) |
| values | フィルター値のセット。 | string[] |
WebHookEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'WebHook' (必須) |
| properties | イベント サブスクリプションの送信先の WebHook プロパティ。 | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | Microsoft Entra ID、アプリケーション ID または URI: 配信要求のベアラー トークンとして含まれるアクセス トークンを取得します。 | 文字列 |
| azureActiveDirectoryTenantId | Microsoft Entra ID テナント ID は、配信要求にベアラー トークンとして含まれるアクセス トークンを取得します。 | 文字列 |
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| endpointUrl | イベント サブスクリプションの送信先のエンドポイントを表す URL。 | string Constraints: 機密値。 セキュリティで保護されたパラメーターとして渡します。 |
| maxEventsPerBatch | バッチあたりのイベントの最大数。 | int |
| minimumTlsVersionAllowed | Webhook エンドポイントでサポートされる必要がある最小 TLS バージョン | '1.0' '1.1' '1.2' |
| preferredBatchSizeInKilobytes | 推奨されるバッチ サイズ (KB 単位)。 | int |
使用例
Azure クイック スタートのサンプル
次の Azure クイック スタート テンプレートには、 このリソースの種類をデプロイするための Bicep サンプルが含まれています。
| Bicep ファイル | Description |
|---|---|
| BLOB ストレージと Event Grid サブスクリプションを BLOB に作成する | Azure Blob Storage アカウントを作成し、その BLOB に対する Event Grid サブスクリプションを作成します。 |
| Event Grid 接続 を使用して Azure Data Explorer db をデプロイ |
Event Grid 接続を使用して Azure Data Explorer db をデプロイします。 |
ARM テンプレート リソース定義
systemTopics/eventSubscriptions リソースの種類は、次を対象とする操作と共にデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソース形式
Microsoft.EventGrid/systemTopics/eventSubscriptions リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.EventGrid/systemTopics/eventSubscriptions",
"apiVersion": "2025-04-01-preview",
"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"
}
}
}
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"
}
}
DeadLetterDestination オブジェクト
endpointType プロパティを設定して、オブジェクトのタイプを指定します。
StorageBlobを
{
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "string",
"resourceId": "string"
}
}
DeliveryAttributeMapping オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
動的の場合は、以下を使用します。
{
"properties": {
"sourceField": "string"
},
"type": "Dynamic"
}
静的の場合は、次を使用します。
{
"properties": {
"isSecret": "bool",
"value": "string"
},
"type": "Static"
}
プロパティ値
Microsoft.EventGrid/systemTopics/eventSubscriptions
| Name | Description | Value |
|---|---|---|
| apiVersion | API のバージョン | '2025-04-01-preview' |
| name | リソース名 | 文字列 (必須) |
| properties | イベント サブスクリプションのプロパティ。 | EventSubscriptionProperties |
| 型 | リソースの種類 | 'Microsoft.EventGrid/systemTopics/eventSubscriptions' |
AdvancedFilter
| Name | Description | Value |
|---|---|---|
| キー | フィルター処理するイベントのフィールド/プロパティ。 | 文字列 |
| operatorType | BoolEqualsAdvancedFilter型 |
'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (必須) |
AzureFunctionEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'AzureFunction' (必須) |
| properties | イベント サブスクリプションの送信先の Azure 関数プロパティ。 | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| maxEventsPerBatch | バッチあたりのイベントの最大数。 | int |
| preferredBatchSizeInKilobytes | 推奨されるバッチ サイズ (KB 単位)。 | int |
| resourceId | イベント サブスクリプションの Azure 関数の送信先のエンドポイントを表す Azure リソース ID。 | 文字列 |
BoolEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'BoolEquals' (必須) |
| value | ブール値のフィルター値。 | bool |
DeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | StorageBlobDeadLetterDestinationの種類 |
'StorageBlob' (必須) |
DeadLetterWithResourceIdentity
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信不能時に使用される認証トークンを取得します。 |
DeadLetterDestination |
| ID | 配信不能イベントの場合に使用する ID。 | EventSubscriptionIdentity |
DeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| name | 配信属性またはヘッダーの名前。 | 文字列 |
| 型 | DynamicDeliveryAttributeMapping 型を 'Dynamic' に設定します。 タイプ StaticDeliveryAttributeMapping を 'Static' に設定します。 | 'Dynamic' 'Static' (必須) |
DeliveryWithResourceIdentity
| Name | Description | Value |
|---|---|---|
| コピー先 | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信中に使用される認証トークンを取得します。 |
EventSubscriptionDestination |
| ID | イベントを配信するときに使用する ID。 | EventSubscriptionIdentity |
DynamicDeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| properties | 動的配信属性マッピングのプロパティ。 | DynamicDeliveryAttributeMappingProperties |
| 型 | 配信属性またはヘッダー名の種類。 | '動的' (必須) |
DynamicDeliveryAttributeMappingProperties
| Name | Description | Value |
|---|---|---|
| sourceField | 属性値を含むイベントの JSON パス。 | 文字列 |
EventHubEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'EventHub' (必須) |
| properties | イベント サブスクリプションの送信先の Event Hub プロパティ。 | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| resourceId | イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。 | 文字列 |
EventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType |
AzureFunctionEventSubscriptionDestination 型の 'AzureFunction' に設定します。 EventHubEventSubscriptionDestination |
'AzureFunction' 'EventHub' 'HybridConnection' 'MonitorAlert' 'NamespaceTopic' 'PartnerDestination' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' (必須) |
EventSubscriptionFilter
| Name | Description | Value |
|---|---|---|
| advancedFilters | イベント サブスクリプションのフィルター処理に使用される高度なフィルターの配列。 | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | 特異な値を期待するのではなく、値の配列に対して高度なフィルターを評価できるようにします。 | bool |
| includedEventTypes | イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 すべての既定のイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。 | string[] |
| isSubjectCaseSensitive | フィルターの SubjectBeginsWith プロパティと SubjectEndsWith プロパティを指定します。 は、大文字と小文字を区別して比較する必要があります。 |
bool |
| subjectBeginsWith | リソース パス プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 この形式は、イベントの発行元によって異なります。 このパスでは、ワイルドカード文字はサポートされていません。 |
文字列 |
| subjectEndsWith | リソース パス サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 このパスでは、ワイルドカード文字はサポートされていません。 |
文字列 |
EventSubscriptionIdentity
| Name | Description | Value |
|---|---|---|
| federatedIdentityCredentialInfo | リソース配信で使用されるフェデレーション ID 資格情報 (FIC) の詳細。 | FederatedIdentityCredentialInfo |
| 型 | 使用されるマネージド ID の種類。 'SystemAssigned' または 'UserAssigned' のいずれかを指定できます。 | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | リソースに関連付けられているユーザー ID。 | 文字列 |
EventSubscriptionProperties
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | イベント サブスクリプションの配信不能の宛先。 配信不能の宛先に配信できないイベントは、配信不能の宛先に送信されます。 Azure Event Grid の ID を使用して、配信/配信不能の間に使用される認証トークンを取得します。 |
DeadLetterDestination |
| deadLetterWithResourceIdentity | イベント サブスクリプションの配信不能の宛先。 配信不能の宛先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。 |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。 |
DeliveryWithResourceIdentity |
| コピー先 | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 Azure Event Grid の ID を使用して、配信/配信不能の間に使用される認証トークンを取得します。 |
EventSubscriptionDestination |
| eventDeliverySchema | イベント サブスクリプションのイベント配信スキーマ。 | 'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema' |
| expirationTimeUtc | イベント サブスクリプションの有効期限。 | 文字列 |
| フィルタ | イベント サブスクリプションのフィルターに関する情報。 | EventSubscriptionFilter |
| labels | ユーザー定義ラベルの一覧。 | string[] |
| retryPolicy | イベントの再試行ポリシー。 これを使用して、イベントの配信試行の最大数と有効期間を構成できます。 | RetryPolicy |
FederatedIdentityCredentialInfo
| Name | Description | Value |
|---|---|---|
| federatedClientId | フェデレーション ID 資格情報 (FIC) が関連付けられているマルチテナント Microsoft Entra ID アプリケーション。 | string Constraints: 最小長 = 36 最大長 = 36 パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (必須) |
HybridConnectionEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'HybridConnection' (必須) |
| properties | イベント サブスクリプションの送信先のハイブリッド接続プロパティ。 | HybridConnectionEventSubscriptionDestinationProperties |
HybridConnectionEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| resourceId | イベント サブスクリプションの宛先であるハイブリッド接続の Azure リソース ID。 | 文字列 |
IsNotNullAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'IsNotNull' (必須) |
IsNullOrUndefinedAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'IsNullOrUndefined' (必須) |
MonitorAlertEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'MonitorAlert' (必須) |
| properties | イベント サブスクリプションの送信先のアラート プロパティを監視します。 | MonitorAlertEventSubscriptionDestinationProperties |
MonitorAlertEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| actionGroups | このイベント サブスクリプションを通じて発生したすべてのアラートでトリガーされるアクション グループの ARM ID の一覧。 各リソース ARM ID は、/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName} というパターンに従う必要があります。 |
string[] |
| description | このイベント サブスクリプションを通じて発生したすべてのアラートにアタッチされる説明。 | 文字列 |
| severity | このイベント サブスクリプションを通じて発生したすべてのアラートにアタッチされる重大度。 このフィールドは指定する必要があります。 |
'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4' |
NamespaceTopicEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'NamespaceTopic' (必須) |
| properties | イベント サブスクリプションの送信先の名前空間トピックのプロパティ。 | NamespaceTopicEventSubscriptionDestinationProperties |
NamespaceTopicEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| resourceId | イベント サブスクリプションの Event Grid 名前空間トピックの宛先のエンドポイントを表す Azure リソース ID。 このフィールドは必須であり、一覧表示されている名前空間トピック リソースが既に存在している必要があります。 リソース ARM ID は、/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName} というパターンに従う必要があります。 |
文字列 |
NumberGreaterThanAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThan' (必須) |
| value | フィルター値。 | int |
NumberGreaterThanOrEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThanOrEquals' (必須) |
| value | フィルター値。 | int |
NumberInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberIn' (必須) |
| values | フィルター値のセット。 | int[] |
NumberInRangeAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberInRange' (必須) |
| values | フィルター値のセット。 | int[][] |
NumberLessThanAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThan' (必須) |
| value | フィルター値。 | int |
NumberLessThanOrEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThanOrEquals' (必須) |
| value | フィルター値。 | int |
NumberNotInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberNotIn' (必須) |
| values | フィルター値のセット。 | int[] |
NumberNotInRangeAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberNotInRange' (必須) |
| values | フィルター値のセット。 | int[][] |
PartnerEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'PartnerDestination' (必須) |
| properties | イベント サブスクリプションの送信先のパートナー変換先のプロパティ。 | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| resourceId | イベント サブスクリプションのパートナー宛先のエンドポイントを表す Azure リソース ID。 | 文字列 |
RetryPolicy
| Name | Description | Value |
|---|---|---|
| eventTimeToLiveInMinutes | イベントの Time To Live (分単位)。 | int |
| maxDeliveryAttempts | イベントの配信再試行の最大数。 | int |
ServiceBusQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'ServiceBusQueue' (必須) |
| properties | イベント サブスクリプションの送信先の Service Bus プロパティ。 | ServiceBusQueueEventSubscriptionDestinationProperties |
ServiceBusQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| resourceId | イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。 | 文字列 |
ServiceBusTopicEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'ServiceBusTopic' (必須) |
| properties | イベント サブスクリプションの送信先の Service Bus トピックのプロパティ。 | ServiceBusTopicEventSubscriptionDestinationProperties |
ServiceBusTopicEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| resourceId | イベント サブスクリプションの Service Bus トピックの宛先のエンドポイントを表す Azure リソース ID。 | 文字列 |
StaticDeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| properties | 静的配信属性マッピングのプロパティ。 | StaticDeliveryAttributeMappingProperties |
| 型 | 配信属性またはヘッダー名の種類。 | 'Static' (必須) |
StaticDeliveryAttributeMappingProperties
| Name | Description | Value |
|---|---|---|
| isSecret | 属性に機密情報が含まれているかどうかを示すブール型フラグ。 | bool |
| value | 配信属性の値。 | 文字列 |
StorageBlobDeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | 配信不能宛先のエンドポイントの種類 | 'StorageBlob' (必須) |
| properties | ストレージ BLOB ベースの配信不能宛先のプロパティ | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Name | Description | Value |
|---|---|---|
| blobContainerName | 配信不能イベントの宛先であるストレージ BLOB コンテナーの名前 | 文字列 |
| resourceId | 配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID | 文字列 |
StorageQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'StorageQueue' (必須) |
| properties | イベント サブスクリプションの宛先のストレージ キューのプロパティ。 | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| queueMessageTimeToLiveInSeconds | ストレージ キュー メッセージの有効期間 (秒単位)。 メッセージの Time To Live が Infinite であることを示すために -1 を使用する場合を除き、この値を 0 または負にすることはできません。 | int |
| queueName | イベント サブスクリプションの宛先であるストレージ アカウントのストレージ キューの名前。 | 文字列 |
| resourceId | イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。 | 文字列 |
StringBeginsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringBeginsWith' (必須) |
| values | フィルター値のセット。 | string[] |
StringContainsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringContains' (必須) |
| values | フィルター値のセット。 | string[] |
StringEndsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringEndsWith' (必須) |
| values | フィルター値のセット。 | string[] |
StringInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringIn' (必須) |
| values | フィルター値のセット。 | string[] |
StringNotBeginsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotBeginsWith' (必須) |
| values | フィルター値のセット。 | string[] |
StringNotContainsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotContains' (必須) |
| values | フィルター値のセット。 | string[] |
StringNotEndsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotEndsWith' (必須) |
| values | フィルター値のセット。 | string[] |
StringNotInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotIn' (必須) |
| values | フィルター値のセット。 | string[] |
WebHookEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'WebHook' (必須) |
| properties | イベント サブスクリプションの送信先の WebHook プロパティ。 | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | Microsoft Entra ID、アプリケーション ID または URI: 配信要求のベアラー トークンとして含まれるアクセス トークンを取得します。 | 文字列 |
| azureActiveDirectoryTenantId | Microsoft Entra ID テナント ID は、配信要求にベアラー トークンとして含まれるアクセス トークンを取得します。 | 文字列 |
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| endpointUrl | イベント サブスクリプションの送信先のエンドポイントを表す URL。 | string Constraints: 機密値。 セキュリティで保護されたパラメーターとして渡します。 |
| maxEventsPerBatch | バッチあたりのイベントの最大数。 | int |
| minimumTlsVersionAllowed | Webhook エンドポイントでサポートされる必要がある最小 TLS バージョン | '1.0' '1.1' '1.2' |
| preferredBatchSizeInKilobytes | 推奨されるバッチ サイズ (KB 単位)。 | int |
使用例
Azure クイック スタート テンプレート
次の Azure クイック スタート テンプレートでは、 このリソースの種類をデプロイします。
| Template | Description |
|---|---|
|
BLOB ストレージと Event Grid サブスクリプションを BLOB に作成する Azure にデプロイする |
Azure Blob Storage アカウントを作成し、その BLOB に対する Event Grid サブスクリプションを作成します。 |
| Event Grid 接続 を使用して Azure Data Explorer db をデプロイ Azure |
Event Grid 接続を使用して Azure Data Explorer db をデプロイします。 |
Terraform (AzAPI プロバイダー) リソース定義
systemTopics/eventSubscriptions リソースの種類は、次を対象とする操作と共にデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソース形式
Microsoft.EventGrid/systemTopics/eventSubscriptions リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/systemTopics/eventSubscriptions@2025-04-01-preview"
name = "string"
parent_id = "string"
body = {
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
}
}
}
}
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
}
}
DeadLetterDestination オブジェクト
endpointType プロパティを設定して、オブジェクトのタイプを指定します。
StorageBlobを
{
endpointType = "StorageBlob"
properties = {
blobContainerName = "string"
resourceId = "string"
}
}
DeliveryAttributeMapping オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
動的の場合は、以下を使用します。
{
properties = {
sourceField = "string"
}
type = "Dynamic"
}
静的の場合は、次を使用します。
{
properties = {
isSecret = bool
value = "string"
}
type = "Static"
}
プロパティ値
Microsoft.EventGrid/systemTopics/eventSubscriptions
| Name | Description | Value |
|---|---|---|
| name | リソース名 | 文字列 (必須) |
| parent_id | このリソースの親であるリソースの ID。 | タイプのリソースの ID: systemTopics |
| properties | イベント サブスクリプションのプロパティ。 | EventSubscriptionProperties |
| 型 | リソースの種類 | "Microsoft.EventGrid/systemTopics/eventSubscriptions@2025-04-01-preview" |
AdvancedFilter
| Name | Description | Value |
|---|---|---|
| キー | フィルター処理するイベントのフィールド/プロパティ。 | 文字列 |
| operatorType | BoolEqualsAdvancedFilter型 |
'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (必須) |
AzureFunctionEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'AzureFunction' (必須) |
| properties | イベント サブスクリプションの送信先の Azure 関数プロパティ。 | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| maxEventsPerBatch | バッチあたりのイベントの最大数。 | int |
| preferredBatchSizeInKilobytes | 推奨されるバッチ サイズ (KB 単位)。 | int |
| resourceId | イベント サブスクリプションの Azure 関数の送信先のエンドポイントを表す Azure リソース ID。 | 文字列 |
BoolEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'BoolEquals' (必須) |
| value | ブール値のフィルター値。 | bool |
DeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | StorageBlobDeadLetterDestinationの種類 |
'StorageBlob' (必須) |
DeadLetterWithResourceIdentity
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信不能時に使用される認証トークンを取得します。 |
DeadLetterDestination |
| ID | 配信不能イベントの場合に使用する ID。 | EventSubscriptionIdentity |
DeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| name | 配信属性またはヘッダーの名前。 | 文字列 |
| 型 | DynamicDeliveryAttributeMapping 型を 'Dynamic' に設定します。 タイプ StaticDeliveryAttributeMapping を 'Static' に設定します。 | 'Dynamic' 'Static' (必須) |
DeliveryWithResourceIdentity
| Name | Description | Value |
|---|---|---|
| コピー先 | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信中に使用される認証トークンを取得します。 |
EventSubscriptionDestination |
| ID | イベントを配信するときに使用する ID。 | EventSubscriptionIdentity |
DynamicDeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| properties | 動的配信属性マッピングのプロパティ。 | DynamicDeliveryAttributeMappingProperties |
| 型 | 配信属性またはヘッダー名の種類。 | '動的' (必須) |
DynamicDeliveryAttributeMappingProperties
| Name | Description | Value |
|---|---|---|
| sourceField | 属性値を含むイベントの JSON パス。 | 文字列 |
EventHubEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'EventHub' (必須) |
| properties | イベント サブスクリプションの送信先の Event Hub プロパティ。 | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| resourceId | イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。 | 文字列 |
EventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType |
AzureFunctionEventSubscriptionDestination 型の 'AzureFunction' に設定します。 EventHubEventSubscriptionDestination |
'AzureFunction' 'EventHub' 'HybridConnection' 'MonitorAlert' 'NamespaceTopic' 'PartnerDestination' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' (必須) |
EventSubscriptionFilter
| Name | Description | Value |
|---|---|---|
| advancedFilters | イベント サブスクリプションのフィルター処理に使用される高度なフィルターの配列。 | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | 特異な値を期待するのではなく、値の配列に対して高度なフィルターを評価できるようにします。 | bool |
| includedEventTypes | イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 すべての既定のイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。 | string[] |
| isSubjectCaseSensitive | フィルターの SubjectBeginsWith プロパティと SubjectEndsWith プロパティを指定します。 は、大文字と小文字を区別して比較する必要があります。 |
bool |
| subjectBeginsWith | リソース パス プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 この形式は、イベントの発行元によって異なります。 このパスでは、ワイルドカード文字はサポートされていません。 |
文字列 |
| subjectEndsWith | リソース パス サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 このパスでは、ワイルドカード文字はサポートされていません。 |
文字列 |
EventSubscriptionIdentity
| Name | Description | Value |
|---|---|---|
| federatedIdentityCredentialInfo | リソース配信で使用されるフェデレーション ID 資格情報 (FIC) の詳細。 | FederatedIdentityCredentialInfo |
| 型 | 使用されるマネージド ID の種類。 'SystemAssigned' または 'UserAssigned' のいずれかを指定できます。 | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | リソースに関連付けられているユーザー ID。 | 文字列 |
EventSubscriptionProperties
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | イベント サブスクリプションの配信不能の宛先。 配信不能の宛先に配信できないイベントは、配信不能の宛先に送信されます。 Azure Event Grid の ID を使用して、配信/配信不能の間に使用される認証トークンを取得します。 |
DeadLetterDestination |
| deadLetterWithResourceIdentity | イベント サブスクリプションの配信不能の宛先。 配信不能の宛先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。 |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。 |
DeliveryWithResourceIdentity |
| コピー先 | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 Azure Event Grid の ID を使用して、配信/配信不能の間に使用される認証トークンを取得します。 |
EventSubscriptionDestination |
| eventDeliverySchema | イベント サブスクリプションのイベント配信スキーマ。 | 'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema' |
| expirationTimeUtc | イベント サブスクリプションの有効期限。 | 文字列 |
| フィルタ | イベント サブスクリプションのフィルターに関する情報。 | EventSubscriptionFilter |
| labels | ユーザー定義ラベルの一覧。 | string[] |
| retryPolicy | イベントの再試行ポリシー。 これを使用して、イベントの配信試行の最大数と有効期間を構成できます。 | RetryPolicy |
FederatedIdentityCredentialInfo
| Name | Description | Value |
|---|---|---|
| federatedClientId | フェデレーション ID 資格情報 (FIC) が関連付けられているマルチテナント Microsoft Entra ID アプリケーション。 | string Constraints: 最小長 = 36 最大長 = 36 パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (必須) |
HybridConnectionEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'HybridConnection' (必須) |
| properties | イベント サブスクリプションの送信先のハイブリッド接続プロパティ。 | HybridConnectionEventSubscriptionDestinationProperties |
HybridConnectionEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| resourceId | イベント サブスクリプションの宛先であるハイブリッド接続の Azure リソース ID。 | 文字列 |
IsNotNullAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'IsNotNull' (必須) |
IsNullOrUndefinedAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'IsNullOrUndefined' (必須) |
MonitorAlertEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'MonitorAlert' (必須) |
| properties | イベント サブスクリプションの送信先のアラート プロパティを監視します。 | MonitorAlertEventSubscriptionDestinationProperties |
MonitorAlertEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| actionGroups | このイベント サブスクリプションを通じて発生したすべてのアラートでトリガーされるアクション グループの ARM ID の一覧。 各リソース ARM ID は、/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName} というパターンに従う必要があります。 |
string[] |
| description | このイベント サブスクリプションを通じて発生したすべてのアラートにアタッチされる説明。 | 文字列 |
| severity | このイベント サブスクリプションを通じて発生したすべてのアラートにアタッチされる重大度。 このフィールドは指定する必要があります。 |
'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4' |
NamespaceTopicEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'NamespaceTopic' (必須) |
| properties | イベント サブスクリプションの送信先の名前空間トピックのプロパティ。 | NamespaceTopicEventSubscriptionDestinationProperties |
NamespaceTopicEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| resourceId | イベント サブスクリプションの Event Grid 名前空間トピックの宛先のエンドポイントを表す Azure リソース ID。 このフィールドは必須であり、一覧表示されている名前空間トピック リソースが既に存在している必要があります。 リソース ARM ID は、/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName} というパターンに従う必要があります。 |
文字列 |
NumberGreaterThanAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThan' (必須) |
| value | フィルター値。 | int |
NumberGreaterThanOrEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThanOrEquals' (必須) |
| value | フィルター値。 | int |
NumberInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberIn' (必須) |
| values | フィルター値のセット。 | int[] |
NumberInRangeAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberInRange' (必須) |
| values | フィルター値のセット。 | int[][] |
NumberLessThanAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThan' (必須) |
| value | フィルター値。 | int |
NumberLessThanOrEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThanOrEquals' (必須) |
| value | フィルター値。 | int |
NumberNotInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberNotIn' (必須) |
| values | フィルター値のセット。 | int[] |
NumberNotInRangeAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'NumberNotInRange' (必須) |
| values | フィルター値のセット。 | int[][] |
PartnerEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'PartnerDestination' (必須) |
| properties | イベント サブスクリプションの送信先のパートナー変換先のプロパティ。 | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| resourceId | イベント サブスクリプションのパートナー宛先のエンドポイントを表す Azure リソース ID。 | 文字列 |
RetryPolicy
| Name | Description | Value |
|---|---|---|
| eventTimeToLiveInMinutes | イベントの Time To Live (分単位)。 | int |
| maxDeliveryAttempts | イベントの配信再試行の最大数。 | int |
ServiceBusQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'ServiceBusQueue' (必須) |
| properties | イベント サブスクリプションの送信先の Service Bus プロパティ。 | ServiceBusQueueEventSubscriptionDestinationProperties |
ServiceBusQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| resourceId | イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。 | 文字列 |
ServiceBusTopicEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'ServiceBusTopic' (必須) |
| properties | イベント サブスクリプションの送信先の Service Bus トピックのプロパティ。 | ServiceBusTopicEventSubscriptionDestinationProperties |
ServiceBusTopicEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| resourceId | イベント サブスクリプションの Service Bus トピックの宛先のエンドポイントを表す Azure リソース ID。 | 文字列 |
StaticDeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| properties | 静的配信属性マッピングのプロパティ。 | StaticDeliveryAttributeMappingProperties |
| 型 | 配信属性またはヘッダー名の種類。 | 'Static' (必須) |
StaticDeliveryAttributeMappingProperties
| Name | Description | Value |
|---|---|---|
| isSecret | 属性に機密情報が含まれているかどうかを示すブール型フラグ。 | bool |
| value | 配信属性の値。 | 文字列 |
StorageBlobDeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | 配信不能宛先のエンドポイントの種類 | 'StorageBlob' (必須) |
| properties | ストレージ BLOB ベースの配信不能宛先のプロパティ | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Name | Description | Value |
|---|---|---|
| blobContainerName | 配信不能イベントの宛先であるストレージ BLOB コンテナーの名前 | 文字列 |
| resourceId | 配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID | 文字列 |
StorageQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'StorageQueue' (必須) |
| properties | イベント サブスクリプションの宛先のストレージ キューのプロパティ。 | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| queueMessageTimeToLiveInSeconds | ストレージ キュー メッセージの有効期間 (秒単位)。 メッセージの Time To Live が Infinite であることを示すために -1 を使用する場合を除き、この値を 0 または負にすることはできません。 | int |
| queueName | イベント サブスクリプションの宛先であるストレージ アカウントのストレージ キューの名前。 | 文字列 |
| resourceId | イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。 | 文字列 |
StringBeginsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringBeginsWith' (必須) |
| values | フィルター値のセット。 | string[] |
StringContainsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringContains' (必須) |
| values | フィルター値のセット。 | string[] |
StringEndsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringEndsWith' (必須) |
| values | フィルター値のセット。 | string[] |
StringInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringIn' (必須) |
| values | フィルター値のセット。 | string[] |
StringNotBeginsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotBeginsWith' (必須) |
| values | フィルター値のセット。 | string[] |
StringNotContainsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotContains' (必須) |
| values | フィルター値のセット。 | string[] |
StringNotEndsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotEndsWith' (必須) |
| values | フィルター値のセット。 | string[] |
StringNotInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の種類 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotIn' (必須) |
| values | フィルター値のセット。 | string[] |
WebHookEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類。 | 'WebHook' (必須) |
| properties | イベント サブスクリプションの送信先の WebHook プロパティ。 | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | Microsoft Entra ID、アプリケーション ID または URI: 配信要求のベアラー トークンとして含まれるアクセス トークンを取得します。 | 文字列 |
| azureActiveDirectoryTenantId | Microsoft Entra ID テナント ID は、配信要求にベアラー トークンとして含まれるアクセス トークンを取得します。 | 文字列 |
| deliveryAttributeMappings | 配信属性の詳細。 | DeliveryAttributeMapping[] |
| endpointUrl | イベント サブスクリプションの送信先のエンドポイントを表す URL。 | string Constraints: 機密値。 セキュリティで保護されたパラメーターとして渡します。 |
| maxEventsPerBatch | バッチあたりのイベントの最大数。 | int |
| minimumTlsVersionAllowed | Webhook エンドポイントでサポートされる必要がある最小 TLS バージョン | '1.0' '1.1' '1.2' |
| preferredBatchSizeInKilobytes | 推奨されるバッチ サイズ (KB 単位)。 | int |
使用例
Terraformサンプル
EventGrid システムトピックイベントサブスクリプションのデプロイの基本的な例。
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westus"
}
locals {
system_topic_name = "${var.resource_name}-st"
storage_account_name = "${var.resource_name}sa01"
queue_name = "${var.resource_name}queue"
event_subscription1_name = "${var.resource_name}-es1"
event_subscription2_name = "${var.resource_name}-es2"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "systemTopic" {
type = "Microsoft.EventGrid/systemTopics@2022-06-15"
parent_id = azapi_resource.resourceGroup.id
name = local.system_topic_name
# For resource group source, system topic location must be global
location = "global"
body = {
properties = {
source = azapi_resource.resourceGroup.id
topicType = "Microsoft.Resources.ResourceGroups"
}
}
}
resource "azapi_resource" "storageAccount" {
type = "Microsoft.Storage/storageAccounts@2023-05-01"
parent_id = azapi_resource.resourceGroup.id
name = local.storage_account_name
location = var.location
body = {
kind = "StorageV2"
properties = {
accessTier = "Hot"
allowBlobPublicAccess = true
allowCrossTenantReplication = false
allowSharedKeyAccess = true
defaultToOAuthAuthentication = false
dnsEndpointType = "Standard"
encryption = {
keySource = "Microsoft.Storage"
services = {
queue = { keyType = "Service" }
table = { keyType = "Service" }
}
}
isHnsEnabled = false
isLocalUserEnabled = true
isNfsV3Enabled = false
isSftpEnabled = false
minimumTlsVersion = "TLS1_2"
networkAcls = {
bypass = "AzureServices"
defaultAction = "Allow"
ipRules = []
resourceAccessRules = []
virtualNetworkRules = []
}
publicNetworkAccess = "Enabled"
supportsHttpsTrafficOnly = true
}
sku = { name = "Standard_LRS" }
}
tags = { environment = "staging" }
}
# Create a queue in the storage account for the event subscription destination
locals { queue_service_id = "${azapi_resource.storageAccount.id}/queueServices/default" }
resource "azapi_resource" "queue" {
type = "Microsoft.Storage/storageAccounts/queueServices/queues@2023-05-01"
parent_id = local.queue_service_id
name = local.queue_name
body = {}
depends_on = [azapi_resource.storageAccount]
}
resource "azapi_resource" "eventSubscription" {
type = "Microsoft.EventGrid/systemTopics/eventSubscriptions@2022-06-15"
parent_id = azapi_resource.systemTopic.id
name = local.event_subscription1_name
body = {
properties = {
deadLetterDestination = null
destination = {
endpointType = "StorageQueue"
properties = {
queueName = local.queue_name
resourceId = azapi_resource.storageAccount.id
}
}
eventDeliverySchema = "EventGridSchema"
filter = {
advancedFilters = [{
key = "subject"
operatorType = "StringBeginsWith"
values = ["foo"]
}]
}
labels = []
}
}
depends_on = [azapi_resource.queue]
}
resource "azapi_resource" "eventSubscription_1" {
type = "Microsoft.EventGrid/systemTopics/eventSubscriptions@2022-06-15"
parent_id = azapi_resource.systemTopic.id
name = local.event_subscription2_name
body = {
properties = {
deadLetterDestination = null
destination = {
endpointType = "StorageQueue"
properties = {
queueName = local.queue_name
resourceId = azapi_resource.storageAccount.id
}
}
eventDeliverySchema = "EventGridSchema"
filter = {
advancedFilters = [{
key = "subject"
operatorType = "StringEndsWith"
values = ["bar"]
}]
}
labels = []
}
}
depends_on = [azapi_resource.queue]
}