Microsoft.EventGrid systemTopics/eventSubscriptions 2023-06-01-preview

發行項
10/19/2024

Bicep 資源定義

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

資源群組 - 請參閱資源群組部署命令

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

資源格式

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

resource symbolicname 'Microsoft.EventGrid/systemTopics/eventSubscriptions@2023-06-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    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
        }
      ]
      enableAdvancedFilteringOnArrays: bool
      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: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
    resourceId: 'string'
  }

針對 EventHub，請使用：

  endpointType: 'EventHub'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }

針對 HybridConnection，請使用：

  endpointType: 'HybridConnection'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }

針對 PartnerDestination，請使用：

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

針對 ServiceBusQueue，請使用：

  endpointType: 'ServiceBusQueue'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }

針對 ServiceBusTopic，請使用：

  endpointType: 'ServiceBusTopic'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }

針對 StorageQueue，請使用：

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

針對 WebHook，請使用：

  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl: 'string'
    maxEventsPerBatch: int
    minimumTlsVersionAllowed: 'string'
    preferredBatchSizeInKilobytes: int
  }

DeliveryAttributeMapping 物件

設定類型屬性，以指定物件的類型。

針對 Dynamic，請使用：

  type: 'Dynamic'
  properties: {
    sourceField: 'string'
  }

針對 Static，請使用：

  type: 'Static'
  properties: {
    isSecret: bool
    value: 'string'
  }

AdvancedFilter 物件

設定 operatorType 屬性，以指定對象的類型。

針對 BoolEquals，請使用：

  operatorType: 'BoolEquals'
  value: bool

針對 IsNotNull，請使用：

  operatorType: 'IsNotNull'

針對 IsNullOrUndefined，請使用：

  operatorType: 'IsNullOrUndefined'

針對 NumberGreaterThan，請使用：

  operatorType: 'NumberGreaterThan'
  value: int

針對 NumberGreaterThanOrEquals，請使用：

  operatorType: 'NumberGreaterThanOrEquals'
  value: int

針對 NumberIn，請使用：

  operatorType: 'NumberIn'
  values: [
    int
  ]

針對 NumberInRange，請使用：

  operatorType: 'NumberInRange'
  values: [
    [
      int
    ]
  ]

針對 NumberLessThan，請使用：

  operatorType: 'NumberLessThan'
  value: int

針對 NumberLessThanOrEquals，請使用：

  operatorType: 'NumberLessThanOrEquals'
  value: int

針對 NumberNotIn，請使用：

  operatorType: 'NumberNotIn'
  values: [
    int
  ]

針對 NumberNotInRange，請使用：

  operatorType: 'NumberNotInRange'
  values: [
    [
      int
    ]
  ]

針對 StringBeginsWith，請使用：

  operatorType: 'StringBeginsWith'
  values: [
    'string'
  ]

針對 StringContains，請使用：

  operatorType: 'StringContains'
  values: [
    'string'
  ]

針對 StringEndsWith，請使用：

  operatorType: 'StringEndsWith'
  values: [
    'string'
  ]

針對 StringIn，請使用：

  operatorType: 'StringIn'
  values: [
    'string'
  ]

針對 StringNotBeginsWith，請使用：

  operatorType: 'StringNotBeginsWith'
  values: [
    'string'
  ]

針對 StringNotContains，請使用：

  operatorType: 'StringNotContains'
  values: [
    'string'
  ]

針對 StringNotEndsWith，請使用：

  operatorType: 'StringNotEndsWith'
  values: [
    'string'
  ]

針對 StringNotIn，請使用：

  operatorType: 'StringNotIn'
  values: [
    'string'
  ]

屬性值

systemTopics/eventSubscriptions

名字	描述	價值
名字	資源名稱請參閱如何在 Bicep 中設定子資源的名稱和類型。	字串（必要）
父母	在 Bicep 中，您可以指定子資源的父資源。只有在父資源外部宣告子資源時，才需要新增這個屬性。如需詳細資訊，請參閱父資源外部的子資源。	類型資源的符號名稱：systemTopics
性能	事件訂閱的屬性。	EventSubscriptionProperties

EventSubscriptionProperties

名字	描述	價值
deadLetterDestination	事件訂閱的寄不出的信件目的地。無法傳遞至其目的地的任何事件都會傳送至寄不出的信件目的地。使用 Azure 事件方格的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。	DeadLetterDestination
deadLetterWithResourceIdentity	事件訂閱的寄不出的信件目的地。無法傳遞至其目的地的任何事件都會傳送至寄不出的信件目的地。使用父資源上的受控識別設定（即主題或網域）來取得傳遞/寄不出的信件期間所使用的驗證令牌。	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	事件訂閱必須傳遞事件目的地的相關信息。使用父資源上的受控識別設定（即主題或網域）來取得傳遞/寄不出的信件期間所使用的驗證令牌。	DeliveryWithResourceIdentity
目的地	事件訂閱必須傳遞事件目的地的相關信息。使用 Azure 事件方格的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。	EventSubscriptionDestination
eventDeliverySchema	事件訂閱的事件傳遞架構。	'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema'
expirationTimeUtc	事件訂閱的到期時間。	字串
濾波器	事件訂閱篩選的相關信息。	EventSubscriptionFilter
標籤	使用者定義的標籤清單。	string[]
retryPolicy	事件的重試原則。這可用來設定事件傳遞嘗試次數上限和存留時間。	RetryPolicy

DeadLetterDestination

名字	描述	價值
endpointType	設定物件類型	StorageBlob （必要）

StorageBlobDeadLetterDestination

名字	描述	價值
endpointType	寄不出的信件目的地的端點類型	'StorageBlob' （必要）
性能	記憶體 Blob 型死機目的地的屬性	StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

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

DeadLetterWithResourceIdentity

名字	描述	價值
deadLetterDestination	事件訂閱必須傳遞事件目的地的相關信息。使用父資源上的受控識別設定（即主題或網域）來取得傳遞/寄不出的信件期間所使用的驗證令牌。	DeadLetterDestination
身份	當寄不出的信件事件時要使用的身分識別。	EventSubscriptionIdentity

EventSubscriptionIdentity

名字	描述	價值
類型	所使用的受控識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』將會移除任何身分識別。	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	與資源相關聯的使用者身分識別。	字串

DeliveryWithResourceIdentity

名字	描述	價值
目的地	事件訂閱必須傳遞事件目的地的相關信息。使用 Azure 事件方格的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。	EventSubscriptionDestination
身份	傳遞事件時要使用的身分識別。	EventSubscriptionIdentity

EventSubscriptionDestination

名字	描述	價值
endpointType	設定物件類型	AzureFunction EventHub HybridConnection PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook （必要）

AzureFunctionEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	'AzureFunction' （必要）
性能	事件訂用帳戶目的地的 Azure 函式屬性。	AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
maxEventsPerBatch	每個批次的事件數目上限。	int
preferredBatchSizeInKilobytes	慣用的批次大小以 KB 為單位。	int
resourceId	代表事件訂用帳戶之 Azure 函式目的地端點的 Azure 資源識別碼。	字串

DeliveryAttributeMapping

名字	描述	價值
名字	傳遞屬性或標頭的名稱。	字串
類型	設定物件類型	動態靜態（必要）

DynamicDeliveryAttributeMapping

名字	描述	價值
類型	傳遞屬性或標頭名稱的類型。	'Dynamic' （必要）
性能	動態傳遞屬性對應的屬性。	DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

名字	描述	價值
sourceField	事件中包含屬性值的 JSON 路徑。	字串

StaticDeliveryAttributeMapping

名字	描述	價值
類型	傳遞屬性或標頭名稱的類型。	'Static' （必要）
性能	靜態傳遞屬性對應的屬性。	StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

名字	描述	價值
isSecret	布林值旗標，指出屬性是否包含敏感性資訊。	bool
價值	傳遞屬性的值。	字串

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
resourceId	代表事件訂用帳戶事件中樞目的地端點的 Azure 資源識別碼。	字串

HybridConnectionEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	'HybridConnection' （必要）
性能	事件訂用帳戶目的地的混合式連線屬性。	HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
resourceId	混合式連線的 Azure 資源識別碼，這是事件訂用帳戶的目的地。	字串

PartnerEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	'PartnerDestination' （必要）
性能	事件訂用帳戶目的地的合作夥伴目的地屬性。	PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

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

ServiceBusQueueEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	'ServiceBusQueue' （必要）
性能	事件訂用帳戶目的地的服務總線屬性。	ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
resourceId	代表事件訂用帳戶之服務總線目的地端點的 Azure 資源識別符。	字串

ServiceBusTopicEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	'ServiceBusTopic' （必要）
性能	事件訂用帳戶目的地的服務總線主題屬性。	ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
resourceId	代表事件訂用帳戶之服務總線主題目的地端點的 Azure 資源識別符。	字串

StorageQueueEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	'StorageQueue' （必要）
性能	事件訂用帳戶目的地的記憶體佇列屬性。	StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名字	描述	價值
queueMessageTimeToLiveInSeconds	儲存佇列訊息存留時間以秒為單位。這個值不能為零或負值，但使用 -1 表示訊息的存留時間是 Infinite。	int
queueName	記憶體帳戶下記憶體佇列的名稱，該記憶體帳戶是事件訂用帳戶的目的地。	字串
resourceId	記憶體帳戶的 Azure 資源識別碼，其中包含事件訂用帳戶目的地的佇列。	字串

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名字	描述	價值
azureActiveDirectoryApplicationIdOrUri	Azure Active Directory 應用程式識別碼或 URI，以取得存取令牌，這些令牌將包含在傳遞要求中作為持有人令牌。	字串
azureActiveDirectoryTenantId	要取得存取令牌的 Azure Active Directory 租使用者標識碼，該令牌將包含在傳遞要求中作為持有人令牌。	字串
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
endpointUrl	表示事件訂用帳戶目的地端點的 URL。	字串約束：敏感性值。以安全參數的形式傳入。
maxEventsPerBatch	每個批次的事件數目上限。	int
minimumTlsVersionAllowed	Webhook 端點應支援的最小 TLS 版本	'1.0' '1.1' '1.2'
preferredBatchSizeInKilobytes	慣用的批次大小以 KB 為單位。	int

EventSubscriptionFilter

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

AdvancedFilter

名字	描述	價值
鑰匙	事件中的欄位/屬性，根據您想要篩選的欄位/屬性。	字串
operatorType	設定物件類型	BoolEquals IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn （必要）

BoolEqualsAdvancedFilter

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

IsNotNullAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'IsNotNull' （必要）

IsNullOrUndefinedAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'IsNullOrUndefined' （必要）

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'NumberIn' （必要）
值	一組篩選值。	int[]

NumberInRangeAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'NumberInRange' （必要）
值	一組篩選值。	int[][]

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'NumberLessThanOrEquals' （必要）
價值	篩選值。	int

NumberNotInAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'NumberNotIn' （必要）
值	一組篩選值。	int[]

NumberNotInRangeAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'NumberNotInRange' （必要）
值	一組篩選值。	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[]

StringNotBeginsWithAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'StringNotBeginsWith' （必要）
值	一組篩選值。	string[]

StringNotContainsAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'StringNotContains' （必要）
值	一組篩選值。	string[]

StringNotEndsWithAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'StringNotEndsWith' （必要）
值	一組篩選值。	string[]

StringNotInAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'StringNotIn' （必要）
值	一組篩選值。	string[]

RetryPolicy

名字	描述	價值
eventTimeToLiveInMinutes	活動存留時間（以分鐘為單位）。	int
maxDeliveryAttempts	事件的傳遞重試嘗試次數上限。	int

快速入門範本

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

範本	描述
建立 Blob 記憶體和事件方格訂用帳戶至 Blob	建立 Azure Blob 記憶體帳戶，然後建立該 Blob 的事件方格訂用帳戶。
使用事件方格連線部署 Azure 數據總管資料庫	使用事件方格聯機部署 Azure 數據總管資料庫。

ARM 樣本資源定義

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

資源群組 - 請參閱資源群組部署命令

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

資源格式

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

{
  "type": "Microsoft.EventGrid/systemTopics/eventSubscriptions",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "deadLetterWithResourceIdentity": {
      "deadLetterDestination": {
        "endpointType": "string"
        // For remaining properties, see DeadLetterDestination objects
      },
      "identity": {
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "deliveryWithResourceIdentity": {
      "destination": {
        "endpointType": "string"
        // For remaining properties, see EventSubscriptionDestination objects
      },
      "identity": {
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "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
        }
      ],
      "enableAdvancedFilteringOnArrays": "bool",
      "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": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "maxEventsPerBatch": "int",
    "preferredBatchSizeInKilobytes": "int",
    "resourceId": "string"
  }

針對 EventHub，請使用：

  "endpointType": "EventHub",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "resourceId": "string"
  }

針對 HybridConnection，請使用：

  "endpointType": "HybridConnection",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "resourceId": "string"
  }

針對 PartnerDestination，請使用：

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

針對 ServiceBusQueue，請使用：

  "endpointType": "ServiceBusQueue",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "resourceId": "string"
  }

針對 ServiceBusTopic，請使用：

  "endpointType": "ServiceBusTopic",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "resourceId": "string"
  }

針對 StorageQueue，請使用：

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

針對 WebHook，請使用：

  "endpointType": "WebHook",
  "properties": {
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string",
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "endpointUrl": "string",
    "maxEventsPerBatch": "int",
    "minimumTlsVersionAllowed": "string",
    "preferredBatchSizeInKilobytes": "int"
  }

DeliveryAttributeMapping 物件

設定類型屬性，以指定物件的類型。

針對 Dynamic，請使用：

  "type": "Dynamic",
  "properties": {
    "sourceField": "string"
  }

針對 Static，請使用：

  "type": "Static",
  "properties": {
    "isSecret": "bool",
    "value": "string"
  }

AdvancedFilter 物件

設定 operatorType 屬性，以指定對象的類型。

針對 BoolEquals，請使用：

  "operatorType": "BoolEquals",
  "value": "bool"

針對 IsNotNull，請使用：

  "operatorType": "IsNotNull"

針對 IsNullOrUndefined，請使用：

  "operatorType": "IsNullOrUndefined"

針對 NumberGreaterThan，請使用：

  "operatorType": "NumberGreaterThan",
  "value": "int"

針對 NumberGreaterThanOrEquals，請使用：

  "operatorType": "NumberGreaterThanOrEquals",
  "value": "int"

針對 NumberIn，請使用：

  "operatorType": "NumberIn",
  "values": [ "int" ]

針對 NumberInRange，請使用：

  "operatorType": "NumberInRange",
  "values": [ [ "int" ] ]

針對 NumberLessThan，請使用：

  "operatorType": "NumberLessThan",
  "value": "int"

針對 NumberLessThanOrEquals，請使用：

  "operatorType": "NumberLessThanOrEquals",
  "value": "int"

針對 NumberNotIn，請使用：

  "operatorType": "NumberNotIn",
  "values": [ "int" ]

針對 NumberNotInRange，請使用：

  "operatorType": "NumberNotInRange",
  "values": [ [ "int" ] ]

針對 StringBeginsWith，請使用：

  "operatorType": "StringBeginsWith",
  "values": [ "string" ]

針對 StringContains，請使用：

  "operatorType": "StringContains",
  "values": [ "string" ]

針對 StringEndsWith，請使用：

  "operatorType": "StringEndsWith",
  "values": [ "string" ]

針對 StringIn，請使用：

  "operatorType": "StringIn",
  "values": [ "string" ]

針對 StringNotBeginsWith，請使用：

  "operatorType": "StringNotBeginsWith",
  "values": [ "string" ]

針對 StringNotContains，請使用：

  "operatorType": "StringNotContains",
  "values": [ "string" ]

針對 StringNotEndsWith，請使用：

  "operatorType": "StringNotEndsWith",
  "values": [ "string" ]

針對 StringNotIn，請使用：

  "operatorType": "StringNotIn",
  "values": [ "string" ]

屬性值

systemTopics/eventSubscriptions

名字	描述	價值
類型	資源類型	'Microsoft.EventGrid/systemTopics/eventSubscriptions'
apiVersion	資源 API 版本	'2023-06-01-preview'
名字	資源名稱請參閱如何在JSON ARM 範本中設定子資源的名稱和類型。	字串（必要）
性能	事件訂閱的屬性。	EventSubscriptionProperties

EventSubscriptionProperties

名字	描述	價值
deadLetterDestination	事件訂閱的寄不出的信件目的地。無法傳遞至其目的地的任何事件都會傳送至寄不出的信件目的地。使用 Azure 事件方格的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。	DeadLetterDestination
deadLetterWithResourceIdentity	事件訂閱的寄不出的信件目的地。無法傳遞至其目的地的任何事件都會傳送至寄不出的信件目的地。使用父資源上的受控識別設定（即主題或網域）來取得傳遞/寄不出的信件期間所使用的驗證令牌。	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	事件訂閱必須傳遞事件目的地的相關信息。使用父資源上的受控識別設定（即主題或網域）來取得傳遞/寄不出的信件期間所使用的驗證令牌。	DeliveryWithResourceIdentity
目的地	事件訂閱必須傳遞事件目的地的相關信息。使用 Azure 事件方格的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。	EventSubscriptionDestination
eventDeliverySchema	事件訂閱的事件傳遞架構。	'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema'
expirationTimeUtc	事件訂閱的到期時間。	字串
濾波器	事件訂閱篩選的相關信息。	EventSubscriptionFilter
標籤	使用者定義的標籤清單。	string[]
retryPolicy	事件的重試原則。這可用來設定事件傳遞嘗試次數上限和存留時間。	RetryPolicy

DeadLetterDestination

名字	描述	價值
endpointType	設定物件類型	StorageBlob （必要）

StorageBlobDeadLetterDestination

名字	描述	價值
endpointType	寄不出的信件目的地的端點類型	'StorageBlob' （必要）
性能	記憶體 Blob 型死機目的地的屬性	StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

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

DeadLetterWithResourceIdentity

名字	描述	價值
deadLetterDestination	事件訂閱必須傳遞事件目的地的相關信息。使用父資源上的受控識別設定（即主題或網域）來取得傳遞/寄不出的信件期間所使用的驗證令牌。	DeadLetterDestination
身份	當寄不出的信件事件時要使用的身分識別。	EventSubscriptionIdentity

EventSubscriptionIdentity

名字	描述	價值
類型	所使用的受控識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』將會移除任何身分識別。	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	與資源相關聯的使用者身分識別。	字串

DeliveryWithResourceIdentity

名字	描述	價值
目的地	事件訂閱必須傳遞事件目的地的相關信息。使用 Azure 事件方格的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。	EventSubscriptionDestination
身份	傳遞事件時要使用的身分識別。	EventSubscriptionIdentity

EventSubscriptionDestination

名字	描述	價值
endpointType	設定物件類型	AzureFunction EventHub HybridConnection PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook （必要）

AzureFunctionEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	'AzureFunction' （必要）
性能	事件訂用帳戶目的地的 Azure 函式屬性。	AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
maxEventsPerBatch	每個批次的事件數目上限。	int
preferredBatchSizeInKilobytes	慣用的批次大小以 KB 為單位。	int
resourceId	代表事件訂用帳戶之 Azure 函式目的地端點的 Azure 資源識別碼。	字串

DeliveryAttributeMapping

名字	描述	價值
名字	傳遞屬性或標頭的名稱。	字串
類型	設定物件類型	動態靜態（必要）

DynamicDeliveryAttributeMapping

名字	描述	價值
類型	傳遞屬性或標頭名稱的類型。	'Dynamic' （必要）
性能	動態傳遞屬性對應的屬性。	DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

名字	描述	價值
sourceField	事件中包含屬性值的 JSON 路徑。	字串

StaticDeliveryAttributeMapping

名字	描述	價值
類型	傳遞屬性或標頭名稱的類型。	'Static' （必要）
性能	靜態傳遞屬性對應的屬性。	StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

名字	描述	價值
isSecret	布林值旗標，指出屬性是否包含敏感性資訊。	bool
價值	傳遞屬性的值。	字串

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
resourceId	代表事件訂用帳戶事件中樞目的地端點的 Azure 資源識別碼。	字串

HybridConnectionEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	'HybridConnection' （必要）
性能	事件訂用帳戶目的地的混合式連線屬性。	HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
resourceId	混合式連線的 Azure 資源識別碼，這是事件訂用帳戶的目的地。	字串

PartnerEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	'PartnerDestination' （必要）
性能	事件訂用帳戶目的地的合作夥伴目的地屬性。	PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

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

ServiceBusQueueEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	'ServiceBusQueue' （必要）
性能	事件訂用帳戶目的地的服務總線屬性。	ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
resourceId	代表事件訂用帳戶之服務總線目的地端點的 Azure 資源識別符。	字串

ServiceBusTopicEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	'ServiceBusTopic' （必要）
性能	事件訂用帳戶目的地的服務總線主題屬性。	ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
resourceId	代表事件訂用帳戶之服務總線主題目的地端點的 Azure 資源識別符。	字串

StorageQueueEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	'StorageQueue' （必要）
性能	事件訂用帳戶目的地的記憶體佇列屬性。	StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名字	描述	價值
queueMessageTimeToLiveInSeconds	儲存佇列訊息存留時間以秒為單位。這個值不能為零或負值，但使用 -1 表示訊息的存留時間是 Infinite。	int
queueName	記憶體帳戶下記憶體佇列的名稱，該記憶體帳戶是事件訂用帳戶的目的地。	字串
resourceId	記憶體帳戶的 Azure 資源識別碼，其中包含事件訂用帳戶目的地的佇列。	字串

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名字	描述	價值
azureActiveDirectoryApplicationIdOrUri	Azure Active Directory 應用程式識別碼或 URI，以取得存取令牌，這些令牌將包含在傳遞要求中作為持有人令牌。	字串
azureActiveDirectoryTenantId	要取得存取令牌的 Azure Active Directory 租使用者標識碼，該令牌將包含在傳遞要求中作為持有人令牌。	字串
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
endpointUrl	表示事件訂用帳戶目的地端點的 URL。	字串約束：敏感性值。以安全參數的形式傳入。
maxEventsPerBatch	每個批次的事件數目上限。	int
minimumTlsVersionAllowed	Webhook 端點應支援的最小 TLS 版本	'1.0' '1.1' '1.2'
preferredBatchSizeInKilobytes	慣用的批次大小以 KB 為單位。	int

EventSubscriptionFilter

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

AdvancedFilter

名字	描述	價值
鑰匙	事件中的欄位/屬性，根據您想要篩選的欄位/屬性。	字串
operatorType	設定物件類型	BoolEquals IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn （必要）

BoolEqualsAdvancedFilter

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

IsNotNullAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'IsNotNull' （必要）

IsNullOrUndefinedAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'IsNullOrUndefined' （必要）

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'NumberIn' （必要）
值	一組篩選值。	int[]

NumberInRangeAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'NumberInRange' （必要）
值	一組篩選值。	int[][]

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'NumberLessThanOrEquals' （必要）
價值	篩選值。	int

NumberNotInAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'NumberNotIn' （必要）
值	一組篩選值。	int[]

NumberNotInRangeAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'NumberNotInRange' （必要）
值	一組篩選值。	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[]

StringNotBeginsWithAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'StringNotBeginsWith' （必要）
值	一組篩選值。	string[]

StringNotContainsAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'StringNotContains' （必要）
值	一組篩選值。	string[]

StringNotEndsWithAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'StringNotEndsWith' （必要）
值	一組篩選值。	string[]

StringNotInAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	'StringNotIn' （必要）
值	一組篩選值。	string[]

RetryPolicy

名字	描述	價值
eventTimeToLiveInMinutes	活動存留時間（以分鐘為單位）。	int
maxDeliveryAttempts	事件的傳遞重試嘗試次數上限。	int

快速入門範本

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

範本	描述
建立 Blob 記憶體和事件方格訂用帳戶至 Blob	建立 Azure Blob 記憶體帳戶，然後建立該 Blob 的事件方格訂用帳戶。
使用事件方格連線部署 Azure 數據總管資料庫	使用事件方格聯機部署 Azure 數據總管資料庫。

Terraform （AzAPI 提供者）資源定義

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

資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/systemTopics/eventSubscriptions@2023-06-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      deadLetterWithResourceIdentity = {
        deadLetterDestination = {
          endpointType = "string"
          // For remaining properties, see DeadLetterDestination objects
        }
        identity = {
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      deliveryWithResourceIdentity = {
        destination = {
          endpointType = "string"
          // For remaining properties, see EventSubscriptionDestination objects
        }
        identity = {
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      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
          }
        ]
        enableAdvancedFilteringOnArrays = bool
        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 = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    maxEventsPerBatch = int
    preferredBatchSizeInKilobytes = int
    resourceId = "string"
  }

針對 EventHub，請使用：

  endpointType = "EventHub"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }

針對 HybridConnection，請使用：

  endpointType = "HybridConnection"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }

針對 PartnerDestination，請使用：

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

針對 ServiceBusQueue，請使用：

  endpointType = "ServiceBusQueue"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }

針對 ServiceBusTopic，請使用：

  endpointType = "ServiceBusTopic"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }

針對 StorageQueue，請使用：

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

針對 WebHook，請使用：

  endpointType = "WebHook"
  properties = {
    azureActiveDirectoryApplicationIdOrUri = "string"
    azureActiveDirectoryTenantId = "string"
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl = "string"
    maxEventsPerBatch = int
    minimumTlsVersionAllowed = "string"
    preferredBatchSizeInKilobytes = int
  }

DeliveryAttributeMapping 物件

設定類型屬性，以指定物件的類型。

針對 Dynamic，請使用：

  type = "Dynamic"
  properties = {
    sourceField = "string"
  }

針對 Static，請使用：

  type = "Static"
  properties = {
    isSecret = bool
    value = "string"
  }

AdvancedFilter 物件

設定 operatorType 屬性，以指定對象的類型。

針對 BoolEquals，請使用：

  operatorType = "BoolEquals"
  value = bool

針對 IsNotNull，請使用：

  operatorType = "IsNotNull"

針對 IsNullOrUndefined，請使用：

  operatorType = "IsNullOrUndefined"

針對 NumberGreaterThan，請使用：

  operatorType = "NumberGreaterThan"
  value = int

針對 NumberGreaterThanOrEquals，請使用：

  operatorType = "NumberGreaterThanOrEquals"
  value = int

針對 NumberIn，請使用：

  operatorType = "NumberIn"
  values = [
    int
  ]

針對 NumberInRange，請使用：

  operatorType = "NumberInRange"
  values = [
    [
      int
    ]
  ]

針對 NumberLessThan，請使用：

  operatorType = "NumberLessThan"
  value = int

針對 NumberLessThanOrEquals，請使用：

  operatorType = "NumberLessThanOrEquals"
  value = int

針對 NumberNotIn，請使用：

  operatorType = "NumberNotIn"
  values = [
    int
  ]

針對 NumberNotInRange，請使用：

  operatorType = "NumberNotInRange"
  values = [
    [
      int
    ]
  ]

針對 StringBeginsWith，請使用：

  operatorType = "StringBeginsWith"
  values = [
    "string"
  ]

針對 StringContains，請使用：

  operatorType = "StringContains"
  values = [
    "string"
  ]

針對 StringEndsWith，請使用：

  operatorType = "StringEndsWith"
  values = [
    "string"
  ]

針對 StringIn，請使用：

  operatorType = "StringIn"
  values = [
    "string"
  ]

針對 StringNotBeginsWith，請使用：

  operatorType = "StringNotBeginsWith"
  values = [
    "string"
  ]

針對 StringNotContains，請使用：

  operatorType = "StringNotContains"
  values = [
    "string"
  ]

針對 StringNotEndsWith，請使用：

  operatorType = "StringNotEndsWith"
  values = [
    "string"
  ]

針對 StringNotIn，請使用：

  operatorType = "StringNotIn"
  values = [
    "string"
  ]

屬性值

systemTopics/eventSubscriptions

名字	描述	價值
類型	資源類型	“Microsoft.EventGrid/systemTopics/eventSubscriptions@2023-06-01-preview”
名字	資源名稱	字串（必要）
parent_id	此資源為父系之資源的標識碼。	類型資源的標識碼：systemTopics
性能	事件訂閱的屬性。	EventSubscriptionProperties

EventSubscriptionProperties

名字	描述	價值
deadLetterDestination	事件訂閱的寄不出的信件目的地。無法傳遞至其目的地的任何事件都會傳送至寄不出的信件目的地。使用 Azure 事件方格的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。	DeadLetterDestination
deadLetterWithResourceIdentity	事件訂閱的寄不出的信件目的地。無法傳遞至其目的地的任何事件都會傳送至寄不出的信件目的地。使用父資源上的受控識別設定（即主題或網域）來取得傳遞/寄不出的信件期間所使用的驗證令牌。	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	事件訂閱必須傳遞事件目的地的相關信息。使用父資源上的受控識別設定（即主題或網域）來取得傳遞/寄不出的信件期間所使用的驗證令牌。	DeliveryWithResourceIdentity
目的地	事件訂閱必須傳遞事件目的地的相關信息。使用 Azure 事件方格的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。	EventSubscriptionDestination
eventDeliverySchema	事件訂閱的事件傳遞架構。	“CloudEventSchemaV1_0” “CustomInputSchema” “EventGridSchema”
expirationTimeUtc	事件訂閱的到期時間。	字串
濾波器	事件訂閱篩選的相關信息。	EventSubscriptionFilter
標籤	使用者定義的標籤清單。	string[]
retryPolicy	事件的重試原則。這可用來設定事件傳遞嘗試次數上限和存留時間。	RetryPolicy

DeadLetterDestination

名字	描述	價值
endpointType	設定物件類型	StorageBlob （必要）

StorageBlobDeadLetterDestination

名字	描述	價值
endpointType	寄不出的信件目的地的端點類型	“StorageBlob” （必要）
性能	記憶體 Blob 型死機目的地的屬性	StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

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

DeadLetterWithResourceIdentity

名字	描述	價值
deadLetterDestination	事件訂閱必須傳遞事件目的地的相關信息。使用父資源上的受控識別設定（即主題或網域）來取得傳遞/寄不出的信件期間所使用的驗證令牌。	DeadLetterDestination
身份	當寄不出的信件事件時要使用的身分識別。	EventSubscriptionIdentity

EventSubscriptionIdentity

名字	描述	價值
類型	所使用的受控識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』將會移除任何身分識別。	“SystemAssigned” “UserAssigned”
userAssignedIdentity	與資源相關聯的使用者身分識別。	字串

DeliveryWithResourceIdentity

名字	描述	價值
目的地	事件訂閱必須傳遞事件目的地的相關信息。使用 Azure 事件方格的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。	EventSubscriptionDestination
身份	傳遞事件時要使用的身分識別。	EventSubscriptionIdentity

EventSubscriptionDestination

名字	描述	價值
endpointType	設定物件類型	AzureFunction EventHub HybridConnection PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue WebHook （必要）

AzureFunctionEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	“AzureFunction” （必要）
性能	事件訂用帳戶目的地的 Azure 函式屬性。	AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
maxEventsPerBatch	每個批次的事件數目上限。	int
preferredBatchSizeInKilobytes	慣用的批次大小以 KB 為單位。	int
resourceId	代表事件訂用帳戶之 Azure 函式目的地端點的 Azure 資源識別碼。	字串

DeliveryAttributeMapping

名字	描述	價值
名字	傳遞屬性或標頭的名稱。	字串
類型	設定物件類型	動態靜態（必要）

DynamicDeliveryAttributeMapping

名字	描述	價值
類型	傳遞屬性或標頭名稱的類型。	“Dynamic” （必要）
性能	動態傳遞屬性對應的屬性。	DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

名字	描述	價值
sourceField	事件中包含屬性值的 JSON 路徑。	字串

StaticDeliveryAttributeMapping

名字	描述	價值
類型	傳遞屬性或標頭名稱的類型。	“Static” （必要）
性能	靜態傳遞屬性對應的屬性。	StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

名字	描述	價值
isSecret	布林值旗標，指出屬性是否包含敏感性資訊。	bool
價值	傳遞屬性的值。	字串

EventHubEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	“EventHub” （必要）
性能	事件訂用帳戶目的地的事件中樞屬性。	EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
resourceId	代表事件訂用帳戶事件中樞目的地端點的 Azure 資源識別碼。	字串

HybridConnectionEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	“HybridConnection” （必要）
性能	事件訂用帳戶目的地的混合式連線屬性。	HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
resourceId	混合式連線的 Azure 資源識別碼，這是事件訂用帳戶的目的地。	字串

PartnerEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	“PartnerDestination” （必要）
性能	事件訂用帳戶目的地的合作夥伴目的地屬性。	PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

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

ServiceBusQueueEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	“ServiceBusQueue” （必要）
性能	事件訂用帳戶目的地的服務總線屬性。	ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
resourceId	代表事件訂用帳戶之服務總線目的地端點的 Azure 資源識別符。	字串

ServiceBusTopicEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	“ServiceBusTopic” （必要）
性能	事件訂用帳戶目的地的服務總線主題屬性。	ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

名字	描述	價值
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
resourceId	代表事件訂用帳戶之服務總線主題目的地端點的 Azure 資源識別符。	字串

StorageQueueEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	“StorageQueue” （必要）
性能	事件訂用帳戶目的地的記憶體佇列屬性。	StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名字	描述	價值
queueMessageTimeToLiveInSeconds	儲存佇列訊息存留時間以秒為單位。這個值不能為零或負值，但使用 -1 表示訊息的存留時間是 Infinite。	int
queueName	記憶體帳戶下記憶體佇列的名稱，該記憶體帳戶是事件訂用帳戶的目的地。	字串
resourceId	記憶體帳戶的 Azure 資源識別碼，其中包含事件訂用帳戶目的地的佇列。	字串

WebHookEventSubscriptionDestination

名字	描述	價值
endpointType	事件訂用帳戶目的地的端點類型。	“WebHook” （必要）
性能	事件訂用帳戶目的地的 WebHook 屬性。	WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名字	描述	價值
azureActiveDirectoryApplicationIdOrUri	Azure Active Directory 應用程式識別碼或 URI，以取得存取令牌，這些令牌將包含在傳遞要求中作為持有人令牌。	字串
azureActiveDirectoryTenantId	要取得存取令牌的 Azure Active Directory 租使用者標識碼，該令牌將包含在傳遞要求中作為持有人令牌。	字串
deliveryAttributeMappings	傳遞屬性詳細數據。	DeliveryAttributeMapping[]
endpointUrl	表示事件訂用帳戶目的地端點的 URL。	字串約束：敏感性值。以安全參數的形式傳入。
maxEventsPerBatch	每個批次的事件數目上限。	int
minimumTlsVersionAllowed	Webhook 端點應支援的最小 TLS 版本	"1.0" "1.1" "1.2"
preferredBatchSizeInKilobytes	慣用的批次大小以 KB 為單位。	int

EventSubscriptionFilter

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

AdvancedFilter

名字	描述	價值
鑰匙	事件中的欄位/屬性，根據您想要篩選的欄位/屬性。	字串
operatorType	設定物件類型	BoolEquals IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn （必要）

BoolEqualsAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“BoolEquals” （必要）
價值	布爾篩選值。	bool

IsNotNullAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“IsNotNull” （必要）

IsNullOrUndefinedAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“IsNullOrUndefined” （必要）

NumberGreaterThanAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“NumberGreaterThan” （必要）
價值	篩選值。	int

NumberGreaterThanOrEqualsAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“NumberGreaterThanOrEquals” （必要）
價值	篩選值。	int

NumberInAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“NumberIn” （必要）
值	一組篩選值。	int[]

NumberInRangeAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“NumberInRange” （必要）
值	一組篩選值。	int[][]

NumberLessThanAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“NumberLessThan” （必要）
價值	篩選值。	int

NumberLessThanOrEqualsAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“NumberLessThanOrEquals” （必要）
價值	篩選值。	int

NumberNotInAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“NumberNotIn” （必要）
值	一組篩選值。	int[]

NumberNotInRangeAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“NumberNotInRange” （必要）
值	一組篩選值。	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[]

StringNotBeginsWithAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“StringNotBeginsWith” （必要）
值	一組篩選值。	string[]

StringNotContainsAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“StringNotContains” （必要）
值	一組篩選值。	string[]

StringNotEndsWithAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“StringNotEndsWith” （必要）
值	一組篩選值。	string[]

StringNotInAdvancedFilter

名字	描述	價值
operatorType	用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等。	“StringNotIn” （必要）
值	一組篩選值。	string[]

RetryPolicy

名字	描述	價值
eventTimeToLiveInMinutes	活動存留時間（以分鐘為單位）。	int
maxDeliveryAttempts	事件的傳遞重試嘗試次數上限。	int

共用方式為

Microsoft.EventGrid systemTopics/eventSubscriptions 2023-06-01-preview

Bicep 資源定義

資源格式

DeadLetterDestination 物件

EventSubscriptionDestination 物件

DeliveryAttributeMapping 物件

AdvancedFilter 物件

屬性值

systemTopics/eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

DeadLetterWithResourceIdentity

EventSubscriptionIdentity

DeliveryWithResourceIdentity

EventSubscriptionDestination

AzureFunctionEventSubscriptionDestination

AzureFunctionEventSubscriptionDestinationProperties

DeliveryAttributeMapping

DynamicDeliveryAttributeMapping

DynamicDeliveryAttributeMappingProperties

StaticDeliveryAttributeMapping

StaticDeliveryAttributeMappingProperties

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

PartnerEventSubscriptionDestination

PartnerEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestination

ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestination

ServiceBusTopicEventSubscriptionDestinationPropertie...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

AdvancedFilter

BoolEqualsAdvancedFilter

IsNotNullAdvancedFilter

IsNullOrUndefinedAdvancedFilter

NumberGreaterThanAdvancedFilter

NumberGreaterThanOrEqualsAdvancedFilter

NumberInAdvancedFilter

NumberInRangeAdvancedFilter

NumberLessThanAdvancedFilter

NumberLessThanOrEqualsAdvancedFilter

NumberNotInAdvancedFilter

NumberNotInRangeAdvancedFilter

StringBeginsWithAdvancedFilter

StringContainsAdvancedFilter

StringEndsWithAdvancedFilter

StringInAdvancedFilter

StringNotBeginsWithAdvancedFilter

StringNotContainsAdvancedFilter

StringNotEndsWithAdvancedFilter

StringNotInAdvancedFilter

RetryPolicy

快速入門範本

ARM 樣本資源定義

資源格式

DeadLetterDestination 物件

EventSubscriptionDestination 物件

DeliveryAttributeMapping 物件

AdvancedFilter 物件

屬性值

systemTopics/eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

DeadLetterWithResourceIdentity

EventSubscriptionIdentity

DeliveryWithResourceIdentity

EventSubscriptionDestination

AzureFunctionEventSubscriptionDestination

AzureFunctionEventSubscriptionDestinationProperties

Terraform （AzAPI 提供者）資源定義