Microsoft.EventGrid eventSubscriptions 2019-06-01
Bicep リソース定義
eventSubscriptions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの プロパティを scope 使用して、このリソースのスコープを設定します。 「Bicep で拡張機能リソースのスコープを設定する」を参照してください。
eventSubscriptions リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventGrid/eventSubscriptions リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2019-06-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
expirationTimeUtc: 'string'
filter: {
advancedFilters: [
{
key: 'string'
operatorType: 'string'
// For remaining properties, see AdvancedFilter objects
}
]
includedEventTypes: [
'string'
]
isSubjectCaseSensitive: bool
subjectBeginsWith: 'string'
subjectEndsWith: 'string'
}
labels: [
'string'
]
retryPolicy: {
eventTimeToLiveInMinutes: int
maxDeliveryAttempts: int
}
}
}
DeadLetterDestination オブジェクト
endpointType プロパティを設定して、オブジェクトの種類を指定します。
StorageBlob の場合は、次の値を使用します。
endpointType: 'StorageBlob'
properties: {
blobContainerName: 'string'
resourceId: 'string'
}
EventSubscriptionDestination オブジェクト
endpointType プロパティを設定して、オブジェクトの種類を指定します。
EventHub の場合は、次の値を使用します。
endpointType: 'EventHub'
properties: {
resourceId: 'string'
}
HybridConnection の場合は、次の値を使用します。
endpointType: 'HybridConnection'
properties: {
resourceId: 'string'
}
ServiceBusQueue の場合は、次の値を使用します。
endpointType: 'ServiceBusQueue'
properties: {
resourceId: 'string'
}
StorageQueue の場合は、次の値を使用します。
endpointType: 'StorageQueue'
properties: {
queueName: 'string'
resourceId: 'string'
}
WebHook の場合は、次の値を使用します。
endpointType: 'WebHook'
properties: {
endpointUrl: 'string'
}
AdvancedFilter オブジェクト
オブジェクトの種類を指定するには、 operatorType プロパティを設定します。
BoolEquals の場合は、次の値を使用します。
operatorType: 'BoolEquals'
value: bool
NumberGreaterThan の場合は、次の値を使用します。
operatorType: 'NumberGreaterThan'
value: int
NumberGreaterThanOrEquals の場合は、次の値を使用します。
operatorType: 'NumberGreaterThanOrEquals'
value: int
NumberIn の場合は、次の値を使用します。
operatorType: 'NumberIn'
values: [
int
]
NumberLessThan の場合は、次の値を使用します。
operatorType: 'NumberLessThan'
value: int
NumberLessThanOrEquals の場合は、次の値を使用します。
operatorType: 'NumberLessThanOrEquals'
value: int
NumberNotIn の場合は、次の値を使用します。
operatorType: 'NumberNotIn'
values: [
int
]
StringBeginsWith の場合は、次の値を使用します。
operatorType: 'StringBeginsWith'
values: [
'string'
]
StringContains の場合は、次の値を使用します。
operatorType: 'StringContains'
values: [
'string'
]
StringEndsWith の場合は、次の値を使用します。
operatorType: 'StringEndsWith'
values: [
'string'
]
StringIn の場合は、次の値を使用します。
operatorType: 'StringIn'
values: [
'string'
]
StringNotIn の場合は、次の値を使用します。
operatorType: 'StringNotIn'
values: [
'string'
]
プロパティ値
eventSubscriptions
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 | string (必須) 文字制限: 3 から 64 有効な文字: 英数字とハイフン。 |
| scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース Bicep の場合は、このプロパティをリソースのシンボリック名に設定して 、拡張機能リソースを適用します。 |
| properties | イベント サブスクリプションのプロパティ | EventSubscriptionProperties |
EventSubscriptionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| deadLetterDestination | イベント サブスクリプションの DeadLetter 変換先。 | DeadLetterDestination |
| destination | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 | EventSubscriptionDestination |
| expirationTimeUtc | イベント サブスクリプションの有効期限。 | string |
| filter | イベント サブスクリプションのフィルターに関する情報。 | EventSubscriptionFilter |
| labels | ユーザー定義ラベルの一覧。 | string[] |
| retryPolicy | イベントの再試行ポリシー。 これは、イベントの配信試行の最大数と有効期間を構成するために使用できます。 | RetryPolicy |
DeadLetterDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | オブジェクトの種類を設定する | StorageBlob (必須) |
StorageBlobDeadLetterDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | 配信不能の宛先のエンドポイントの種類 | 'StorageBlob' (必須) |
| properties | ストレージ BLOB ベースの配信不能宛先のプロパティ | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| blobContainerName | 配信不能イベントの送信先であるストレージ BLOB コンテナーの名前 | string |
| resourceId | 配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID | string |
EventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | オブジェクトの種類を設定する | EventHub HybridConnection ServiceBusQueue StorageQueue WebHook (必須) |
EventHubEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類 | 'EventHub' (必須) |
| properties | イベント サブスクリプションの送信先のイベント ハブのプロパティ | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| resourceId | イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。 | string |
HybridConnectionEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類 | 'HybridConnection' (必須) |
| properties | イベント サブスクリプションの送信先のハイブリッド接続プロパティ | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| 名前 | 説明 | 値 |
|---|---|---|
| resourceId | イベント サブスクリプションの送信先であるハイブリッド接続の Azure リソース ID。 | string |
ServiceBusQueueEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類 | 'ServiceBusQueue' (必須) |
| properties | イベント サブスクリプションの送信先の Service Bus プロパティ | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
| 名前 | 説明 | 値 |
|---|---|---|
| resourceId | イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。 | string |
StorageQueueEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類 | 'StorageQueue' (必須) |
| properties | イベント サブスクリプションの送信先のストレージ キューのプロパティ | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| queueName | イベント サブスクリプションの宛先であるストレージ アカウントのストレージ キューの名前。 | string |
| resourceId | イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。 | string |
WebHookEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの宛先のエンドポイントの種類 | 'WebHook' (必須) |
| properties | イベント サブスクリプションの送信先の WebHook プロパティ | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| endpointUrl | イベント サブスクリプションの送信先のエンドポイントを表す URL。 | string |
EventSubscriptionFilter
| 名前 | 説明 | 値 |
|---|---|---|
| advancedFilters | イベント サブスクリプションのフィルター処理に使用される高度なフィルターの配列。 | AdvancedFilter[] |
| includedEventTypes | イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 既定のすべてのイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。 | string[] |
| isSubjectCaseSensitive | フィルターの SubjectBeginsWith プロパティと SubjectEndsWith プロパティを指定します。 は、大文字と小文字を区別して比較する必要があります。 |
[bool] |
| subjectBeginsWith | リソース パス プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 この形式は、イベントの発行元によって異なります。 ワイルドカード文字は、このパスではサポートされていません。 |
string |
| subjectEndsWith | リソース パス サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字は、このパスではサポートされていません。 |
string |
AdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| キー | フィルター処理するイベントのフィールド/プロパティ。 | string |
| operatorType | オブジェクトの種類を設定する | BoolEquals です。 NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberLessThan NumberLessThanOrEquals NumberNotIn StringBeginsWith StringContains StringEndsWith StringIn StringNotIn (必須) |
BoolEqualsAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'BoolEquals' (必須) |
| value | ブール値フィルター値。 | [bool] |
NumberGreaterThanAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThan' (必須) |
| value | フィルター値。 | INT |
NumberGreaterThanOrEqualsAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThanOrEquals' (必須) |
| value | フィルター値。 | INT |
NumberInAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberIn' (必須) |
| 値 | フィルター値のセット。 | int[] |
NumberLessThanAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThan' (必須) |
| value | フィルター値。 | INT |
NumberLessThanOrEqualsAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThanOrEquals' (必須) |
| value | フィルター値。 | INT |
NumberNotInAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberNotIn' (必須) |
| 値 | フィルター値のセット。 | int[] |
StringBeginsWithAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringBeginsWith' (必須) |
| 値 | フィルター値のセット。 | string[] |
StringContainsAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringContains' (必須) |
| 値 | フィルター値のセット。 | string[] |
StringEndsWithAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringEndsWith' (必須) |
| 値 | フィルター値のセット。 | string[] |
StringInAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringIn' (必須) |
| 値 | フィルター値のセット。 | string[] |
StringNotInAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotIn' (必須) |
| 値 | フィルター値のセット。 | string[] |
RetryPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| eventTimeToLiveInMinutes | イベントの Time To Live (分単位)。 | INT |
| maxDeliveryAttempts | イベントの配信再試行の最大数。 | INT |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
カスタム トピックとサブスクリプションAzure Event Grid作成する |
Azure Event Gridカスタム トピックと webhook サブスクリプションを作成します。 もともとジョンダウンズによって作成されたテンプレート。 |
| CloudEvents を使用したカスタム Azure Event Grid トピック/サブスクリプション |
カスタム Azure Event Grid トピック、CloudEvents スキーマを持つ Webhook サブスクリプション、およびイベント ハンドラーとしてのロジック アプリを作成します。 元は Justin Yoo によって作成されたテンプレートです。 |
| Event Grid カスタム トピックとイベント ハブ ハンドラーを作成する |
イベントを処理Azure Event Gridカスタム トピックとイベント ハブを作成します。 |
| リソース イベントの Event Grid サブスクリプションを作成する |
リソース グループまたは Azure サブスクリプションのいずれかに Event Grid サブスクリプションを作成します。 |
| カスタム トピックとキュー サブスクリプションAzure Event Grid作成する |
Azure Event Gridカスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。 |
| カスタム トピック サブスクリプションAzure Event Grid作成する |
Azure Event Gridカスタム トピックと Service Bus トピック サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。 |
ARM テンプレート リソース定義
eventSubscriptions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの スコープを scope 設定するには、このリソースの プロパティを使用します。 「ARM テンプレートで拡張機能リソースのスコープを設定する」を参照してください。
eventSubscriptions リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventGrid/eventSubscriptions リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.EventGrid/eventSubscriptions",
"apiVersion": "2019-06-01",
"name": "string",
"scope": "string",
"properties": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"expirationTimeUtc": "string",
"filter": {
"advancedFilters": [
{
"key": "string",
"operatorType": "string"
// For remaining properties, see AdvancedFilter objects
}
],
"includedEventTypes": [ "string" ],
"isSubjectCaseSensitive": "bool",
"subjectBeginsWith": "string",
"subjectEndsWith": "string"
},
"labels": [ "string" ],
"retryPolicy": {
"eventTimeToLiveInMinutes": "int",
"maxDeliveryAttempts": "int"
}
}
}
DeadLetterDestination オブジェクト
endpointType プロパティを設定して、オブジェクトの種類を指定します。
StorageBlob の場合は、次の値を使用します。
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "string",
"resourceId": "string"
}
EventSubscriptionDestination オブジェクト
endpointType プロパティを設定して、オブジェクトの種類を指定します。
EventHub の場合は、次の値を使用します。
"endpointType": "EventHub",
"properties": {
"resourceId": "string"
}
HybridConnection の場合は、次の値を使用します。
"endpointType": "HybridConnection",
"properties": {
"resourceId": "string"
}
ServiceBusQueue の場合は、次の値を使用します。
"endpointType": "ServiceBusQueue",
"properties": {
"resourceId": "string"
}
StorageQueue の場合は、次の値を使用します。
"endpointType": "StorageQueue",
"properties": {
"queueName": "string",
"resourceId": "string"
}
WebHook の場合は、次の値を使用します。
"endpointType": "WebHook",
"properties": {
"endpointUrl": "string"
}
AdvancedFilter オブジェクト
オブジェクトの種類を指定するには、 operatorType プロパティを設定します。
BoolEquals の場合は、次の値を使用します。
"operatorType": "BoolEquals",
"value": "bool"
NumberGreaterThan の場合は、次の値を使用します。
"operatorType": "NumberGreaterThan",
"value": "int"
NumberGreaterThanOrEquals の場合は、次の値を使用します。
"operatorType": "NumberGreaterThanOrEquals",
"value": "int"
NumberIn の場合は、次の値を使用します。
"operatorType": "NumberIn",
"values": [ "int" ]
NumberLessThan の場合は、次の値を使用します。
"operatorType": "NumberLessThan",
"value": "int"
NumberLessThanOrEquals の場合は、次の値を使用します。
"operatorType": "NumberLessThanOrEquals",
"value": "int"
NumberNotIn の場合は、次の値を使用します。
"operatorType": "NumberNotIn",
"values": [ "int" ]
StringBeginsWith の場合は、次の値を使用します。
"operatorType": "StringBeginsWith",
"values": [ "string" ]
StringContains の場合は、次を使用します。
"operatorType": "StringContains",
"values": [ "string" ]
StringEndsWith の場合は、次の値を使用します。
"operatorType": "StringEndsWith",
"values": [ "string" ]
StringIn の場合は、次の値を使用します。
"operatorType": "StringIn",
"values": [ "string" ]
StringNotIn の場合は、次の値を使用します。
"operatorType": "StringNotIn",
"values": [ "string" ]
プロパティ値
eventSubscriptions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.EventGrid/eventSubscriptions' |
| apiVersion | リソース API のバージョン | '2019-06-01' |
| name | リソース名 | string (必須) 文字数制限: 3 から 64 有効な文字: 英数字とハイフン。 |
| scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース JSON の場合は、 拡張 リソースを適用するリソースの完全な名前に値を設定します。 |
| properties | イベント サブスクリプションのプロパティ | EventSubscriptionProperties |
EventSubscriptionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| deadLetterDestination | イベント サブスクリプションの DeadLetter 変換先。 | DeadLetterDestination |
| destination | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 | EventSubscriptionDestination |
| expirationTimeUtc | イベント サブスクリプションの有効期限。 | string |
| filter | イベント サブスクリプションのフィルターに関する情報。 | EventSubscriptionFilter |
| labels | ユーザー定義ラベルの一覧。 | string[] |
| retryPolicy | イベントの再試行ポリシー。 これは、イベントの配信試行の最大数と有効期間を構成するために使用できます。 | RetryPolicy |
DeadLetterDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | オブジェクトの種類を設定する | StorageBlob (必須) |
StorageBlobDeadLetterDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | 配信不能の宛先のエンドポイントの種類 | 'StorageBlob' (必須) |
| properties | ストレージ BLOB ベースの配信不能宛先のプロパティ | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| blobContainerName | 配信不能イベントの宛先であるストレージ BLOB コンテナーの名前 | string |
| resourceId | 配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID | string |
EventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | オブジェクトの種類を設定する | EventHub HybridConnection ServiceBusQueue StorageQueue WebHook (必須) |
EventHubEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの宛先のエンドポイントの種類 | 'EventHub' (必須) |
| properties | イベント サブスクリプションの送信先のイベント ハブのプロパティ | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| resourceId | イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。 | string |
HybridConnectionEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの宛先のエンドポイントの種類 | 'HybridConnection' (必須) |
| properties | イベント サブスクリプションの送信先のハイブリッド接続のプロパティ | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| 名前 | 説明 | 値 |
|---|---|---|
| resourceId | イベント サブスクリプションの宛先であるハイブリッド接続の Azure リソース ID。 | string |
ServiceBusQueueEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの宛先のエンドポイントの種類 | 'ServiceBusQueue' (必須) |
| properties | イベント サブスクリプションの宛先の Service Bus プロパティ | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
| 名前 | 説明 | 値 |
|---|---|---|
| resourceId | イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。 | string |
StorageQueueEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの宛先のエンドポイントの種類 | 'StorageQueue' (必須) |
| properties | イベント サブスクリプションの宛先のストレージ キューのプロパティ | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| queueName | イベント サブスクリプションの宛先であるストレージ アカウントのストレージ キューの名前。 | string |
| resourceId | イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。 | string |
WebHookEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの宛先のエンドポイントの種類 | 'WebHook' (必須) |
| properties | イベント サブスクリプションの送信先の WebHook プロパティ | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| endpointUrl | イベント サブスクリプションの送信先のエンドポイントを表す URL。 | string |
EventSubscriptionFilter
| 名前 | 説明 | 値 |
|---|---|---|
| advancedFilters | イベント サブスクリプションのフィルター処理に使用される高度なフィルターの配列。 | AdvancedFilter[] |
| includedEventTypes | イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 既定のすべてのイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。 | string[] |
| isSubjectCaseSensitive | フィルターの SubjectBeginsWith プロパティと SubjectEndsWith プロパティを指定します。 は、大文字と小文字を区別して比較する必要があります。 |
[bool] |
| subjectBeginsWith | リソース パス プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 この形式は、イベントの発行元によって異なります。 ワイルドカード文字は、このパスではサポートされていません。 |
string |
| subjectEndsWith | リソース パス サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字は、このパスではサポートされていません。 |
string |
AdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| キー | フィルター処理するイベントのフィールド/プロパティ。 | string |
| operatorType | オブジェクトの種類を設定する | BoolEquals です。 NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberLessThan NumberLessThanOrEquals NumberNotIn StringBeginsWith StringContains StringEndsWith StringIn StringNotIn (必須) |
BoolEqualsAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'BoolEquals' (必須) |
| value | ブール値フィルター値。 | [bool] |
NumberGreaterThanAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThan' (必須) |
| value | フィルター値。 | INT |
NumberGreaterThanOrEqualsAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThanOrEquals' (必須) |
| value | フィルター値。 | INT |
NumberInAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberIn' (必須) |
| 値 | フィルター値のセット。 | int[] |
NumberLessThanAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThan' (必須) |
| value | フィルター値。 | INT |
NumberLessThanOrEqualsAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThanOrEquals' (必須) |
| value | フィルター値。 | INT |
NumberNotInAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberNotIn' (必須) |
| 値 | フィルター値のセット。 | int[] |
StringBeginsWithAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringBeginsWith' (必須) |
| 値 | フィルター値のセット。 | string[] |
StringContainsAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringContains' (必須) |
| 値 | フィルター値のセット。 | string[] |
StringEndsWithAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringEndsWith' (必須) |
| 値 | フィルター値のセット。 | string[] |
StringInAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringIn' (必須) |
| 値 | フィルター値のセット。 | string[] |
StringNotInAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotIn' (必須) |
| 値 | フィルター値のセット。 | string[] |
RetryPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| eventTimeToLiveInMinutes | イベントの Time To Live (分単位)。 | INT |
| maxDeliveryAttempts | イベントの配信再試行の最大数。 | INT |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
| カスタム トピックとサブスクリプションAzure Event Grid作成する |
Azure Event Gridカスタム トピックと Webhook サブスクリプションを作成します。 最初に John Downs によって作成されたテンプレート。 |
| CloudEvents を使用したカスタム Azure Event Grid トピック/サブスクリプション |
カスタム Azure Event Grid トピック、CloudEvents スキーマを持つ Webhook サブスクリプション、およびイベント ハンドラーとしてのロジック アプリを作成します。 テンプレートは、もともと Justin Yoo によって作成されました。 |
| Event Grid カスタム トピックとイベント ハブ ハンドラーを作成する |
イベントを処理Azure Event Gridカスタム トピックとイベント ハブを作成します。 |
| リソース イベントの Event Grid サブスクリプションを作成する |
リソース グループまたは Azure サブスクリプションのいずれかに Event Grid サブスクリプションを作成します。 |
| カスタム トピックとキュー サブスクリプションAzure Event Grid作成する |
Azure Event Gridカスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートは、もともと Markus Meyer によって作成されました。 |
| カスタム トピック サブスクリプションAzure Event Grid作成する |
Azure Event Gridカスタム トピックと Service Bus トピック サブスクリプションを作成します。 テンプレートは、もともと Markus Meyer によって作成されました。 |
Terraform (AzAPI プロバイダー) リソース定義
eventSubscriptions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの プロパティを parent_id 使用して、このリソースのスコープを設定します。
eventSubscriptions リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループ
- サブスクリプション
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventGrid/eventSubscriptions リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/eventSubscriptions@2019-06-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
expirationTimeUtc = "string"
filter = {
advancedFilters = [
{
key = "string"
operatorType = "string"
// For remaining properties, see AdvancedFilter objects
}
]
includedEventTypes = [
"string"
]
isSubjectCaseSensitive = bool
subjectBeginsWith = "string"
subjectEndsWith = "string"
}
labels = [
"string"
]
retryPolicy = {
eventTimeToLiveInMinutes = int
maxDeliveryAttempts = int
}
}
})
}
DeadLetterDestination オブジェクト
endpointType プロパティを設定して、オブジェクトの種類を指定します。
StorageBlob の場合は、次の値を使用します。
endpointType = "StorageBlob"
properties = {
blobContainerName = "string"
resourceId = "string"
}
EventSubscriptionDestination オブジェクト
endpointType プロパティを設定して、オブジェクトの種類を指定します。
EventHub の場合は、次の値を使用します。
endpointType = "EventHub"
properties = {
resourceId = "string"
}
HybridConnection の場合は、次の値を使用します。
endpointType = "HybridConnection"
properties = {
resourceId = "string"
}
ServiceBusQueue の場合は、次の値を使用します。
endpointType = "ServiceBusQueue"
properties = {
resourceId = "string"
}
StorageQueue の場合は、次の値を使用します。
endpointType = "StorageQueue"
properties = {
queueName = "string"
resourceId = "string"
}
WebHook の場合は、次の値を使用します。
endpointType = "WebHook"
properties = {
endpointUrl = "string"
}
AdvancedFilter オブジェクト
オブジェクトの種類を指定するには、 operatorType プロパティを設定します。
BoolEquals の場合は、次の値を使用します。
operatorType = "BoolEquals"
value = bool
NumberGreaterThan の場合は、次の値を使用します。
operatorType = "NumberGreaterThan"
value = int
NumberGreaterThanOrEquals の場合は、次の値を使用します。
operatorType = "NumberGreaterThanOrEquals"
value = int
NumberIn の場合は、次の値を使用します。
operatorType = "NumberIn"
values = [
int
]
NumberLessThan の場合は、次の値を使用します。
operatorType = "NumberLessThan"
value = int
NumberLessThanOrEquals の場合は、次の値を使用します。
operatorType = "NumberLessThanOrEquals"
value = int
NumberNotIn の場合は、次の値を使用します。
operatorType = "NumberNotIn"
values = [
int
]
StringBeginsWith の場合は、次の値を使用します。
operatorType = "StringBeginsWith"
values = [
"string"
]
StringContains の場合は、次の値を使用します。
operatorType = "StringContains"
values = [
"string"
]
StringEndsWith の場合は、次の値を使用します。
operatorType = "StringEndsWith"
values = [
"string"
]
StringIn の場合は、次の値を使用します。
operatorType = "StringIn"
values = [
"string"
]
StringNotIn の場合は、次の値を使用します。
operatorType = "StringNotIn"
values = [
"string"
]
プロパティ値
eventSubscriptions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.EventGrid/eventSubscriptions@2019-06-01" |
| name | リソース名 | string (必須) 文字制限: 3 から 64 有効な文字: 英数字とハイフン。 |
| parent_id | この拡張機能リソースを適用するリソースの ID。 | string (必須) |
| properties | イベント サブスクリプションのプロパティ | EventSubscriptionProperties |
EventSubscriptionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| deadLetterDestination | イベント サブスクリプションの DeadLetter 変換先。 | DeadLetterDestination |
| destination | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 | EventSubscriptionDestination |
| expirationTimeUtc | イベント サブスクリプションの有効期限。 | string |
| filter | イベント サブスクリプションのフィルターに関する情報。 | EventSubscriptionFilter |
| labels | ユーザー定義ラベルの一覧。 | string[] |
| retryPolicy | イベントの再試行ポリシー。 これは、配信試行の最大数とイベントの有効期間を構成するために使用できます。 | RetryPolicy |
DeadLetterDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | オブジェクトの種類を設定する | StorageBlob (必須) |
StorageBlobDeadLetterDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | 配信不能の宛先のエンドポイントの種類 | "StorageBlob" (必須) |
| properties | ストレージ BLOB ベースの配信不能宛先のプロパティ | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| blobContainerName | 配信不能イベントの送信先であるストレージ BLOB コンテナーの名前 | string |
| resourceId | 配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID | string |
EventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | オブジェクトの種類を設定する | EventHub HybridConnection ServiceBusQueue StorageQueue WebHook (必須) |
EventHubEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類 | "EventHub" (必須) |
| properties | イベント サブスクリプションの送信先のイベント ハブのプロパティ | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| resourceId | イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。 | string |
HybridConnectionEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類 | "HybridConnection" (必須) |
| properties | イベント サブスクリプションの送信先のハイブリッド接続プロパティ | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
| 名前 | 説明 | 値 |
|---|---|---|
| resourceId | イベント サブスクリプションの送信先であるハイブリッド接続の Azure リソース ID。 | string |
ServiceBusQueueEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類 | "ServiceBusQueue" (必須) |
| properties | イベント サブスクリプションの送信先の Service Bus プロパティ | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
| 名前 | 説明 | 値 |
|---|---|---|
| resourceId | イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。 | string |
StorageQueueEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの宛先のエンドポイントの種類 | "StorageQueue" (必須) |
| properties | イベント サブスクリプションの宛先のストレージ キューのプロパティ | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| queueName | イベント サブスクリプションの宛先であるストレージ アカウントのストレージ キューの名前。 | string |
| resourceId | イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。 | string |
WebHookEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの宛先のエンドポイントの種類 | "WebHook" (必須) |
| properties | イベント サブスクリプションの送信先の WebHook プロパティ | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| endpointUrl | イベント サブスクリプションの送信先のエンドポイントを表す URL。 | string |
EventSubscriptionFilter
| 名前 | 説明 | 値 |
|---|---|---|
| advancedFilters | イベント サブスクリプションのフィルター処理に使用される高度なフィルターの配列。 | AdvancedFilter[] |
| includedEventTypes | イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 既定のすべてのイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。 | string[] |
| isSubjectCaseSensitive | フィルターの SubjectBeginsWith プロパティと SubjectEndsWith プロパティを指定します。 は、大文字と小文字を区別して比較する必要があります。 |
[bool] |
| subjectBeginsWith | リソース パス プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 この形式は、イベントの発行元によって異なります。 ワイルドカード文字は、このパスではサポートされていません。 |
string |
| subjectEndsWith | リソース パス サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字は、このパスではサポートされていません。 |
string |
AdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| キー | フィルター処理するイベントのフィールド/プロパティ。 | string |
| operatorType | オブジェクトの種類を設定する | BoolEquals です。 NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberLessThan NumberLessThanOrEquals NumberNotIn StringBeginsWith StringContains StringEndsWith StringIn StringNotIn (必須) |
BoolEqualsAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "BoolEquals" (必須) |
| value | ブール値フィルター値。 | [bool] |
NumberGreaterThanAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberGreaterThan" (必須) |
| value | フィルター値。 | INT |
NumberGreaterThanOrEqualsAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberGreaterThanOrEquals" (必須) |
| value | フィルター値。 | INT |
NumberInAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberIn" (必須) |
| 値 | フィルター値のセット。 | int[] |
NumberLessThanAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberLessThan" (必須) |
| value | フィルター値。 | INT |
NumberLessThanOrEqualsAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberLessThanOrEquals" (必須) |
| value | フィルター値。 | INT |
NumberNotInAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberNotIn" (必須) |
| 値 | フィルター値のセット。 | int[] |
StringBeginsWithAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringBeginsWith" (必須) |
| 値 | フィルター値のセット。 | string[] |
StringContainsAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringContains" (必須) |
| 値 | フィルター値のセット。 | string[] |
StringEndsWithAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringEndsWith" (必須) |
| 値 | フィルター値のセット。 | string[] |
StringInAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringIn" (必須) |
| 値 | フィルター値のセット。 | string[] |
StringNotInAdvancedFilter
| 名前 | 説明 | 値 |
|---|---|---|
| operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringNotIn" (必須) |
| 値 | フィルター値のセット。 | string[] |
RetryPolicy
| 名前 | 説明 | 値 |
|---|---|---|
| eventTimeToLiveInMinutes | イベントの Time To Live (分単位)。 | INT |
| maxDeliveryAttempts | イベントの配信再試行の最大数。 | int |
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示