共用方式為


Microsoft.EventGrid eventSubscriptions 2018-01-01

Bicep 資源定義

eventSubscriptions 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.EventGrid/eventSubscriptions 資源,請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2018-01-01' = {
  scope: resourceSymbolicName or scope
  name: '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'
  }
}

屬性值

EventHubEventSubscriptionDestination

名字 描述 價值
endpointType 事件訂用帳戶目的地的端點類型 'EventHub' (必要)
性能 事件訂用帳戶目的地的事件中樞屬性 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

名字 描述 價值
resourceId 代表事件訂用帳戶事件中樞目的地端點的 Azure 資源識別碼。 字串

EventSubscriptionDestination

名字 描述 價值
endpointType 針對 eventHubEventSubscriptionDestination類型 設定為 'EventHub'。 針對類型 WebHookEventSubscriptionDestination,設定為 'WebHook'。 'EventHub'
'WebHook' (必要)

EventSubscriptionFilter

名字 描述 價值
includedEventTypes 需要屬於事件訂用帳戶一部分的適用事件類型清單。
如果想要訂閱所有事件類型,則必須將此清單中的字串 「all」 指定為元素。
string[]
isSubjectCaseSensitive 指定篩選條件的 SubjectBeginsWith 和 SubjectEndsWith 屬性
應該以區分大小寫的方式進行比較。
bool
subjectBeginsWith 選擇性字串,可根據資源路徑前置詞篩選事件訂用帳戶的事件。
此格式取決於事件的發行者。
此路徑不支援通配符。
字串
subjectEndsWith 選擇性字串,可根據資源路徑後綴篩選事件訂用帳戶的事件。
此路徑不支援通配符。
字串

EventSubscriptionProperties

名字 描述 價值
目的地 事件訂閱必須傳遞事件目的地的相關信息。 EventSubscriptionDestination
濾波器 事件訂閱篩選的相關信息。 EventSubscriptionFilter
標籤 使用者定義的標籤清單。 string[]

Microsoft.EventGrid/eventSubscriptions

名字 描述 價值
名字 資源名稱 字串 (必要)
性能 事件訂閱的屬性 EventSubscriptionProperties
範圍 在與部署範圍不同的範圍內建立資源時,請使用 。 將此屬性設定為資源的符號名稱,以套用 擴充資源

WebHookEventSubscriptionDestination

名字 描述 價值
endpointType 事件訂用帳戶目的地的端點類型 'WebHook' (必要)
性能 事件訂用帳戶目的地的 WebHook 屬性 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名字 描述 價值
endpointUrl 表示事件訂用帳戶目的地端點的 URL。 字串

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案 描述
建立 Azure 事件方格自定義主題和佇列訂用帳戶 建立 Azure 事件方格自定義主題和服務總線佇列訂用帳戶。 範本最初由 Markus Meyer 撰寫。
建立 Azure 事件方格自定義主題和訂用帳戶 建立 Azure 事件方格自定義主題和 Webhook 訂用帳戶。 範本最初由John Downs 撰寫。

ARM 樣本資源定義

eventSubscriptions 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.EventGrid/eventSubscriptions 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2018-01-01",
  "name": "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"
  }
}

屬性值

EventHubEventSubscriptionDestination

名字 描述 價值
endpointType 事件訂用帳戶目的地的端點類型 'EventHub' (必要)
性能 事件訂用帳戶目的地的事件中樞屬性 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

名字 描述 價值
resourceId 代表事件訂用帳戶事件中樞目的地端點的 Azure 資源識別碼。 字串

EventSubscriptionDestination

名字 描述 價值
endpointType 針對 eventHubEventSubscriptionDestination類型 設定為 'EventHub'。 針對類型 WebHookEventSubscriptionDestination,設定為 'WebHook'。 'EventHub'
'WebHook' (必要)

EventSubscriptionFilter

名字 描述 價值
includedEventTypes 需要屬於事件訂用帳戶一部分的適用事件類型清單。
如果想要訂閱所有事件類型,則必須將此清單中的字串 「all」 指定為元素。
string[]
isSubjectCaseSensitive 指定篩選條件的 SubjectBeginsWith 和 SubjectEndsWith 屬性
應該以區分大小寫的方式進行比較。
bool
subjectBeginsWith 選擇性字串,可根據資源路徑前置詞篩選事件訂用帳戶的事件。
此格式取決於事件的發行者。
此路徑不支援通配符。
字串
subjectEndsWith 選擇性字串,可根據資源路徑後綴篩選事件訂用帳戶的事件。
此路徑不支援通配符。
字串

EventSubscriptionProperties

名字 描述 價值
目的地 事件訂閱必須傳遞事件目的地的相關信息。 EventSubscriptionDestination
濾波器 事件訂閱篩選的相關信息。 EventSubscriptionFilter
標籤 使用者定義的標籤清單。 string[]

Microsoft.EventGrid/eventSubscriptions

名字 描述 價值
apiVersion API 版本 '2018-01-01'
名字 資源名稱 字串 (必要)
性能 事件訂閱的屬性 EventSubscriptionProperties
類型 資源類型 'Microsoft.EventGrid/eventSubscriptions'

WebHookEventSubscriptionDestination

名字 描述 價值
endpointType 事件訂用帳戶目的地的端點類型 'WebHook' (必要)
性能 事件訂用帳戶目的地的 WebHook 屬性 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名字 描述 價值
endpointUrl 表示事件訂用帳戶目的地端點的 URL。 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
建立 Azure 事件方格自定義主題和佇列訂用帳戶

部署至 Azure
建立 Azure 事件方格自定義主題和服務總線佇列訂用帳戶。 範本最初由 Markus Meyer 撰寫。
建立 Azure 事件方格自定義主題和訂用帳戶

部署至 Azure
建立 Azure 事件方格自定義主題和 Webhook 訂用帳戶。 範本最初由John Downs 撰寫。
建立 Azure 事件方格自定義主題訂用帳戶

部署至 Azure
建立 Azure 事件方格自定義主題和服務總線主題訂用帳戶。 範本最初由 Markus Meyer 撰寫。
建立事件方格自定義主題和事件中樞處理程式

部署至 Azure
建立 Azure 事件方格自定義主題和事件中樞來處理事件。
針對資源事件建立事件方格訂用帳戶

部署至 Azure
建立資源群組或 Azure 訂用帳戶的事件方格訂用帳戶。
使用 CloudEvents 自定義 Azure 事件方格主題/訂用帳戶

部署至 Azure
建立自定義 Azure 事件方格主題、具有 CloudEvents 架構的 Webhook 訂用帳戶,以及邏輯應用程式作為事件處理程式。 範本最初由 Justin Yoo 撰寫。

Terraform (AzAPI 提供者) 資源定義

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"
  }
}

屬性值

EventHubEventSubscriptionDestination

名字 描述 價值
endpointType 事件訂用帳戶目的地的端點類型 'EventHub' (必要)
性能 事件訂用帳戶目的地的事件中樞屬性 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

名字 描述 價值
resourceId 代表事件訂用帳戶事件中樞目的地端點的 Azure 資源識別碼。 字串

EventSubscriptionDestination

名字 描述 價值
endpointType 針對 eventHubEventSubscriptionDestination類型 設定為 'EventHub'。 針對類型 WebHookEventSubscriptionDestination,設定為 'WebHook'。 'EventHub'
'WebHook' (必要)

EventSubscriptionFilter

名字 描述 價值
includedEventTypes 需要屬於事件訂用帳戶一部分的適用事件類型清單。
如果想要訂閱所有事件類型,則必須將此清單中的字串 「all」 指定為元素。
string[]
isSubjectCaseSensitive 指定篩選條件的 SubjectBeginsWith 和 SubjectEndsWith 屬性
應該以區分大小寫的方式進行比較。
bool
subjectBeginsWith 選擇性字串,可根據資源路徑前置詞篩選事件訂用帳戶的事件。
此格式取決於事件的發行者。
此路徑不支援通配符。
字串
subjectEndsWith 選擇性字串,可根據資源路徑後綴篩選事件訂用帳戶的事件。
此路徑不支援通配符。
字串

EventSubscriptionProperties

名字 描述 價值
目的地 事件訂閱必須傳遞事件目的地的相關信息。 EventSubscriptionDestination
濾波器 事件訂閱篩選的相關信息。 EventSubscriptionFilter
標籤 使用者定義的標籤清單。 string[]

Microsoft.EventGrid/eventSubscriptions

名字 描述 價值
名字 資源名稱 字串 (必要)
parent_id 要套用此延伸模組資源之資源的標識碼。 字串 (必要)
性能 事件訂閱的屬性 EventSubscriptionProperties
類型 資源類型 “Microsoft.EventGrid/eventSubscriptions@2018-01-01”

WebHookEventSubscriptionDestination

名字 描述 價值
endpointType 事件訂用帳戶目的地的端點類型 'WebHook' (必要)
性能 事件訂用帳戶目的地的 WebHook 屬性 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名字 描述 價值
endpointUrl 表示事件訂用帳戶目的地端點的 URL。 字串