Microsoft.EventGrid eventSubscriptions 2018-01-01
Bicep リソース定義
eventSubscriptions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの プロパティを scope 使用して、このリソースのスコープを設定します。 「Bicep で拡張機能リソースのスコープを設定する」を参照してください。
eventSubscriptions リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventGrid/eventSubscriptions リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2018-01-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
filter: {
includedEventTypes: [
'string'
]
isSubjectCaseSensitive: bool
subjectBeginsWith: 'string'
subjectEndsWith: 'string'
}
labels: [
'string'
]
}
}
EventSubscriptionDestination オブジェクト
endpointType プロパティを設定して、オブジェクトの種類を指定します。
EventHub の場合は、次の値を使用します。
endpointType: 'EventHub'
properties: {
resourceId: 'string'
}
WebHook の場合は、次の値を使用します。
endpointType: 'WebHook'
properties: {
endpointUrl: 'string'
}
プロパティ値
eventSubscriptions
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 | string (必須) 文字制限: 3 から 64 有効な文字: 英数字とハイフン。 |
| scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース Bicep の場合は、このプロパティをリソースのシンボリック名に設定して 、拡張機能リソースを適用します。 |
| properties | イベント サブスクリプションのプロパティ | EventSubscriptionProperties |
EventSubscriptionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| destination | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 | EventSubscriptionDestination |
| filter | イベント サブスクリプションのフィルターに関する情報。 | EventSubscriptionFilter |
| labels | ユーザー定義ラベルの一覧。 | string[] |
EventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | オブジェクトの種類を設定する | EventHub WebHook (必須) |
EventHubEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの宛先のエンドポイントの種類 | 'EventHub' (必須) |
| properties | イベント サブスクリプションの送信先のイベント ハブのプロパティ | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| resourceId | イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。 | string |
WebHookEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの宛先のエンドポイントの種類 | 'WebHook' (必須) |
| properties | イベント サブスクリプションの送信先の WebHook プロパティ | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| endpointUrl | イベント サブスクリプションの送信先のエンドポイントを表す URL。 | string |
EventSubscriptionFilter
| 名前 | 説明 | 値 |
|---|---|---|
| includedEventTypes | イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 すべてのイベントの種類をサブスクライブする場合は、文字列 "all" をこのリストの要素として指定する必要があります。 |
string[] |
| isSubjectCaseSensitive | フィルターの SubjectBeginsWith プロパティと SubjectEndsWith プロパティを指定します。 は、大文字と小文字を区別して比較する必要があります。 |
[bool] |
| subjectBeginsWith | リソース パス プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 この形式は、イベントの発行元によって異なります。 ワイルドカード文字は、このパスではサポートされていません。 |
string |
| subjectEndsWith | リソース パス サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字は、このパスではサポートされていません。 |
string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| 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 によって作成されました。 |
ARM テンプレート リソース定義
eventSubscriptions リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。
このリソースの プロパティを scope 使用して、このリソースのスコープを設定します。 「ARM テンプレートで拡張機能リソースのスコープを設定する」を参照してください。
eventSubscriptions リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventGrid/eventSubscriptions リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.EventGrid/eventSubscriptions",
"apiVersion": "2018-01-01",
"name": "string",
"scope": "string",
"properties": {
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"filter": {
"includedEventTypes": [ "string" ],
"isSubjectCaseSensitive": "bool",
"subjectBeginsWith": "string",
"subjectEndsWith": "string"
},
"labels": [ "string" ]
}
}
EventSubscriptionDestination オブジェクト
endpointType プロパティを設定して、オブジェクトの種類を指定します。
EventHub の場合は、次の値を使用します。
"endpointType": "EventHub",
"properties": {
"resourceId": "string"
}
WebHook の場合は、次の値を使用します。
"endpointType": "WebHook",
"properties": {
"endpointUrl": "string"
}
プロパティ値
eventSubscriptions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.EventGrid/eventSubscriptions' |
| apiVersion | リソース API のバージョン | '2018-01-01' |
| name | リソース名 | string (必須) 文字制限: 3 から 64 有効な文字: 英数字とハイフン。 |
| scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース JSON の場合は、拡張リソースを適用するリソースの完全な名前に値を設定 します 。 |
| properties | イベント サブスクリプションのプロパティ | EventSubscriptionProperties |
EventSubscriptionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| destination | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 | EventSubscriptionDestination |
| filter | イベント サブスクリプションのフィルターに関する情報。 | EventSubscriptionFilter |
| labels | ユーザー定義ラベルの一覧。 | string[] |
EventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | オブジェクトの種類を設定する | EventHub WebHook (必須) |
EventHubEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの宛先のエンドポイントの種類 | 'EventHub' (必須) |
| properties | イベント サブスクリプションの送信先のイベント ハブのプロパティ | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| resourceId | イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。 | string |
WebHookEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの宛先のエンドポイントの種類 | 'WebHook' (必須) |
| properties | イベント サブスクリプションの送信先の WebHook プロパティ | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| endpointUrl | イベント サブスクリプションの送信先のエンドポイントを表す URL。 | string |
EventSubscriptionFilter
| 名前 | 説明 | 値 |
|---|---|---|
| includedEventTypes | イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 すべてのイベントの種類をサブスクライブする場合は、文字列 "all" をこのリストの要素として指定する必要があります。 |
string[] |
| isSubjectCaseSensitive | フィルターの SubjectBeginsWith プロパティと SubjectEndsWith プロパティを指定します。 は、大文字と小文字を区別して比較する必要があります。 |
[bool] |
| subjectBeginsWith | リソース パス プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 この形式は、イベントの発行元によって異なります。 ワイルドカード文字は、このパスではサポートされていません。 |
string |
| subjectEndsWith | リソース パス サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字は、このパスではサポートされていません。 |
string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| 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@2018-01-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
filter = {
includedEventTypes = [
"string"
]
isSubjectCaseSensitive = bool
subjectBeginsWith = "string"
subjectEndsWith = "string"
}
labels = [
"string"
]
}
})
}
EventSubscriptionDestination オブジェクト
endpointType プロパティを設定して、オブジェクトの種類を指定します。
EventHub の場合は、次の値を使用します。
endpointType = "EventHub"
properties = {
resourceId = "string"
}
WebHook の場合は、次の値を使用します。
endpointType = "WebHook"
properties = {
endpointUrl = "string"
}
プロパティ値
eventSubscriptions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.EventGrid/eventSubscriptions@2018-01-01" |
| name | リソース名 | string (必須) 文字数制限: 3 から 64 有効な文字: 英数字とハイフン。 |
| parent_id | この拡張機能リソースを適用するリソースの ID。 | string (必須) |
| properties | イベント サブスクリプションのプロパティ | EventSubscriptionProperties |
EventSubscriptionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| destination | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 | EventSubscriptionDestination |
| filter | イベント サブスクリプションのフィルターに関する情報。 | EventSubscriptionFilter |
| labels | ユーザー定義ラベルの一覧。 | string[] |
EventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | オブジェクトの種類を設定する | EventHub WebHook (必須) |
EventHubEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類 | "EventHub" (必須) |
| properties | イベント サブスクリプションの送信先のイベント ハブのプロパティ | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| resourceId | イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。 | string |
WebHookEventSubscriptionDestination
| 名前 | 説明 | 値 |
|---|---|---|
| endpointType | イベント サブスクリプションの送信先のエンドポイントの種類 | "WebHook" (必須) |
| properties | イベント サブスクリプションの宛先の WebHook プロパティ | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| 名前 | 説明 | 値 |
|---|---|---|
| endpointUrl | イベント サブスクリプションの送信先のエンドポイントを表す URL。 | string |
EventSubscriptionFilter
| 名前 | 説明 | 値 |
|---|---|---|
| includedEventTypes | イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 すべてのイベントの種類をサブスクライブする場合は、この一覧の要素として文字列 "all" を指定する必要があります。 |
string[] |
| isSubjectCaseSensitive | フィルターの SubjectBeginsWith プロパティと SubjectEndsWith プロパティを指定します は、大文字と小文字を区別して比較する必要があります。 |
[bool] |
| subjectBeginsWith | リソース パス プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 この形式は、イベントの発行元によって異なります。 ワイルドカード文字は、このパスではサポートされていません。 |
string |
| subjectEndsWith | リソース パス サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 ワイルドカード文字は、このパスではサポートされていません。 |
string |