共用方式為

Microsoft.EventGrid eventSubscriptions 2020-06-01

  • 發行項

Bicep 資源定義

eventSubscriptions 資源類型是 擴充資源，這表示您可以將它套用至另一個資源。

scope使用此資源上的 屬性來設定此資源的範圍。 請參閱 在 Bicep 中設定擴充功能資源的範圍。

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

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

資源格式

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2020-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
    }
    eventDeliverySchema: 'string'
    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 屬性以指定物件的類型。

針對 AzureFunction，請使用：

  endpointType: 'AzureFunction'
  properties: {
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
    resourceId: 'string'
  }

針對 EventHub，請使用：

  endpointType: 'EventHub'
  properties: {
    resourceId: 'string'
  }

針對 HybridConnection，請使用：

  endpointType: 'HybridConnection'
  properties: {
    resourceId: 'string'
  }

針對 ServiceBusQueue，請使用：

  endpointType: 'ServiceBusQueue'
  properties: {
    resourceId: 'string'
  }

針對 ServiceBusTopic，請使用：

  endpointType: 'ServiceBusTopic'
  properties: {
    resourceId: 'string'
  }

針對 StorageQueue，請使用：

  endpointType: 'StorageQueue'
  properties: {
    queueName: 'string'
    resourceId: 'string'
  }

針對 WebHook，請使用：

  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    endpointUrl: 'string'
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
  }

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 資源名稱 字串 (必要)

字元限制：3-64

合法字元：
英數字元和連字號。
範圍 在與部署範圍不同的範圍建立擴充資源時，請使用 。 目標資源

針對 Bicep，請將此屬性設定為資源的符號名稱，以套用 延伸模組資源。
properties 事件訂閱的屬性。 EventSubscriptionProperties

EventSubscriptionProperties

名稱 描述 值
deadLetterDestination 事件訂閱的DeadLetter目的地。 DeadLetterDestination
目的地 事件訂用帳戶必須傳遞事件之目的地的相關信息。 EventSubscriptionDestination
eventDeliverySchema 事件訂閱的事件傳遞架構。 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc 事件訂閱的到期時間。 字串
filter 事件訂閱篩選的相關信息。 EventSubscriptionFilter
標籤 使用者定義標籤的清單。 string[]
RetryPolicy 事件的重試原則。 這可用來設定事件的最大傳遞嘗試次數和存留時間。 RetryPolicy

DeadLetterDestination

名稱 描述 值
endpointType 設定物件類型 需要 StorageBlob ()

StorageBlobDeadLetterDestination

名稱 描述 值
endpointType 無效信件目的地的端點類型 'StorageBlob' (必要)
properties 記憶體 Blob 型寄不出的目的地屬性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名稱 描述 值
blobContainerName 記憶體 Blob 容器的名稱，該容器是寄不出的事件目的地 字串
resourceId 記憶體帳戶的 Azure 資源識別符，該帳戶是死信事件目的地 字串

EventSubscriptionDestination

名稱 描述 值
endpointType 設定物件類型 AzureFunction
EventHub
HybridConnection
ServiceBusQueue
ServiceBusTopic
StorageQueue
需要 WebHook ()

AzureFunctionEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 'AzureFunction' (必要)
properties 事件訂用帳戶目的地的 Azure 函式屬性。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名稱 描述 值
maxEventsPerBatch 每個批次的事件數目上限。 int
preferredBatchSizeInKilobytes 慣用的批次大小以 KB 為單位。 int
resourceId Azure 資源標識符，代表事件訂用帳戶之 Azure 函式目的地的端點。 字串

EventHubEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 需要 『EventHub』 ()
properties 事件訂閱目的地的事件中樞屬性。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 'HybridConnection' (必要)
properties 事件訂閱目的地的混合式連線屬性。 HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

名稱 描述 值
resourceId 屬於事件訂用帳戶目的地之混合式連線的 Azure 資源識別碼。 字串

ServiceBusQueueEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 'ServiceBusQueue' (必要)
properties 事件訂用帳戶目的地的服務總線屬性。 ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名稱 描述 值
resourceId Azure 資源識別碼，表示事件訂用帳戶之服務總線目的地的端點。 字串

ServiceBusTopicEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 'ServiceBusTopic' (必要)
properties 事件訂用帳戶目的地的服務總線主題屬性。 ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

名稱 描述 值
resourceId Azure 資源標識碼，表示事件訂用帳戶之服務總線主題目的地的端點。 字串

StorageQueueEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 必要) 'StorageQueue' (
properties 事件訂用帳戶目的地的記憶體佇列屬性。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名稱 描述 值
queueName 記憶體帳戶下記憶體佇列的名稱，該帳戶是事件訂用帳戶的目的地。 字串
resourceId 記憶體帳戶的 Azure 資源識別碼，其中包含事件訂用帳戶目的地的佇列。 字串

WebHookEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 必要的 『WebHook』 ()
properties 事件訂閱目的地的 WebHook 屬性。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名稱 描述 值
azureActiveDirectoryApplicationIdOrUri Azure Active Directory 應用程式識別碼或 URI，以取得將包含在傳遞要求中作為持有人令牌的存取令牌。 字串
azureActiveDirectoryTenantId Azure Active Directory 租使用者識別符，以取得將包含在傳遞要求中作為持有人令牌的存取令牌。 字串
endpointUrl URL，表示事件訂用帳戶目的地的端點。 字串

約束：
敏感性值。 以安全參數的形式傳入。
maxEventsPerBatch 每個批次的事件數目上限。 int
preferredBatchSizeInKilobytes 慣用的批次大小以 KB 為單位。 int

EventSubscriptionFilter

名稱 描述 值
advancedFilters 用於篩選事件訂閱的進階篩選陣列。 AdvancedFilter[]
includedEventTypes 需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有預設事件類型，請將 IncludedEventTypes 設定為 null。 string[]
isSubjectCaseSensitive 指定 Filter 的 SubjectBeginsWith 和 SubjectEndsWith 屬性
應該以區分大小寫的方式進行比較。		 bool
subjectBeginsWith 選擇性字串，可根據資源路徑前置詞篩選事件訂閱的事件。
此格式取決於事件的發行者。
此路徑不支援通配符。		 字串
subjectEndsWith 選擇性字串，可根據資源路徑後綴篩選事件訂閱的事件。
此路徑不支援通配符。
 字串

AdvancedFilter

名稱 描述 值
索引鍵 事件中的欄位/屬性，根據您要篩選的欄位/屬性。 字串
operatorType 設定物件類型 BoolEquals
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
StringBeginsWith
StringContains
StringEndsWith
StringIn
需要 StringNotIn ()

BoolEqualsAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 'BoolEquals' (必要)
值 布爾篩選值。 bool

NumberGreaterThanAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 必要) 'NumberGreaterThan' (
值 篩選值。 int

NumberGreaterThanOrEqualsAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 'NumberGreaterThanOrEquals' (必要)
值 篩選值。 int

NumberInAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 需要 『NumberIn』 ()
值 篩選值集。 int[]

NumberLessThanAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 必要 ('NumberLessThan')
值 篩選值。 int

NumberLessThanOrEqualsAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 'NumberLessThanOrEquals' (必要)
值 篩選值。 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 活動) 分鐘 (存留時間。 int
maxDeliveryAttempts 事件的傳遞重試嘗試次數上限。 int

快速入門範本

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

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

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

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

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

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

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

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

ARM 範本資源定義

eventSubscriptions 資源類型是延伸模組 資源，這表示您可以將它套用至另一個資源。

scope使用此資源上的 屬性來設定此資源的範圍。 請參閱 在ARM範本中設定擴充功能資源的範圍。

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

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

資源格式

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2020-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
    },
    "eventDeliverySchema": "string",
    "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 屬性以指定物件的類型。

針對 AzureFunction，請使用：

  "endpointType": "AzureFunction",
  "properties": {
    "maxEventsPerBatch": "int",
    "preferredBatchSizeInKilobytes": "int",
    "resourceId": "string"
  }

針對 EventHub，請使用：

  "endpointType": "EventHub",
  "properties": {
    "resourceId": "string"
  }

針對 HybridConnection，請使用：

  "endpointType": "HybridConnection",
  "properties": {
    "resourceId": "string"
  }

針對 ServiceBusQueue，請使用：

  "endpointType": "ServiceBusQueue",
  "properties": {
    "resourceId": "string"
  }

針對 ServiceBusTopic，請使用：

  "endpointType": "ServiceBusTopic",
  "properties": {
    "resourceId": "string"
  }

針對 StorageQueue，請使用：

  "endpointType": "StorageQueue",
  "properties": {
    "queueName": "string",
    "resourceId": "string"
  }

針對 WebHook，請使用：

  "endpointType": "WebHook",
  "properties": {
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string",
    "endpointUrl": "string",
    "maxEventsPerBatch": "int",
    "preferredBatchSizeInKilobytes": "int"
  }

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

名稱 描述 值
類型 資源類型 'Microsoft.EventGrid/eventSubscriptions'
apiVersion 資源 API 版本 '2020-06-01'
NAME 資源名稱 需要字串 ()

字元限制：3-64

合法字元：
英數字元和連字號。
範圍 在與部署範圍不同的範圍內建立擴充資源時，請使用 。 目標資源

針對 JSON，請將值設定為要套用 擴充資源 的資源完整名稱。
properties 事件訂閱的屬性。 EventSubscriptionProperties

EventSubscriptionProperties

名稱 描述 值
deadLetterDestination 事件訂閱的DeadLetter目的地。 DeadLetterDestination
目的地 事件訂閱必須傳遞事件之目的地的相關信息。 EventSubscriptionDestination
eventDeliverySchema 事件訂閱的事件傳遞架構。 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc 事件訂閱的到期時間。 字串
filter 事件訂閱篩選的相關信息。 EventSubscriptionFilter
標籤 使用者定義的標籤清單。 string[]
RetryPolicy 事件的重試原則。 這可用來設定事件的最大傳遞嘗試次數和存留時間。 RetryPolicy

DeadLetterDestination

名稱 描述 值
endpointType 設定物件類型 需要 StorageBlob ()

StorageBlobDeadLetterDestination

名稱 描述 值
endpointType 無效信件目的地的端點類型 'StorageBlob' (必要)
properties 記憶體 Blob 型寄不出的目的地屬性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名稱 描述 值
blobContainerName 記憶體 Blob 容器的名稱，該容器是寄不出的事件目的地 字串
resourceId 記憶體帳戶的 Azure 資源識別符，該帳戶是死信事件目的地 字串

EventSubscriptionDestination

名稱 描述 值
endpointType 設定物件類型 AzureFunction
EventHub
HybridConnection
ServiceBusQueue
ServiceBusTopic
StorageQueue
需要 WebHook ()

AzureFunctionEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 'AzureFunction' (必要)
properties 事件訂用帳戶目的地的 Azure 函式屬性。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名稱 描述 值
maxEventsPerBatch 每個批次的事件數目上限。 int
preferredBatchSizeInKilobytes 慣用的批次大小以 KB 為單位。 int
resourceId Azure 資源標識符，代表事件訂用帳戶之 Azure 函式目的地的端點。 字串

EventHubEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 需要 『EventHub』 ()
properties 事件訂閱目的地的事件中樞屬性。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 'HybridConnection' (必要)
properties 事件訂閱目的地的混合式連線屬性。 HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

名稱 描述 值
resourceId 屬於事件訂用帳戶目的地之混合式連線的 Azure 資源識別碼。 字串

ServiceBusQueueEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 'ServiceBusQueue' (必要)
properties 事件訂用帳戶目的地的服務總線屬性。 ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名稱 描述 值
resourceId Azure 資源識別碼，表示事件訂用帳戶之服務總線目的地的端點。 字串

ServiceBusTopicEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 'ServiceBusTopic' (必要)
properties 事件訂用帳戶目的地的服務總線主題屬性。 ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

名稱 描述 值
resourceId Azure 資源標識碼，表示事件訂用帳戶之服務總線主題目的地的端點。 字串

StorageQueueEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 必要) 'StorageQueue' (
properties 事件訂用帳戶目的地的記憶體佇列屬性。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名稱 描述 值
queueName 記憶體帳戶下記憶體佇列的名稱，該帳戶是事件訂用帳戶的目的地。 字串
resourceId 記憶體帳戶的 Azure 資源識別碼，其中包含事件訂用帳戶目的地的佇列。 字串

WebHookEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 必要的 『WebHook』 ()
properties 事件訂閱目的地的 WebHook 屬性。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名稱 描述 值
azureActiveDirectoryApplicationIdOrUri Azure Active Directory 應用程式識別碼或 URI，以取得將包含在傳遞要求中作為持有人令牌的存取令牌。 字串
azureActiveDirectoryTenantId Azure Active Directory 租使用者識別符，以取得將包含在傳遞要求中作為持有人令牌的存取令牌。 字串
endpointUrl URL，表示事件訂用帳戶目的地的端點。 字串

約束：
敏感性值。 以安全參數的形式傳入。
maxEventsPerBatch 每個批次的事件數目上限。 int
preferredBatchSizeInKilobytes 慣用的批次大小以 KB 為單位。 int

EventSubscriptionFilter

名稱 描述 值
advancedFilters 用於篩選事件訂閱的進階篩選陣列。 AdvancedFilter[]
includedEventTypes 需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有預設事件類型，請將 IncludedEventTypes 設定為 null。 string[]
isSubjectCaseSensitive 指定 Filter 的 SubjectBeginsWith 和 SubjectEndsWith 屬性是否為
應該以區分大小寫的方式進行比較。		 bool
subjectBeginsWith 選擇性字串，可根據資源路徑前置詞篩選事件訂閱的事件。
此格式取決於事件的發行者。
此路徑不支援通配符。		 字串
subjectEndsWith 選擇性字串，可根據資源路徑後綴篩選事件訂閱的事件。
此路徑不支援通配符。
 字串

AdvancedFilter

名稱 描述 值
索引鍵 事件中的欄位/屬性，根據您要篩選的欄位/屬性。 字串
operatorType 設定物件類型 BoolEquals
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
StringBeginsWith
StringContains
StringEndsWith
StringIn
需要 StringNotIn ()

BoolEqualsAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 'BoolEquals' (必要)
值 布爾篩選值。 bool

NumberGreaterThanAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 必要) 'NumberGreaterThan' (
值 篩選值。 int

NumberGreaterThanOrEqualsAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 'NumberGreaterThanOrEquals' (必要)
值 篩選值。 int

NumberInAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 'NumberIn' (必要)
值 篩選值集。 int[]

NumberLessThanAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 必要 ('NumberLessThan')
值 篩選值。 int

NumberLessThanOrEqualsAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 必要) 'NumberLessThanOrEquals' (
值 篩選值。 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 活動) 分鐘 (存留時間。 int
maxDeliveryAttempts 事件的傳遞重試嘗試次數上限。 int

快速入門範本

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

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

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

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

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

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

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

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

Terraform (AzAPI 提供者) 資源定義

eventSubscriptions 資源類型是延伸模組 資源，這表示您可以將它套用至另一個資源。

parent_id使用此資源上的 屬性來設定此資源的範圍。

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

  • 資源群組
  • 訂用帳戶

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2020-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
      }
      eventDeliverySchema = "string"
      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 屬性以指定物件的類型。

針對 AzureFunction，請使用：

  endpointType = "AzureFunction"
  properties = {
    maxEventsPerBatch = int
    preferredBatchSizeInKilobytes = int
    resourceId = "string"
  }

針對 EventHub，請使用：

  endpointType = "EventHub"
  properties = {
    resourceId = "string"
  }

針對 HybridConnection，請使用：

  endpointType = "HybridConnection"
  properties = {
    resourceId = "string"
  }

針對 ServiceBusQueue，請使用：

  endpointType = "ServiceBusQueue"
  properties = {
    resourceId = "string"
  }

針對 ServiceBusTopic，請使用：

  endpointType = "ServiceBusTopic"
  properties = {
    resourceId = "string"
  }

針對 StorageQueue，請使用：

  endpointType = "StorageQueue"
  properties = {
    queueName = "string"
    resourceId = "string"
  }

針對 WebHook，請使用：

  endpointType = "WebHook"
  properties = {
    azureActiveDirectoryApplicationIdOrUri = "string"
    azureActiveDirectoryTenantId = "string"
    endpointUrl = "string"
    maxEventsPerBatch = int
    preferredBatchSizeInKilobytes = int
  }

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

名稱 描述 值
類型 資源類型 “Microsoft.EventGrid/eventSubscriptions@2020-06-01”
NAME 資源名稱 字串 (必要)

字元限制：3-64

合法字元：
英數字元和連字號。
parent_id 要套用此延伸模組資源的資源標識碼。 字串 (必要)
properties 事件訂閱的屬性。 EventSubscriptionProperties

EventSubscriptionProperties

名稱 描述 值
deadLetterDestination 事件訂閱的DeadLetter目的地。 DeadLetterDestination
目的地 事件訂用帳戶必須傳遞事件之目的地的相關信息。 EventSubscriptionDestination
eventDeliverySchema 事件訂閱的事件傳遞架構。 “CloudEventSchemaV1_0”
“CustomInputSchema”
“EventGridSchema”
expirationTimeUtc 事件訂閱的到期時間。 字串
filter 事件訂閱篩選的相關信息。 EventSubscriptionFilter
標籤 使用者定義標籤的清單。 string[]
RetryPolicy 事件的重試原則。 這可以用來設定事件的最大傳遞嘗試次數和存留時間。 RetryPolicy

DeadLetterDestination

名稱 描述 值
endpointType 設定物件類型 StorageBlob (必要)

StorageBlobDeadLetterDestination

名稱 描述 值
endpointType 寄不出的信件目的地端點類型 “StorageBlob” (必要)
properties 記憶體 Blob 型死信目的地的屬性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名稱 描述 值
blobContainerName 記憶體 Blob 容器的名稱，該容器是寄不出的事件目的地 字串
resourceId 記憶體帳戶的 Azure 資源識別符，該帳戶是寄不出的事件目的地 字串

EventSubscriptionDestination

名稱 描述 值
endpointType 設定物件類型 AzureFunction
EventHub
HybridConnection
ServiceBusQueue
ServiceBusTopic
StorageQueue
需要 WebHook ()

AzureFunctionEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 ) 所需的 “AzureFunction” (
properties 事件訂用帳戶目的地的 Azure 函式屬性。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名稱 描述 值
maxEventsPerBatch 每個批次的事件數目上限。 int
preferredBatchSizeInKilobytes 慣用的批次大小以 KB 為單位。 int
resourceId Azure 資源識別碼，表示事件訂用帳戶之 Azure 函式目的地的端點。 字串

EventHubEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 “EventHub” (必要)
properties 事件訂閱目的地的事件中樞屬性。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 “HybridConnection” (必要)
properties 事件訂用帳戶目的地的混合式連線屬性。 HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

名稱 描述 值
resourceId 屬於事件訂用帳戶目的地之混合式連線的 Azure 資源識別碼。 字串

ServiceBusQueueEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 “ServiceBusQueue” (必要)
properties 事件訂用帳戶目的地的服務總線屬性。 ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名稱 描述 值
resourceId Azure 資源識別碼，表示事件訂用帳戶之服務總線目的地的端點。 字串

ServiceBusTopicEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 ) 所需的 「ServiceBusTopic」 (
properties 事件訂用帳戶目的地的服務總線主題屬性。 ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

名稱 描述 值
resourceId Azure 資源標識碼，表示事件訂用帳戶之服務總線主題目的地的端點。 字串

StorageQueueEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 “StorageQueue” (必要)
properties 事件訂用帳戶目的地的記憶體佇列屬性。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名稱 描述 值
queueName 記憶體帳戶下記憶體佇列的名稱，該帳戶是事件訂用帳戶的目的地。 字串
resourceId 記憶體帳戶的 Azure 資源識別碼，其中包含事件訂用帳戶目的地的佇列。 字串

WebHookEventSubscriptionDestination

名稱 描述 值
endpointType 事件訂用帳戶目的地的端點類型。 “WebHook” (必要)
properties 事件訂閱目的地的 WebHook 屬性。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名稱 描述 值
azureActiveDirectoryApplicationIdOrUri Azure Active Directory 應用程式識別碼或 URI，以取得將包含在傳遞要求中作為持有人令牌的存取令牌。 字串
azureActiveDirectoryTenantId Azure Active Directory 租使用者識別符，以取得將包含在傳遞要求中作為持有人令牌的存取令牌。 字串
endpointUrl URL，表示事件訂用帳戶目的地的端點。 字串

約束：
敏感性值。 以安全參數的形式傳入。
maxEventsPerBatch 每個批次的事件數目上限。 int
preferredBatchSizeInKilobytes 慣用的批次大小以 KB 為單位。 int

EventSubscriptionFilter

名稱 描述 值
advancedFilters 用於篩選事件訂閱的進階篩選陣列。 AdvancedFilter[]
includedEventTypes 需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有預設事件類型，請將 IncludedEventTypes 設定為 null。 string[]
isSubjectCaseSensitive 指定 Filter 的 SubjectBeginsWith 和 SubjectEndsWith 屬性是否為
應該以區分大小寫的方式進行比較。		 bool
subjectBeginsWith 選擇性字串，可根據資源路徑前置詞篩選事件訂閱的事件。
此格式取決於事件的發行者。
此路徑不支援通配符。		 字串
subjectEndsWith 選擇性字串，可根據資源路徑後綴篩選事件訂閱的事件。
此路徑不支援通配符。
 字串

AdvancedFilter

名稱 描述 值
索引鍵 事件中的欄位/屬性，根據您要篩選的欄位/屬性。 字串
operatorType 設定物件類型 BoolEquals
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
StringBeginsWith
StringContains
StringEndsWith
StringIn
需要 StringNotIn ()

BoolEqualsAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 “BoolEquals” (必要)
值 布爾篩選值。 bool

NumberGreaterThanAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 必要) “NumberGreaterThan” (
值 篩選值。 int

NumberGreaterThanOrEqualsAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 “NumberGreaterThanOrEquals” (必要)
值 篩選值。 int

NumberInAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 “NumberIn” (必要)
值 篩選值集。 int[]

NumberLessThanAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 必要) “NumberLessThan” (
值 篩選值。 int

NumberLessThanOrEqualsAdvancedFilter

名稱 描述 值
operatorType 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 “NumberLessThanOrEquals” (必要)
值 篩選值。 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 活動) 分鐘 (存留時間。 int
maxDeliveryAttempts 事件的傳遞重試嘗試次數上限。 int