共用方式為


Microsoft.EventGrid 命名空間/topics/eventSubscriptions

Bicep 資源定義

命名空間/topics/eventSubscriptions 資源類型可以使用目標作業來部署:

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

資源格式

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

resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2025-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    deliveryConfiguration: {
      deliveryMode: 'string'
      push: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            federatedIdentityCredentialInfo: {
              federatedClientId: 'string'
            }
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        deliveryWithResourceIdentity: {
          destination: {
            endpointType: 'string'
            // For remaining properties, see EventSubscriptionDestination objects
          }
          identity: {
            federatedIdentityCredentialInfo: {
              federatedClientId: 'string'
            }
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        destination: {
          endpointType: 'string'
          // For remaining properties, see EventSubscriptionDestination objects
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
      }
      queue: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            federatedIdentityCredentialInfo: {
              federatedClientId: 'string'
            }
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
        receiveLockDurationInSeconds: int
      }
    }
    eventDeliverySchema: 'string'
    expirationTimeUtc: 'string'
    filtersConfiguration: {
      filters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see Filter objects
        }
      ]
      includedEventTypes: [
        'string'
      ]
    }
    tags: {
      {customized property}: 'string'
    }
  }
}

DeadLetterDestination 物件

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

針對 StorageBlob,請使用:

{
  endpointType: 'StorageBlob'
  properties: {
    blobContainerName: 'string'
    resourceId: 'string'
  }
}

DeliveryAttributeMapping 物件

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

針對 Dynamic,請使用:

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

針對 Static,請使用:

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

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

針對 MonitorAlert,請使用:

{
  endpointType: 'MonitorAlert'
  properties: {
    actionGroups: [
      'string'
    ]
    description: 'string'
    severity: 'string'
  }
}

針對 NamespaceTopic,請使用:

{
  endpointType: 'NamespaceTopic'
  properties: {
    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
  }
}

篩選物件

設定 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'
  ]
}

屬性值

Microsoft.EventGrid/namespaces/topics/eventSubscriptions

名稱 說明 價值觀
名稱 資源名稱 字串

約束:
最小長度 = 3
最大長度 = 50
模式 = ^[a-zA-Z0-9-]*$ (必要)
父代 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。

如需詳細資訊,請參閱 父資源外部的子資源
類型資源的符號名稱: namespaces/topics
屬性 事件訂閱的屬性。 SubscriptionProperties

AzureFunctionEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'AzureFunction' (必要)
屬性 事件訂用帳戶目的地的 Azure 函式屬性。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsFilter (布林等於篩檢程式)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'BoolEquals' (必要)
價值 布爾篩選值。 布爾 (bool)

死信目標

名稱 說明 價值觀
endpoint類型 針對 storageBlobDeadLetterDestination類型 設定為 'StorageBlob'。 'StorageBlob' (必要)

DeadLetterWithResourceIdentity

名稱 說明 價值觀
deadLetterDestination 的 事件訂閱必須傳遞事件目的地的相關信息。
使用父資源上的受控識別設定(即主題或網域)來取得在寄不出的信件期間使用的驗證令牌。
死信目標
身分識別 當寄不出的信件事件時要使用的身分識別。 EventSubscriptionIdentity

DeliveryAttributeMapping

名稱 說明 價值觀
名稱 傳遞屬性或標頭的名稱。 字串
型別 針對 DynamicDeliveryAttributeMapping 類型設定為 『Dynamic』。 設定為 StaticDeliveryAttributeMapping 類型的 『Static』。 “動態”
'Static' (必要)

DeliveryConfiguration

名稱 說明 價值觀
deliveryMode 交付模式 事件訂閱的傳遞模式。 “推”
“佇列”
推送 當 deliveryMode 為 push 時,應該填入這個屬性,並代表發送訂閱的相關信息。 推送資訊
佇列 當 deliveryMode 為 queue 時,應該填入這個屬性,並代表佇列訂閱的相關信息。 佇列資訊

DeliveryWithResourceIdentity

名稱 說明 價值觀
目的地 事件訂閱必須傳遞事件目的地的相關信息。
使用父資源上的受控識別設定(即主題或網域)來取得傳遞期間所使用的驗證令牌。
EventSubscriptionDestination 事件訂閱目標
身分識別 傳遞事件時要使用的身分識別。 EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

名稱 說明 價值觀
屬性 動態傳遞屬性對應的屬性。 DynamicDeliveryAttributeMappingProperties
型別 傳遞屬性或標頭名稱的類型。 'Dynamic' (必要)

DynamicDeliveryAttributeMappingProperties

名稱 說明 價值觀
sourceField 事件中包含屬性值的 JSON 路徑。 字串

EventHubEventSubscriptionDestination 事件訂閱目標

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'EventHub' (必要)
屬性 事件訂用帳戶目的地的事件中樞屬性。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination 事件訂閱目標

名稱 說明 價值觀
endpoint類型 針對 AzureFunctionEventSubscriptionDestination 類型,設定為 『AzureFunction』。 針對 eventHubEventSubscriptionDestination類型 設定為 'EventHub'。 針對 hybridConnectionEventSubscriptionDestination類型 ,設定為 'HybridConnection'。 設定為 MonitorAlertEventSubscriptionDestination 類型的 'MonitorAlert'。 設定為 NamespaceTopicEventSubscriptionDestination 類型的 'NamespaceTopic'。 針對 PartnerEventSubscriptionDestination 類型,設定為 'PartnerDestination'。 設定為 ServiceBusQueueEventSubscriptionDestination 類型的 'ServiceBusQueue'。 針對 ServiceBusTopicEventSubscriptionDestination 類型,設定為 'ServiceBusTopic'。 針對 storageQueueEventSubscriptionDestination類型 設定為 'StorageQueue'。 針對 WebHookEventSubscriptionDestination 類型,設定為 'WebHook'。 'AzureFunction'
“EventHub”
“HybridConnection”
“監視器警報”
'命名空間主題'
“合作夥伴目的地”
“ServiceBusQueue”
“ServiceBusTopic”
“StorageQueue”
'WebHook' (必要)

EventSubscriptionIdentity

名稱 說明 價值觀
federatedIdentityCredentialInfo 與資源傳遞搭配使用的同盟身分識別認證 (FIC) 詳細數據。 FederatedIdentityCredentialInfo
型別 所使用的受控識別類型。 可以是 'SystemAssigned' 或 'UserAssigned'。 “系統分配”
'UserAssigned'
使用者指定身份 與資源相關聯的使用者身分識別。 字串

FederatedIdentityCredentialInfo

名稱 說明 價值觀
federatedClientId 與聯合身份憑證 (FIC) 關聯的多租戶 Microsoft Entra ID 應用程式。 字串

約束:
最小長度 = 36
最大長度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (必要)

篩選器

名稱 說明 價值觀
Key 事件中的欄位/屬性,根據您想要篩選的欄位/屬性。 字串
運算子類型 設定為 BoolEquals 類型為 'BoolEqualsFilter'。 針對 IsNotNullFilter類型,設定為 'IsNotNull'。 針對 IsNullOrUndefinedFilter類型,設定為 『IsNullOrUndefined』。 針對 NumberGreaterThanFilter 類型,設定為 『NumberGreaterThan』。 針對 NumberGreaterThanOrEquals 類型,設定為 『NumberGreaterThanOrEquals』。 設定為 NumberInFilter 類型的 『NumberIn』。 設定為 NumberInRangeFilter 類型的 『NumberInRange』。 針對 NumberLessThanFilter 類型設定為 『NumberLessThan』。 針對 NumberLessThanOrEqualsFilter 類型,設定為 『NumberLessThanOrEquals』。 設定為 NumberNotInFilter 類型的 『NumberNotIn』。 針對 NumberNotInRangeFilter 類型,設定為 『NumberNotInRange』。 針對 StringBeginsWithFilter 類型,設定為 『StringBeginsWith』。 設定為 StringContainsFilter 類型的 『StringContains』。 針對 StringEndsWithFilter 類型,設定為 『StringEndsWith』。 設定為 StringInFilter 類型的 『StringIn』。 針對 StringNotBeginsWithFilter 類型,設定為 『StringNotBeginsWith』。 針對 StringNotContainsFilter 類型,設定為 『StringNotContains』。 針對 StringNotEndsWithFilter 類型,設定為 『StringNotEndsWith』。 針對 StringNotInFilter 類型,設定為 『StringNotIn』。 'BoolEquals'
“IsNotNull”
'IsNullOrUndefined'
'NumberGreaterThan'
'NumberGreaterThanOrEquals'
'NumberIn'
'NumberInRange'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'NumberNotInRange'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn' (字符串)
'StringNotBeginsWith'
'StringNotContains'
'StringNotEndsWith'
'StringNotIn' (必要)

FiltersConfiguration

名稱 說明 價值觀
過濾器 篩選事件訂閱所使用的篩選陣列。 篩選[]
includedEventTypes 需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有預設事件類型,請將 IncludedEventTypes 設定為 null。 字串[]

HybridConnectionEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'HybridConnection' (必要)
屬性 事件訂用帳戶目的地的混合式連線屬性。 HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'IsNotNull' (必要)

IsNullOrUndefinedFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'IsNullOrUndefined' (必要)

監視器警報事件訂閱目標

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'MonitorAlert' (必要)
屬性 監視事件訂用帳戶目的地的警示屬性。 MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

名稱 說明 價值觀
作組 在透過此事件訂用帳戶引發的每個警示上觸發的ARM標識碼動作群組清單。
每個資源 ARM 標識符都應該遵循下列模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}。
字串[]
說明 將附加至透過此事件訂用帳戶引發之每個警示的描述。 字串
嚴厲 將附加至透過此事件訂用帳戶引發之每個警示的嚴重性。
必須提供此欄位。
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'NamespaceTopic' (必要)
屬性 事件訂用帳戶目的地的命名空間主題屬性。 NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

名稱 說明 價值觀
資源ID Azure 資源識別碼,表示事件訂用帳戶之事件方格命名空間主題目的地的端點。
此欄位為必要欄位,且列出的命名空間主題資源必須已經存在。
資源 ARM 標識符應該遵循下列模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}。
字串

NumberGreaterThanFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberGreaterThan' (必要)
價值 篩選值。 整數 (int)

NumberGreaterThanOrEqualsFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberGreaterThanOrEquals' (必要)
價值 篩選值。 整數 (int)

NumberInFilter (數字篩選)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberIn' (必要)
價值觀 一組篩選值。 int[]

NumberInRangeFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberInRange' (必要)
價值觀 一組篩選值。 int[][]

NumberLessThanFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberLessThan' (必要)
價值 篩選值。 整數 (int)

NumberLessThanOrEqualsFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberLessThanOrEquals' (必要)
價值 篩選值。 整數 (int)

NumberNotInFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberNotIn' (必要)
價值觀 一組篩選值。 int[]

NumberNotInRangeFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberNotInRange' (必要)
價值觀 一組篩選值。 int[][]

PartnerEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'PartnerDestination' (必要)
屬性 事件訂用帳戶目的地的合作夥伴目的地屬性。 PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

名稱 說明 價值觀
資源ID 代表事件訂用帳戶合作夥伴目的地端點的 Azure 資源識別碼。 字串

推送資訊

名稱 說明 價值觀
deadLetterDestinationWithResourceIdentity 事件訂閱的寄不出的信件目的地。 無法傳遞至其目的地的任何事件都會傳送至寄不出的信件目的地。
使用父資源上的受控識別設定(即命名空間)來取得在寄不出的信件期間使用的驗證令牌。
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity 事件訂閱必須傳遞事件目的地的相關信息。
使用父資源上的受控識別設定(即主題或網域)來取得傳遞期間所使用的驗證令牌。
DeliveryWithResourceIdentity
目的地 事件訂閱必須傳遞事件目的地的相關信息。
使用 Azure 事件方格的身分識別來取得傳遞期間所使用的驗證令牌。
EventSubscriptionDestination 事件訂閱目標
eventTimeToLive ISO 8601 格式的時間範圍持續時間,決定從發佈訊息的時間起,訂閱可以使用多久的訊息。
此持續時間值使用下列格式表示:'P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 會取代為後面每個時間元素的值(n)。
- P 是持續時間(或期間)指示項,且一律放在持續時間的開頭。
- Y 是年份指示項,它會遵循年份數的值。
- M 是月份指示項,它會遵循月份數的值。
- W 是周指示項,它會遵循周數的值。
- D 是日期指示項,它會遵循天數的值。
- T 是時間指示項,在時間元件之前。
- H 是小時指示項,它會遵循小時數的值。
- M 是分鐘指示項,它會遵循分鐘數的值。
- S 是第二個指示項,它會遵循秒數的值。
此持續時間值無法設定大於主題的 EventRetentionInDays。 這是選擇性欄位,其最小值為 1 分鐘,並決定其最大值
依主題的 EventRetentionInDays 值。 以下是有效值的範例:
- 'P0DT23H12M' 或 'PT23H12M':持續時間為 23 小時 12 分鐘。
- 'P1D' 或 'P1DT0H0M0S':持續時間為 1 天。
字串
maxDeliveryCount 事件的最大傳遞計數。 整數 (int)

佇列資訊

名稱 說明 價值觀
deadLetterDestinationWithResourceIdentity 事件訂閱的寄不出的信件目的地。 無法傳遞至其目的地的任何事件都會傳送至寄不出的信件目的地。
使用父資源上的受控識別設定(即主題)來取得傳遞/寄不出的信件期間所使用的驗證令牌。
DeadLetterWithResourceIdentity
eventTimeToLive ISO 8601 格式的時間範圍持續時間,決定從發佈訊息的時間起,訂閱可以使用多久的訊息。
此持續時間值使用下列格式表示:'P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 會取代為後面每個時間元素的值(n)。
- P 是持續時間(或期間)指示項,且一律放在持續時間的開頭。
- Y 是年份指示項,它會遵循年份數的值。
- M 是月份指示項,它會遵循月份數的值。
- W 是周指示項,它會遵循周數的值。
- D 是日期指示項,它會遵循天數的值。
- T 是時間指示項,在時間元件之前。
- H 是小時指示項,它會遵循小時數的值。
- M 是分鐘指示項,它會遵循分鐘數的值。
- S 是第二個指示項,它會遵循秒數的值。
此持續時間值無法設定大於主題的 EventRetentionInDays。 這是選擇性欄位,其最小值為 1 分鐘,並決定其最大值
依主題的 EventRetentionInDays 值。 以下是有效值的範例:
- 'P0DT23H12M' 或 'PT23H12M':持續時間為 23 小時 12 分鐘。
- 'P1D' 或 'P1DT0H0M0S':持續時間為 1 天。
字串
maxDeliveryCount 事件的最大傳遞計數。 整數 (int)
receiveLockDurationInSeconds 在收到訊息並等待接受、釋放或拒絕的秒數上限期間。
如果在用戶端收到訊息後經過此時間,且未轉換為已接受(未處理)、已釋出或拒絕,
訊息可用於重新傳遞。 這是選擇性欄位,預設值為 60 秒,最小值為 60 秒,最大值為 300 秒。
整數 (int)

ServiceBusQueueEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'ServiceBusQueue' (必要)
屬性 事件訂用帳戶目的地的服務總線屬性。 ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

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

ServiceBusTopicEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'ServiceBusTopic' (必要)
屬性 事件訂用帳戶目的地的服務總線主題屬性。 ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

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

StaticDeliveryAttributeMapping

名稱 說明 價值觀
屬性 靜態傳遞屬性對應的屬性。 StaticDeliveryAttributeMappingProperties
型別 傳遞屬性或標頭名稱的類型。 'Static' (必要)

StaticDeliveryAttributeMappingProperties

名稱 說明 價值觀
isSecret 的 布林值旗標,指出屬性是否包含敏感性資訊 。 布爾 (bool)
價值 傳遞屬性的值。 字串

StorageBlobDeadLetterDestination

名稱 說明 價值觀
endpoint類型 寄不出的信件目的地的端點類型 'StorageBlob' (必要)
屬性 記憶體 Blob 型死機目的地的屬性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名稱 說明 價值觀
blobContainerName (斑點容器名稱) 記憶體 Blob 容器的名稱,該容器是死機事件的目的地 字串
資源ID 記憶體帳戶的 Azure 資源識別符,這是死機事件的目的地 字串

StorageQueueEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'StorageQueue' (必要)
屬性 事件訂用帳戶目的地的記憶體佇列屬性。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

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

StringBeginsWithFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringBeginsWith' (必要)
價值觀 一組篩選值。 字串[]

StringContainsFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringContains' (必要)
價值觀 一組篩選值。 字串[]

StringEndsWithFilter (字串結束與篩檢程式)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringEndsWith' (必要)
價值觀 一組篩選值。 字串[]

StringInFilter (字串過濾器)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringIn' (必要)
價值觀 一組篩選值。 字串[]

StringNotBeginsWithFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringNotBeginsWith' (必要)
價值觀 一組篩選值。 字串[]

StringNotContains過濾器

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringNotContains' (必要)
價值觀 一組篩選值。 字串[]

StringNotEndsWithFilter (字串不結束與篩檢程式)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringNotEndsWith' (必要)
價值觀 一組篩選值。 字串[]

StringNotInFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringNotIn' (必要)
價值觀 一組篩選值。 字串[]

SubscriptionProperties

名稱 說明 價值觀
deliveryConfiguration 事件訂閱傳遞設定的相關信息。 DeliveryConfiguration
eventDeliverySchema 事件交付架構 事件訂閱的事件傳遞架構。 “CloudEventSchemaV1_0”
過期時間 UTC 事件訂閱的到期時間。 字串
filtersConfiguration 事件訂閱篩選的相關信息。 FiltersConfiguration
標記 與事件訂用帳戶資源相關的標記。 SubscriptionProperties標籤

SubscriptionProperties標籤

名稱 說明 價值觀

WebHookEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'WebHook' (必要)
屬性 事件訂用帳戶目的地的 WebHook 屬性。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名稱 說明 價值觀
azureActiveDirectoryApplicationIdOrUri Microsoft Entra ID 應用程式 ID 或 URI,用於獲取將作為不記名令牌包含在投放請求中的訪問令牌。 字串
azureActiveDirectoryTenantId Microsoft Entra ID 租戶 ID,用於獲取將作為不記名令牌包含在投放請求中的訪問令牌。 字串
deliveryAttributeMappings 傳遞屬性詳細數據。 DeliveryAttributeMapping[]
端點網址 表示事件訂用帳戶目的地端點的 URL。 字串

約束:
敏感性值。 以安全參數的形式傳入。
maxEventsPerBatch 每個批次的事件數目上限。 整數 (int)
minimumTlsVersionAllowed Webhook 端點應支援的最小 TLS 版本 '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes 慣用的批次大小以 KB 為單位。 整數 (int)

ARM 樣本資源定義

命名空間/topics/eventSubscriptions 資源類型可以使用目標作業來部署:

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

資源格式

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

{
  "type": "Microsoft.EventGrid/namespaces/topics/eventSubscriptions",
  "apiVersion": "2025-04-01-preview",
  "name": "string",
  "properties": {
    "deliveryConfiguration": {
      "deliveryMode": "string",
      "push": {
        "deadLetterDestinationWithResourceIdentity": {
          "deadLetterDestination": {
            "endpointType": "string"
            // For remaining properties, see DeadLetterDestination objects
          },
          "identity": {
            "federatedIdentityCredentialInfo": {
              "federatedClientId": "string"
            },
            "type": "string",
            "userAssignedIdentity": "string"
          }
        },
        "deliveryWithResourceIdentity": {
          "destination": {
            "endpointType": "string"
            // For remaining properties, see EventSubscriptionDestination objects
          },
          "identity": {
            "federatedIdentityCredentialInfo": {
              "federatedClientId": "string"
            },
            "type": "string",
            "userAssignedIdentity": "string"
          }
        },
        "destination": {
          "endpointType": "string"
          // For remaining properties, see EventSubscriptionDestination objects
        },
        "eventTimeToLive": "string",
        "maxDeliveryCount": "int"
      },
      "queue": {
        "deadLetterDestinationWithResourceIdentity": {
          "deadLetterDestination": {
            "endpointType": "string"
            // For remaining properties, see DeadLetterDestination objects
          },
          "identity": {
            "federatedIdentityCredentialInfo": {
              "federatedClientId": "string"
            },
            "type": "string",
            "userAssignedIdentity": "string"
          }
        },
        "eventTimeToLive": "string",
        "maxDeliveryCount": "int",
        "receiveLockDurationInSeconds": "int"
      }
    },
    "eventDeliverySchema": "string",
    "expirationTimeUtc": "string",
    "filtersConfiguration": {
      "filters": [ {
        "key": "string",
        "operatorType": "string"
        // For remaining properties, see Filter objects
      } ],
      "includedEventTypes": [ "string" ]
    },
    "tags": {
      "{customized property}": "string"
    }
  }
}

DeadLetterDestination 物件

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

針對 StorageBlob,請使用:

{
  "endpointType": "StorageBlob",
  "properties": {
    "blobContainerName": "string",
    "resourceId": "string"
  }
}

DeliveryAttributeMapping 物件

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

針對 Dynamic,請使用:

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

針對 Static,請使用:

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

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

針對 MonitorAlert,請使用:

{
  "endpointType": "MonitorAlert",
  "properties": {
    "actionGroups": [ "string" ],
    "description": "string",
    "severity": "string"
  }
}

針對 NamespaceTopic,請使用:

{
  "endpointType": "NamespaceTopic",
  "properties": {
    "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"
  }
}

篩選物件

設定 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" ]
}

屬性值

Microsoft.EventGrid/namespaces/topics/eventSubscriptions

名稱 說明 價值觀
apiVersion API 版本 “2025-04-01-預覽”
名稱 資源名稱 字串

約束:
最小長度 = 3
最大長度 = 50
模式 = ^[a-zA-Z0-9-]*$ (必要)
屬性 事件訂閱的屬性。 SubscriptionProperties
型別 資源類型 “Microsoft.EventGrid/namespaces/topics/eventSubscriptions”

AzureFunctionEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'AzureFunction' (必要)
屬性 事件訂用帳戶目的地的 Azure 函式屬性。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsFilter (布林等於篩檢程式)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'BoolEquals' (必要)
價值 布爾篩選值。 布爾 (bool)

死信目標

名稱 說明 價值觀
endpoint類型 針對 storageBlobDeadLetterDestination類型 設定為 'StorageBlob'。 'StorageBlob' (必要)

DeadLetterWithResourceIdentity

名稱 說明 價值觀
deadLetterDestination 的 事件訂閱必須傳遞事件目的地的相關信息。
使用父資源上的受控識別設定(即主題或網域)來取得在寄不出的信件期間使用的驗證令牌。
死信目標
身分識別 當寄不出的信件事件時要使用的身分識別。 EventSubscriptionIdentity

DeliveryAttributeMapping

名稱 說明 價值觀
名稱 傳遞屬性或標頭的名稱。 字串
型別 針對 DynamicDeliveryAttributeMapping 類型設定為 『Dynamic』。 設定為 StaticDeliveryAttributeMapping 類型的 『Static』。 “動態”
'Static' (必要)

DeliveryConfiguration

名稱 說明 價值觀
deliveryMode 交付模式 事件訂閱的傳遞模式。 “推”
“佇列”
推送 當 deliveryMode 為 push 時,應該填入這個屬性,並代表發送訂閱的相關信息。 推送資訊
佇列 當 deliveryMode 為 queue 時,應該填入這個屬性,並代表佇列訂閱的相關信息。 佇列資訊

DeliveryWithResourceIdentity

名稱 說明 價值觀
目的地 事件訂閱必須傳遞事件目的地的相關信息。
使用父資源上的受控識別設定(即主題或網域)來取得傳遞期間所使用的驗證令牌。
EventSubscriptionDestination 事件訂閱目標
身分識別 傳遞事件時要使用的身分識別。 EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

名稱 說明 價值觀
屬性 動態傳遞屬性對應的屬性。 DynamicDeliveryAttributeMappingProperties
型別 傳遞屬性或標頭名稱的類型。 'Dynamic' (必要)

DynamicDeliveryAttributeMappingProperties

名稱 說明 價值觀
sourceField 事件中包含屬性值的 JSON 路徑。 字串

EventHubEventSubscriptionDestination 事件訂閱目標

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'EventHub' (必要)
屬性 事件訂用帳戶目的地的事件中樞屬性。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination 事件訂閱目標

名稱 說明 價值觀
endpoint類型 針對 AzureFunctionEventSubscriptionDestination 類型,設定為 『AzureFunction』。 針對 eventHubEventSubscriptionDestination類型 設定為 'EventHub'。 針對 hybridConnectionEventSubscriptionDestination類型 ,設定為 'HybridConnection'。 設定為 MonitorAlertEventSubscriptionDestination 類型的 'MonitorAlert'。 設定為 NamespaceTopicEventSubscriptionDestination 類型的 'NamespaceTopic'。 針對 PartnerEventSubscriptionDestination 類型,設定為 'PartnerDestination'。 設定為 ServiceBusQueueEventSubscriptionDestination 類型的 'ServiceBusQueue'。 針對 ServiceBusTopicEventSubscriptionDestination 類型,設定為 'ServiceBusTopic'。 針對 storageQueueEventSubscriptionDestination類型 設定為 'StorageQueue'。 針對 WebHookEventSubscriptionDestination 類型,設定為 'WebHook'。 'AzureFunction'
“EventHub”
“HybridConnection”
“監視器警報”
'命名空間主題'
“合作夥伴目的地”
“ServiceBusQueue”
“ServiceBusTopic”
“StorageQueue”
'WebHook' (必要)

EventSubscriptionIdentity

名稱 說明 價值觀
federatedIdentityCredentialInfo 與資源傳遞搭配使用的同盟身分識別認證 (FIC) 詳細數據。 FederatedIdentityCredentialInfo
型別 所使用的受控識別類型。 可以是 'SystemAssigned' 或 'UserAssigned'。 “系統分配”
'UserAssigned'
使用者指定身份 與資源相關聯的使用者身分識別。 字串

FederatedIdentityCredentialInfo

名稱 說明 價值觀
federatedClientId 與聯合身份憑證 (FIC) 關聯的多租戶 Microsoft Entra ID 應用程式。 字串

約束:
最小長度 = 36
最大長度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (必要)

篩選器

名稱 說明 價值觀
Key 事件中的欄位/屬性,根據您想要篩選的欄位/屬性。 字串
運算子類型 設定為 BoolEquals 類型為 'BoolEqualsFilter'。 針對 IsNotNullFilter類型,設定為 'IsNotNull'。 針對 IsNullOrUndefinedFilter類型,設定為 『IsNullOrUndefined』。 針對 NumberGreaterThanFilter 類型,設定為 『NumberGreaterThan』。 針對 NumberGreaterThanOrEquals 類型,設定為 『NumberGreaterThanOrEquals』。 設定為 NumberInFilter 類型的 『NumberIn』。 設定為 NumberInRangeFilter 類型的 『NumberInRange』。 針對 NumberLessThanFilter 類型設定為 『NumberLessThan』。 針對 NumberLessThanOrEqualsFilter 類型,設定為 『NumberLessThanOrEquals』。 設定為 NumberNotInFilter 類型的 『NumberNotIn』。 針對 NumberNotInRangeFilter 類型,設定為 『NumberNotInRange』。 針對 StringBeginsWithFilter 類型,設定為 『StringBeginsWith』。 設定為 StringContainsFilter 類型的 『StringContains』。 針對 StringEndsWithFilter 類型,設定為 『StringEndsWith』。 設定為 StringInFilter 類型的 『StringIn』。 針對 StringNotBeginsWithFilter 類型,設定為 『StringNotBeginsWith』。 針對 StringNotContainsFilter 類型,設定為 『StringNotContains』。 針對 StringNotEndsWithFilter 類型,設定為 『StringNotEndsWith』。 針對 StringNotInFilter 類型,設定為 『StringNotIn』。 'BoolEquals'
“IsNotNull”
'IsNullOrUndefined'
'NumberGreaterThan'
'NumberGreaterThanOrEquals'
'NumberIn'
'NumberInRange'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'NumberNotInRange'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn' (字符串)
'StringNotBeginsWith'
'StringNotContains'
'StringNotEndsWith'
'StringNotIn' (必要)

FiltersConfiguration

名稱 說明 價值觀
過濾器 篩選事件訂閱所使用的篩選陣列。 篩選[]
includedEventTypes 需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有預設事件類型,請將 IncludedEventTypes 設定為 null。 字串[]

HybridConnectionEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'HybridConnection' (必要)
屬性 事件訂用帳戶目的地的混合式連線屬性。 HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'IsNotNull' (必要)

IsNullOrUndefinedFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'IsNullOrUndefined' (必要)

監視器警報事件訂閱目標

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'MonitorAlert' (必要)
屬性 監視事件訂用帳戶目的地的警示屬性。 MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

名稱 說明 價值觀
作組 在透過此事件訂用帳戶引發的每個警示上觸發的ARM標識碼動作群組清單。
每個資源 ARM 標識符都應該遵循下列模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}。
字串[]
說明 將附加至透過此事件訂用帳戶引發之每個警示的描述。 字串
嚴厲 將附加至透過此事件訂用帳戶引發之每個警示的嚴重性。
必須提供此欄位。
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'NamespaceTopic' (必要)
屬性 事件訂用帳戶目的地的命名空間主題屬性。 NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

名稱 說明 價值觀
資源ID Azure 資源識別碼,表示事件訂用帳戶之事件方格命名空間主題目的地的端點。
此欄位為必要欄位,且列出的命名空間主題資源必須已經存在。
資源 ARM 標識符應該遵循下列模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}。
字串

NumberGreaterThanFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberGreaterThan' (必要)
價值 篩選值。 整數 (int)

NumberGreaterThanOrEqualsFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberGreaterThanOrEquals' (必要)
價值 篩選值。 整數 (int)

NumberInFilter (數字篩選)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberIn' (必要)
價值觀 一組篩選值。 int[]

NumberInRangeFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberInRange' (必要)
價值觀 一組篩選值。 int[][]

NumberLessThanFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberLessThan' (必要)
價值 篩選值。 整數 (int)

NumberLessThanOrEqualsFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberLessThanOrEquals' (必要)
價值 篩選值。 整數 (int)

NumberNotInFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberNotIn' (必要)
價值觀 一組篩選值。 int[]

NumberNotInRangeFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberNotInRange' (必要)
價值觀 一組篩選值。 int[][]

PartnerEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'PartnerDestination' (必要)
屬性 事件訂用帳戶目的地的合作夥伴目的地屬性。 PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

名稱 說明 價值觀
資源ID 代表事件訂用帳戶合作夥伴目的地端點的 Azure 資源識別碼。 字串

推送資訊

名稱 說明 價值觀
deadLetterDestinationWithResourceIdentity 事件訂閱的寄不出的信件目的地。 無法傳遞至其目的地的任何事件都會傳送至寄不出的信件目的地。
使用父資源上的受控識別設定(即命名空間)來取得在寄不出的信件期間使用的驗證令牌。
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity 事件訂閱必須傳遞事件目的地的相關信息。
使用父資源上的受控識別設定(即主題或網域)來取得傳遞期間所使用的驗證令牌。
DeliveryWithResourceIdentity
目的地 事件訂閱必須傳遞事件目的地的相關信息。
使用 Azure 事件方格的身分識別來取得傳遞期間所使用的驗證令牌。
EventSubscriptionDestination 事件訂閱目標
eventTimeToLive ISO 8601 格式的時間範圍持續時間,決定從發佈訊息的時間起,訂閱可以使用多久的訊息。
此持續時間值使用下列格式表示:'P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 會取代為後面每個時間元素的值(n)。
- P 是持續時間(或期間)指示項,且一律放在持續時間的開頭。
- Y 是年份指示項,它會遵循年份數的值。
- M 是月份指示項,它會遵循月份數的值。
- W 是周指示項,它會遵循周數的值。
- D 是日期指示項,它會遵循天數的值。
- T 是時間指示項,在時間元件之前。
- H 是小時指示項,它會遵循小時數的值。
- M 是分鐘指示項,它會遵循分鐘數的值。
- S 是第二個指示項,它會遵循秒數的值。
此持續時間值無法設定大於主題的 EventRetentionInDays。 這是選擇性欄位,其最小值為 1 分鐘,並決定其最大值
依主題的 EventRetentionInDays 值。 以下是有效值的範例:
- 'P0DT23H12M' 或 'PT23H12M':持續時間為 23 小時 12 分鐘。
- 'P1D' 或 'P1DT0H0M0S':持續時間為 1 天。
字串
maxDeliveryCount 事件的最大傳遞計數。 整數 (int)

佇列資訊

名稱 說明 價值觀
deadLetterDestinationWithResourceIdentity 事件訂閱的寄不出的信件目的地。 無法傳遞至其目的地的任何事件都會傳送至寄不出的信件目的地。
使用父資源上的受控識別設定(即主題)來取得傳遞/寄不出的信件期間所使用的驗證令牌。
DeadLetterWithResourceIdentity
eventTimeToLive ISO 8601 格式的時間範圍持續時間,決定從發佈訊息的時間起,訂閱可以使用多久的訊息。
此持續時間值使用下列格式表示:'P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 會取代為後面每個時間元素的值(n)。
- P 是持續時間(或期間)指示項,且一律放在持續時間的開頭。
- Y 是年份指示項,它會遵循年份數的值。
- M 是月份指示項,它會遵循月份數的值。
- W 是周指示項,它會遵循周數的值。
- D 是日期指示項,它會遵循天數的值。
- T 是時間指示項,在時間元件之前。
- H 是小時指示項,它會遵循小時數的值。
- M 是分鐘指示項,它會遵循分鐘數的值。
- S 是第二個指示項,它會遵循秒數的值。
此持續時間值無法設定大於主題的 EventRetentionInDays。 這是選擇性欄位,其最小值為 1 分鐘,並決定其最大值
依主題的 EventRetentionInDays 值。 以下是有效值的範例:
- 'P0DT23H12M' 或 'PT23H12M':持續時間為 23 小時 12 分鐘。
- 'P1D' 或 'P1DT0H0M0S':持續時間為 1 天。
字串
maxDeliveryCount 事件的最大傳遞計數。 整數 (int)
receiveLockDurationInSeconds 在收到訊息並等待接受、釋放或拒絕的秒數上限期間。
如果在用戶端收到訊息後經過此時間,且未轉換為已接受(未處理)、已釋出或拒絕,
訊息可用於重新傳遞。 這是選擇性欄位,預設值為 60 秒,最小值為 60 秒,最大值為 300 秒。
整數 (int)

ServiceBusQueueEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'ServiceBusQueue' (必要)
屬性 事件訂用帳戶目的地的服務總線屬性。 ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

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

ServiceBusTopicEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'ServiceBusTopic' (必要)
屬性 事件訂用帳戶目的地的服務總線主題屬性。 ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

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

StaticDeliveryAttributeMapping

名稱 說明 價值觀
屬性 靜態傳遞屬性對應的屬性。 StaticDeliveryAttributeMappingProperties
型別 傳遞屬性或標頭名稱的類型。 'Static' (必要)

StaticDeliveryAttributeMappingProperties

名稱 說明 價值觀
isSecret 的 布林值旗標,指出屬性是否包含敏感性資訊 。 布爾 (bool)
價值 傳遞屬性的值。 字串

StorageBlobDeadLetterDestination

名稱 說明 價值觀
endpoint類型 寄不出的信件目的地的端點類型 'StorageBlob' (必要)
屬性 記憶體 Blob 型死機目的地的屬性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名稱 說明 價值觀
blobContainerName (斑點容器名稱) 記憶體 Blob 容器的名稱,該容器是死機事件的目的地 字串
資源ID 記憶體帳戶的 Azure 資源識別符,這是死機事件的目的地 字串

StorageQueueEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'StorageQueue' (必要)
屬性 事件訂用帳戶目的地的記憶體佇列屬性。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

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

StringBeginsWithFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringBeginsWith' (必要)
價值觀 一組篩選值。 字串[]

StringContainsFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringContains' (必要)
價值觀 一組篩選值。 字串[]

StringEndsWithFilter (字串結束與篩檢程式)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringEndsWith' (必要)
價值觀 一組篩選值。 字串[]

StringInFilter (字串過濾器)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringIn' (必要)
價值觀 一組篩選值。 字串[]

StringNotBeginsWithFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringNotBeginsWith' (必要)
價值觀 一組篩選值。 字串[]

StringNotContains過濾器

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringNotContains' (必要)
價值觀 一組篩選值。 字串[]

StringNotEndsWithFilter (字串不結束與篩檢程式)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringNotEndsWith' (必要)
價值觀 一組篩選值。 字串[]

StringNotInFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringNotIn' (必要)
價值觀 一組篩選值。 字串[]

SubscriptionProperties

名稱 說明 價值觀
deliveryConfiguration 事件訂閱傳遞設定的相關信息。 DeliveryConfiguration
eventDeliverySchema 事件交付架構 事件訂閱的事件傳遞架構。 “CloudEventSchemaV1_0”
過期時間 UTC 事件訂閱的到期時間。 字串
filtersConfiguration 事件訂閱篩選的相關信息。 FiltersConfiguration
標記 與事件訂用帳戶資源相關的標記。 SubscriptionProperties標籤

SubscriptionProperties標籤

名稱 說明 價值觀

WebHookEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'WebHook' (必要)
屬性 事件訂用帳戶目的地的 WebHook 屬性。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名稱 說明 價值觀
azureActiveDirectoryApplicationIdOrUri Microsoft Entra ID 應用程式 ID 或 URI,用於獲取將作為不記名令牌包含在投放請求中的訪問令牌。 字串
azureActiveDirectoryTenantId Microsoft Entra ID 租戶 ID,用於獲取將作為不記名令牌包含在投放請求中的訪問令牌。 字串
deliveryAttributeMappings 傳遞屬性詳細數據。 DeliveryAttributeMapping[]
端點網址 表示事件訂用帳戶目的地端點的 URL。 字串

約束:
敏感性值。 以安全參數的形式傳入。
maxEventsPerBatch 每個批次的事件數目上限。 整數 (int)
minimumTlsVersionAllowed Webhook 端點應支援的最小 TLS 版本 '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes 慣用的批次大小以 KB 為單位。 整數 (int)

使用範例

Terraform (AzAPI 提供者) 資源定義

命名空間/topics/eventSubscriptions 資源類型可以使用目標作業來部署:

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2025-04-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      deliveryConfiguration = {
        deliveryMode = "string"
        push = {
          deadLetterDestinationWithResourceIdentity = {
            deadLetterDestination = {
              endpointType = "string"
              // For remaining properties, see DeadLetterDestination objects
            }
            identity = {
              federatedIdentityCredentialInfo = {
                federatedClientId = "string"
              }
              type = "string"
              userAssignedIdentity = "string"
            }
          }
          deliveryWithResourceIdentity = {
            destination = {
              endpointType = "string"
              // For remaining properties, see EventSubscriptionDestination objects
            }
            identity = {
              federatedIdentityCredentialInfo = {
                federatedClientId = "string"
              }
              type = "string"
              userAssignedIdentity = "string"
            }
          }
          destination = {
            endpointType = "string"
            // For remaining properties, see EventSubscriptionDestination objects
          }
          eventTimeToLive = "string"
          maxDeliveryCount = int
        }
        queue = {
          deadLetterDestinationWithResourceIdentity = {
            deadLetterDestination = {
              endpointType = "string"
              // For remaining properties, see DeadLetterDestination objects
            }
            identity = {
              federatedIdentityCredentialInfo = {
                federatedClientId = "string"
              }
              type = "string"
              userAssignedIdentity = "string"
            }
          }
          eventTimeToLive = "string"
          maxDeliveryCount = int
          receiveLockDurationInSeconds = int
        }
      }
      eventDeliverySchema = "string"
      expirationTimeUtc = "string"
      filtersConfiguration = {
        filters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see Filter objects
          }
        ]
        includedEventTypes = [
          "string"
        ]
      }
      tags = {
        {customized property} = "string"
      }
    }
  }
}

DeadLetterDestination 物件

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

針對 StorageBlob,請使用:

{
  endpointType = "StorageBlob"
  properties = {
    blobContainerName = "string"
    resourceId = "string"
  }
}

DeliveryAttributeMapping 物件

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

針對 Dynamic,請使用:

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

針對 Static,請使用:

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

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

針對 MonitorAlert,請使用:

{
  endpointType = "MonitorAlert"
  properties = {
    actionGroups = [
      "string"
    ]
    description = "string"
    severity = "string"
  }
}

針對 NamespaceTopic,請使用:

{
  endpointType = "NamespaceTopic"
  properties = {
    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
  }
}

篩選物件

設定 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"
  ]
}

屬性值

Microsoft.EventGrid/namespaces/topics/eventSubscriptions

名稱 說明 價值觀
名稱 資源名稱 字串

約束:
最小長度 = 3
最大長度 = 50
模式 = ^[a-zA-Z0-9-]*$ (必要)
父項識別碼 此資源為父系之資源的標識碼。 類型資源的識別碼: 命名空間/主題
屬性 事件訂閱的屬性。 SubscriptionProperties
型別 資源類型 “Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2025-04-01-preview”

AzureFunctionEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'AzureFunction' (必要)
屬性 事件訂用帳戶目的地的 Azure 函式屬性。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsFilter (布林等於篩檢程式)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'BoolEquals' (必要)
價值 布爾篩選值。 布爾 (bool)

死信目標

名稱 說明 價值觀
endpoint類型 針對 storageBlobDeadLetterDestination類型 設定為 'StorageBlob'。 'StorageBlob' (必要)

DeadLetterWithResourceIdentity

名稱 說明 價值觀
deadLetterDestination 的 事件訂閱必須傳遞事件目的地的相關信息。
使用父資源上的受控識別設定(即主題或網域)來取得在寄不出的信件期間使用的驗證令牌。
死信目標
身分識別 當寄不出的信件事件時要使用的身分識別。 EventSubscriptionIdentity

DeliveryAttributeMapping

名稱 說明 價值觀
名稱 傳遞屬性或標頭的名稱。 字串
型別 針對 DynamicDeliveryAttributeMapping 類型設定為 『Dynamic』。 設定為 StaticDeliveryAttributeMapping 類型的 『Static』。 “動態”
'Static' (必要)

DeliveryConfiguration

名稱 說明 價值觀
deliveryMode 交付模式 事件訂閱的傳遞模式。 “推”
“佇列”
推送 當 deliveryMode 為 push 時,應該填入這個屬性,並代表發送訂閱的相關信息。 推送資訊
佇列 當 deliveryMode 為 queue 時,應該填入這個屬性,並代表佇列訂閱的相關信息。 佇列資訊

DeliveryWithResourceIdentity

名稱 說明 價值觀
目的地 事件訂閱必須傳遞事件目的地的相關信息。
使用父資源上的受控識別設定(即主題或網域)來取得傳遞期間所使用的驗證令牌。
EventSubscriptionDestination 事件訂閱目標
身分識別 傳遞事件時要使用的身分識別。 EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

名稱 說明 價值觀
屬性 動態傳遞屬性對應的屬性。 DynamicDeliveryAttributeMappingProperties
型別 傳遞屬性或標頭名稱的類型。 'Dynamic' (必要)

DynamicDeliveryAttributeMappingProperties

名稱 說明 價值觀
sourceField 事件中包含屬性值的 JSON 路徑。 字串

EventHubEventSubscriptionDestination 事件訂閱目標

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'EventHub' (必要)
屬性 事件訂用帳戶目的地的事件中樞屬性。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination 事件訂閱目標

名稱 說明 價值觀
endpoint類型 針對 AzureFunctionEventSubscriptionDestination 類型,設定為 『AzureFunction』。 針對 eventHubEventSubscriptionDestination類型 設定為 'EventHub'。 針對 hybridConnectionEventSubscriptionDestination類型 ,設定為 'HybridConnection'。 設定為 MonitorAlertEventSubscriptionDestination 類型的 'MonitorAlert'。 設定為 NamespaceTopicEventSubscriptionDestination 類型的 'NamespaceTopic'。 針對 PartnerEventSubscriptionDestination 類型,設定為 'PartnerDestination'。 設定為 ServiceBusQueueEventSubscriptionDestination 類型的 'ServiceBusQueue'。 針對 ServiceBusTopicEventSubscriptionDestination 類型,設定為 'ServiceBusTopic'。 針對 storageQueueEventSubscriptionDestination類型 設定為 'StorageQueue'。 針對 WebHookEventSubscriptionDestination 類型,設定為 'WebHook'。 'AzureFunction'
“EventHub”
“HybridConnection”
“監視器警報”
'命名空間主題'
“合作夥伴目的地”
“ServiceBusQueue”
“ServiceBusTopic”
“StorageQueue”
'WebHook' (必要)

EventSubscriptionIdentity

名稱 說明 價值觀
federatedIdentityCredentialInfo 與資源傳遞搭配使用的同盟身分識別認證 (FIC) 詳細數據。 FederatedIdentityCredentialInfo
型別 所使用的受控識別類型。 可以是 'SystemAssigned' 或 'UserAssigned'。 “系統分配”
'UserAssigned'
使用者指定身份 與資源相關聯的使用者身分識別。 字串

FederatedIdentityCredentialInfo

名稱 說明 價值觀
federatedClientId 與聯合身份憑證 (FIC) 關聯的多租戶 Microsoft Entra ID 應用程式。 字串

約束:
最小長度 = 36
最大長度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (必要)

篩選器

名稱 說明 價值觀
Key 事件中的欄位/屬性,根據您想要篩選的欄位/屬性。 字串
運算子類型 設定為 BoolEquals 類型為 'BoolEqualsFilter'。 針對 IsNotNullFilter類型,設定為 'IsNotNull'。 針對 IsNullOrUndefinedFilter類型,設定為 『IsNullOrUndefined』。 針對 NumberGreaterThanFilter 類型,設定為 『NumberGreaterThan』。 針對 NumberGreaterThanOrEquals 類型,設定為 『NumberGreaterThanOrEquals』。 設定為 NumberInFilter 類型的 『NumberIn』。 設定為 NumberInRangeFilter 類型的 『NumberInRange』。 針對 NumberLessThanFilter 類型設定為 『NumberLessThan』。 針對 NumberLessThanOrEqualsFilter 類型,設定為 『NumberLessThanOrEquals』。 設定為 NumberNotInFilter 類型的 『NumberNotIn』。 針對 NumberNotInRangeFilter 類型,設定為 『NumberNotInRange』。 針對 StringBeginsWithFilter 類型,設定為 『StringBeginsWith』。 設定為 StringContainsFilter 類型的 『StringContains』。 針對 StringEndsWithFilter 類型,設定為 『StringEndsWith』。 設定為 StringInFilter 類型的 『StringIn』。 針對 StringNotBeginsWithFilter 類型,設定為 『StringNotBeginsWith』。 針對 StringNotContainsFilter 類型,設定為 『StringNotContains』。 針對 StringNotEndsWithFilter 類型,設定為 『StringNotEndsWith』。 針對 StringNotInFilter 類型,設定為 『StringNotIn』。 'BoolEquals'
“IsNotNull”
'IsNullOrUndefined'
'NumberGreaterThan'
'NumberGreaterThanOrEquals'
'NumberIn'
'NumberInRange'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'NumberNotInRange'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn' (字符串)
'StringNotBeginsWith'
'StringNotContains'
'StringNotEndsWith'
'StringNotIn' (必要)

FiltersConfiguration

名稱 說明 價值觀
過濾器 篩選事件訂閱所使用的篩選陣列。 篩選[]
includedEventTypes 需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有預設事件類型,請將 IncludedEventTypes 設定為 null。 字串[]

HybridConnectionEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'HybridConnection' (必要)
屬性 事件訂用帳戶目的地的混合式連線屬性。 HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'IsNotNull' (必要)

IsNullOrUndefinedFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'IsNullOrUndefined' (必要)

監視器警報事件訂閱目標

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'MonitorAlert' (必要)
屬性 監視事件訂用帳戶目的地的警示屬性。 MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

名稱 說明 價值觀
作組 在透過此事件訂用帳戶引發的每個警示上觸發的ARM標識碼動作群組清單。
每個資源 ARM 標識符都應該遵循下列模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}。
字串[]
說明 將附加至透過此事件訂用帳戶引發之每個警示的描述。 字串
嚴厲 將附加至透過此事件訂用帳戶引發之每個警示的嚴重性。
必須提供此欄位。
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'NamespaceTopic' (必要)
屬性 事件訂用帳戶目的地的命名空間主題屬性。 NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

名稱 說明 價值觀
資源ID Azure 資源識別碼,表示事件訂用帳戶之事件方格命名空間主題目的地的端點。
此欄位為必要欄位,且列出的命名空間主題資源必須已經存在。
資源 ARM 標識符應該遵循下列模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}。
字串

NumberGreaterThanFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberGreaterThan' (必要)
價值 篩選值。 整數 (int)

NumberGreaterThanOrEqualsFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberGreaterThanOrEquals' (必要)
價值 篩選值。 整數 (int)

NumberInFilter (數字篩選)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberIn' (必要)
價值觀 一組篩選值。 int[]

NumberInRangeFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberInRange' (必要)
價值觀 一組篩選值。 int[][]

NumberLessThanFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberLessThan' (必要)
價值 篩選值。 整數 (int)

NumberLessThanOrEqualsFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberLessThanOrEquals' (必要)
價值 篩選值。 整數 (int)

NumberNotInFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberNotIn' (必要)
價值觀 一組篩選值。 int[]

NumberNotInRangeFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'NumberNotInRange' (必要)
價值觀 一組篩選值。 int[][]

PartnerEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'PartnerDestination' (必要)
屬性 事件訂用帳戶目的地的合作夥伴目的地屬性。 PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

名稱 說明 價值觀
資源ID 代表事件訂用帳戶合作夥伴目的地端點的 Azure 資源識別碼。 字串

推送資訊

名稱 說明 價值觀
deadLetterDestinationWithResourceIdentity 事件訂閱的寄不出的信件目的地。 無法傳遞至其目的地的任何事件都會傳送至寄不出的信件目的地。
使用父資源上的受控識別設定(即命名空間)來取得在寄不出的信件期間使用的驗證令牌。
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity 事件訂閱必須傳遞事件目的地的相關信息。
使用父資源上的受控識別設定(即主題或網域)來取得傳遞期間所使用的驗證令牌。
DeliveryWithResourceIdentity
目的地 事件訂閱必須傳遞事件目的地的相關信息。
使用 Azure 事件方格的身分識別來取得傳遞期間所使用的驗證令牌。
EventSubscriptionDestination 事件訂閱目標
eventTimeToLive ISO 8601 格式的時間範圍持續時間,決定從發佈訊息的時間起,訂閱可以使用多久的訊息。
此持續時間值使用下列格式表示:'P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 會取代為後面每個時間元素的值(n)。
- P 是持續時間(或期間)指示項,且一律放在持續時間的開頭。
- Y 是年份指示項,它會遵循年份數的值。
- M 是月份指示項,它會遵循月份數的值。
- W 是周指示項,它會遵循周數的值。
- D 是日期指示項,它會遵循天數的值。
- T 是時間指示項,在時間元件之前。
- H 是小時指示項,它會遵循小時數的值。
- M 是分鐘指示項,它會遵循分鐘數的值。
- S 是第二個指示項,它會遵循秒數的值。
此持續時間值無法設定大於主題的 EventRetentionInDays。 這是選擇性欄位,其最小值為 1 分鐘,並決定其最大值
依主題的 EventRetentionInDays 值。 以下是有效值的範例:
- 'P0DT23H12M' 或 'PT23H12M':持續時間為 23 小時 12 分鐘。
- 'P1D' 或 'P1DT0H0M0S':持續時間為 1 天。
字串
maxDeliveryCount 事件的最大傳遞計數。 整數 (int)

佇列資訊

名稱 說明 價值觀
deadLetterDestinationWithResourceIdentity 事件訂閱的寄不出的信件目的地。 無法傳遞至其目的地的任何事件都會傳送至寄不出的信件目的地。
使用父資源上的受控識別設定(即主題)來取得傳遞/寄不出的信件期間所使用的驗證令牌。
DeadLetterWithResourceIdentity
eventTimeToLive ISO 8601 格式的時間範圍持續時間,決定從發佈訊息的時間起,訂閱可以使用多久的訊息。
此持續時間值使用下列格式表示:'P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 會取代為後面每個時間元素的值(n)。
- P 是持續時間(或期間)指示項,且一律放在持續時間的開頭。
- Y 是年份指示項,它會遵循年份數的值。
- M 是月份指示項,它會遵循月份數的值。
- W 是周指示項,它會遵循周數的值。
- D 是日期指示項,它會遵循天數的值。
- T 是時間指示項,在時間元件之前。
- H 是小時指示項,它會遵循小時數的值。
- M 是分鐘指示項,它會遵循分鐘數的值。
- S 是第二個指示項,它會遵循秒數的值。
此持續時間值無法設定大於主題的 EventRetentionInDays。 這是選擇性欄位,其最小值為 1 分鐘,並決定其最大值
依主題的 EventRetentionInDays 值。 以下是有效值的範例:
- 'P0DT23H12M' 或 'PT23H12M':持續時間為 23 小時 12 分鐘。
- 'P1D' 或 'P1DT0H0M0S':持續時間為 1 天。
字串
maxDeliveryCount 事件的最大傳遞計數。 整數 (int)
receiveLockDurationInSeconds 在收到訊息並等待接受、釋放或拒絕的秒數上限期間。
如果在用戶端收到訊息後經過此時間,且未轉換為已接受(未處理)、已釋出或拒絕,
訊息可用於重新傳遞。 這是選擇性欄位,預設值為 60 秒,最小值為 60 秒,最大值為 300 秒。
整數 (int)

ServiceBusQueueEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'ServiceBusQueue' (必要)
屬性 事件訂用帳戶目的地的服務總線屬性。 ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

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

ServiceBusTopicEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'ServiceBusTopic' (必要)
屬性 事件訂用帳戶目的地的服務總線主題屬性。 ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

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

StaticDeliveryAttributeMapping

名稱 說明 價值觀
屬性 靜態傳遞屬性對應的屬性。 StaticDeliveryAttributeMappingProperties
型別 傳遞屬性或標頭名稱的類型。 'Static' (必要)

StaticDeliveryAttributeMappingProperties

名稱 說明 價值觀
isSecret 的 布林值旗標,指出屬性是否包含敏感性資訊 。 布爾 (bool)
價值 傳遞屬性的值。 字串

StorageBlobDeadLetterDestination

名稱 說明 價值觀
endpoint類型 寄不出的信件目的地的端點類型 'StorageBlob' (必要)
屬性 記憶體 Blob 型死機目的地的屬性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名稱 說明 價值觀
blobContainerName (斑點容器名稱) 記憶體 Blob 容器的名稱,該容器是死機事件的目的地 字串
資源ID 記憶體帳戶的 Azure 資源識別符,這是死機事件的目的地 字串

StorageQueueEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'StorageQueue' (必要)
屬性 事件訂用帳戶目的地的記憶體佇列屬性。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

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

StringBeginsWithFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringBeginsWith' (必要)
價值觀 一組篩選值。 字串[]

StringContainsFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringContains' (必要)
價值觀 一組篩選值。 字串[]

StringEndsWithFilter (字串結束與篩檢程式)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringEndsWith' (必要)
價值觀 一組篩選值。 字串[]

StringInFilter (字串過濾器)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringIn' (必要)
價值觀 一組篩選值。 字串[]

StringNotBeginsWithFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringNotBeginsWith' (必要)
價值觀 一組篩選值。 字串[]

StringNotContains過濾器

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringNotContains' (必要)
價值觀 一組篩選值。 字串[]

StringNotEndsWithFilter (字串不結束與篩檢程式)

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringNotEndsWith' (必要)
價值觀 一組篩選值。 字串[]

StringNotInFilter

名稱 說明 價值觀
運算子類型 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等。 'StringNotIn' (必要)
價值觀 一組篩選值。 字串[]

SubscriptionProperties

名稱 說明 價值觀
deliveryConfiguration 事件訂閱傳遞設定的相關信息。 DeliveryConfiguration
eventDeliverySchema 事件交付架構 事件訂閱的事件傳遞架構。 “CloudEventSchemaV1_0”
過期時間 UTC 事件訂閱的到期時間。 字串
filtersConfiguration 事件訂閱篩選的相關信息。 FiltersConfiguration
標記 與事件訂用帳戶資源相關的標記。 SubscriptionProperties標籤

SubscriptionProperties標籤

名稱 說明 價值觀

WebHookEventSubscriptionDestination

名稱 說明 價值觀
endpoint類型 事件訂用帳戶目的地的端點類型。 'WebHook' (必要)
屬性 事件訂用帳戶目的地的 WebHook 屬性。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名稱 說明 價值觀
azureActiveDirectoryApplicationIdOrUri Microsoft Entra ID 應用程式 ID 或 URI,用於獲取將作為不記名令牌包含在投放請求中的訪問令牌。 字串
azureActiveDirectoryTenantId Microsoft Entra ID 租戶 ID,用於獲取將作為不記名令牌包含在投放請求中的訪問令牌。 字串
deliveryAttributeMappings 傳遞屬性詳細數據。 DeliveryAttributeMapping[]
端點網址 表示事件訂用帳戶目的地端點的 URL。 字串

約束:
敏感性值。 以安全參數的形式傳入。
maxEventsPerBatch 每個批次的事件數目上限。 整數 (int)
minimumTlsVersionAllowed Webhook 端點應支援的最小 TLS 版本 '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes 慣用的批次大小以 KB 為單位。 整數 (int)