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 | 資源名稱 | 需要字串 () 字元限制：3-64 合法字元： 英數字元和連字號。 |
| 範圍 | 在與部署範圍不同的範圍內建立擴充資源時，請使用 。 | 目標資源 針對 Bicep，請將此屬性設定為資源的符號名稱，以套用 延伸模組資源。 |
| properties | 事件訂閱的屬性 | EventSubscriptionProperties |
EventSubscriptionProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| 目的地 | 事件訂閱必須傳遞事件之目的地的相關信息。 | EventSubscriptionDestination |
| filter | 事件訂閱篩選的相關信息。 | EventSubscriptionFilter |
| 標籤 | 使用者定義的標籤清單。 | string[] |
EventSubscriptionDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 設定物件類型 | EventHub 需要 WebHook () |
EventHubEventSubscriptionDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 事件訂用帳戶目的地的端點類型 | 需要 『EventHub』 () |
| properties | 事件訂用帳戶目的地的事件中樞屬性 | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| resourceId | Azure 資源識別碼，表示事件訂用帳戶之事件中樞目的地的端點。 | 字串 |
WebHookEventSubscriptionDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 事件訂用帳戶目的地的端點類型 | 需要 『WebHook』 () |
| properties | 事件訂用帳戶目的地的 WebHook 屬性 | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointUrl | URL，表示事件訂用帳戶目的地的端點。 | 字串 |
EventSubscriptionFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| includedEventTypes | 需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有事件類型，則必須將此字串 「all」 指定為此清單中的元素。 |
string[] |
| isSubjectCaseSensitive | 指定 Filter 的 SubjectBeginsWith 和 SubjectEndsWith 屬性是否為 應該以區分大小寫的方式進行比較。 |
bool |
| subjectBeginsWith | 選擇性字串，可根據資源路徑前置詞篩選事件訂閱的事件。 此格式取決於事件的發行者。 此路徑不支援通配符。 |
字串 |
| subjectEndsWith | 選擇性字串，可根據資源路徑後綴篩選事件訂閱的事件。 此路徑不支援通配符。 |
字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
建立自定義主題和訂用帳戶 Azure 事件方格 |
建立 Azure 事件方格 自定義主題和 Webhook 訂用帳戶。 最初由John Downs撰寫的範本。 |
| 使用 CloudEvents 自定義 Azure 事件方格 主題/訂用帳戶 |
建立自定義 Azure 事件方格 主題、具有 CloudEvents 架構的 Webhook 訂用帳戶，以及邏輯應用程式作為事件處理程式。 最初由 Justin Yoo 撰寫的範本。 |
| 建立事件方格自定義主題和事件中樞處理程式 |
建立 Azure 事件方格 自定義主題和事件中樞來處理事件。 |
| 建立資源事件的事件方格訂用帳戶 |
建立資源群組或 Azure 訂用帳戶的事件方格訂用帳戶。 |
| 建立自定義主題和佇列訂用帳戶 Azure 事件方格 |
建立 Azure 事件方格 自定義主題和服務總線佇列訂用帳戶。 最初由 Markus Meyer 撰寫的範本。 |
| 建立自定義主題訂用帳戶 Azure 事件方格 |
建立 Azure 事件方格 自定義主題和服務總線主題訂用帳戶。 最初由 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
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.EventGrid/eventSubscriptions' |
| apiVersion | 資源 API 版本 | '2018-01-01' |
| NAME | 資源名稱 | 字串 (必要) 字元限制：3-64 合法字元： 英數字元和連字號。 |
| 範圍 | 在與部署範圍不同的範圍建立擴充資源時，請使用 。 | 目標資源 針對 JSON，請將值設定為要套用 擴充資源 的資源完整名稱。 |
| properties | 事件訂閱的屬性 | EventSubscriptionProperties |
EventSubscriptionProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| 目的地 | 事件訂閱必須傳遞事件之目的地的相關信息。 | EventSubscriptionDestination |
| filter | 事件訂閱篩選的相關信息。 | EventSubscriptionFilter |
| 標籤 | 使用者定義的標籤清單。 | string[] |
EventSubscriptionDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 設定物件類型 | EventHub 需要 WebHook () |
EventHubEventSubscriptionDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 事件訂用帳戶目的地的端點類型 | 需要 『EventHub』 () |
| properties | 事件訂用帳戶目的地的事件中樞屬性 | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| resourceId | Azure 資源識別碼，表示事件訂用帳戶之事件中樞目的地的端點。 | 字串 |
WebHookEventSubscriptionDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 事件訂用帳戶目的地的端點類型 | 需要 『WebHook』 () |
| properties | 事件訂用帳戶目的地的 WebHook 屬性 | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointUrl | 表示事件訂用帳戶目的地端點的 URL。 | 字串 |
EventSubscriptionFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| includedEventTypes | 需要屬於事件訂閱一部分的適用事件類型清單。 如果想要訂閱所有事件類型，則必須將此清單中的字串 「all」 指定為元素。 |
string[] |
| isSubjectCaseSensitive | 指定 Filter 的 SubjectBeginsWith 和 SubjectEndsWith 屬性 應該以區分大小寫的方式進行比較。 |
bool |
| subjectBeginsWith | 選擇性字串，可根據資源路徑前置詞篩選事件訂閱的事件。 此格式取決於事件的發行者。 此路徑不支援通配符。 |
字串 |
| subjectEndsWith | 選擇性字串，可根據資源路徑後綴篩選事件訂閱的事件。 此路徑不支援通配符。 |
字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
| 建立 Azure 事件方格 自定義主題和訂用帳戶 |
建立 Azure 事件方格 自定義主題和 Webhook 訂用帳戶。 最初由John Downs撰寫的範本。 |
| 使用 CloudEvents 自定義 Azure 事件方格 主題/訂用帳戶 |
建立自定義 Azure 事件方格 主題、具有 CloudEvents 架構的 Webhook 訂用帳戶，以及邏輯應用程式作為事件處理程式。 最初由 Justin Yoo 撰寫的範本。 |
| 建立事件方格自定義主題和事件中樞處理程式 |
建立 Azure 事件方格 自定義主題和事件中樞來處理事件。 |
| 為資源事件建立事件方格訂用帳戶 |
建立資源群組或 Azure 訂用帳戶的事件方格訂用帳戶。 |
| 建立 Azure 事件方格 自定義主題和佇列訂用帳戶 |
建立 Azure 事件方格 自定義主題和服務總線佇列訂用帳戶。 最初由 Markus Meyer 撰寫的範本。 |
| 建立 Azure 事件方格 自定義主題訂用帳戶 |
建立 Azure 事件方格 自定義主題和服務總線主題訂用帳戶。 最初由 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
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.EventGrid/eventSubscriptions@2018-01-01” |
| NAME | 資源名稱 | 字串 (必要) 字元限制：3-64 合法字元： 英數字元和連字號。 |
| parent_id | 要套用此延伸模組資源的資源標識碼。 | 字串 (必要) |
| properties | 事件訂閱的屬性 | EventSubscriptionProperties |
EventSubscriptionProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| 目的地 | 事件訂用帳戶必須傳遞事件之目的地的相關信息。 | EventSubscriptionDestination |
| filter | 事件訂閱篩選的相關信息。 | EventSubscriptionFilter |
| 標籤 | 使用者定義標籤的清單。 | string[] |
EventSubscriptionDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 設定物件類型 | EventHub 需要 WebHook () |
EventHubEventSubscriptionDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 事件訂用帳戶目的地的端點類型 | “EventHub” (必要) |
| properties | 事件訂閱目的地的事件中樞屬性 | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| resourceId | Azure 資源識別碼，表示事件訂用帳戶事件中樞目的地的端點。 | 字串 |
WebHookEventSubscriptionDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 事件訂用帳戶目的地的端點類型 | “WebHook” (必要) |
| properties | 事件訂用帳戶目的地的 WebHook 屬性 | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointUrl | URL，表示事件訂用帳戶目的地的端點。 | 字串 |
EventSubscriptionFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| includedEventTypes | 需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有事件類型，則必須將此字串 「all」 指定為此清單中的元素。 |
string[] |
| isSubjectCaseSensitive | 指定 Filter 的 SubjectBeginsWith 和 SubjectEndsWith 屬性是否為 應該以區分大小寫的方式進行比較。 |
bool |
| subjectBeginsWith | 選擇性字串，可根據資源路徑前置詞篩選事件訂閱的事件。 此格式取決於事件的發行者。 此路徑不支援通配符。 |
字串 |
| subjectEndsWith | 選擇性字串，可根據資源路徑後綴篩選事件訂閱的事件。 此路徑不支援通配符。 |
字串 |