共用方式為


Microsoft.EventGrid 命名空間/topics/eventSubscriptions 2023-12-15-preview

Bicep 資源定義

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

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

資源格式

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

resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    deliveryConfiguration: {
      deliveryMode: 'string'
      push: {
        deadLetterDestinationWithResourceIdentity: {
          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'
          }
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
      }
      queue: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
        receiveLockDurationInSeconds: int
      }
    }
    eventDeliverySchema: 'CloudEventSchemaV1_0'
    filtersConfiguration: {
      filters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see Filter objects
        }
      ]
      includedEventTypes: [
        'string'
      ]
    }
  }
}

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

針對 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
  }

DeliveryAttributeMapping 物件

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

針對 Dynamic,請使用:

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

針對 Static,請使用:

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

篩選物件

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

屬性值

namespaces/topics/eventSubscriptions

名稱 描述
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。
需要字串 ()
父系 (parent) 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增此屬性。

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

SubscriptionProperties

名稱 描述
deliveryConfiguration 事件訂閱傳遞組態的相關信息。 DeliveryConfiguration
eventDeliverySchema 事件訂閱的事件傳遞架構。 'CloudEventSchemaV1_0'
filtersConfiguration 事件訂閱篩選的相關信息。 FiltersConfiguration

DeliveryConfiguration

名稱 描述
deliveryMode 事件訂閱的傳遞模式。 'Push'
'Queue'
push 當 deliveryMode 推送時,應該填入此屬性,並代表發送訂閱的相關信息。 PushInfo
queue 當 deliveryMode 是佇列,並代表佇列訂閱的相關信息時,應該填入這個屬性。 QueueInfo

PushInfo

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

DeadLetterWithResourceIdentity

名稱 描述
deadLetterDestination 事件訂閱必須傳遞事件之目的地的相關信息。
使用父資源上的受控識別設定 (名稱為主題或網域) ,以取得傳遞/寄不出的信件期間所使用的驗證令牌。
DeadLetterDestination
身分識別 當寄不出的信件事件時要使用的身分識別。 EventSubscriptionIdentity

DeadLetterDestination

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

EventSubscriptionIdentity

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

DeliveryWithResourceIdentity

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

EventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

DeliveryAttributeMapping

名稱 描述
NAME 傳遞屬性或標頭的名稱。 字串
type 設定物件類型 動態
需要靜態 ()

DynamicDeliveryAttributeMapping

名稱 描述
類型 傳遞屬性或標頭名稱的類型。 需要 『Dynamic』 ()
properties 動態傳遞屬性對應的屬性。 DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

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

StaticDeliveryAttributeMapping

名稱 描述
類型 傳遞屬性或標頭名稱的類型。 需要 『Static』 ()
properties 靜態傳遞屬性對應的屬性。 StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

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

MonitorAlertEventSubscriptionDestination

名稱 描述
endpointType 事件訂用帳戶目的地的端點類型。 'MonitorAlert' (必要)
properties 監視事件訂閱目的地的警示屬性。 MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

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

NamespaceTopicEventSubscriptionDestination

名稱 描述
endpointType 事件訂用帳戶目的地的端點類型。 'NamespaceTopic' (必要)
properties 事件訂閱目的地的命名空間主題屬性。 NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

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

PartnerEventSubscriptionDestination

名稱 描述
endpointType 事件訂用帳戶目的地的端點類型。 'PartnerDestination' (必要)
properties 事件訂閱目的地的合作夥伴目的地屬性。 PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

名稱 描述
resourceId Azure 資源標識符,代表事件訂用帳戶之合作夥伴目的地的端點。 字串

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationPropertie...

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

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationPropertie...

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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

名稱 描述
endpointType 事件訂用帳戶目的地的端點類型。 需要 『WebHook』 ()
properties 事件訂閱目的地的 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

QueueInfo

名稱 描述
deadLetterDestinationWithResourceIdentity 事件訂閱的寄不出的信件目的地。 無法傳遞至目的地的任何事件都會傳送至寄不出的信件目的地。
使用父資源上的受控識別設定 (也就是主題) ,以取得傳遞/寄不出的信件期間所使用的驗證令牌。
DeadLetterWithResourceIdentity
eventTimeToLive ISO 8601 格式的時間範圍持續時間,決定從訊息發佈時間起,訂用帳戶可以使用多少時間的訊息。
此持續時間值會使用下列格式來表示:'P (n) Y (n) M (n) DT (n) H (n) M (n) S',其中:
- (n) 會取代為 (n) 之後每個 time 元素的值。
- 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

FiltersConfiguration

名稱 描述
filters 篩選事件訂閱所使用的篩選陣列。 Filter[]
includedEventTypes 需要屬於事件訂閱一部分的適用事件類型清單。 如果需要訂閱所有預設事件類型,請將 IncludedEventTypes 設定為 null。 string[]

篩選

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

BoolEqualsFilter

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

IsNotNullFilter

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

IsNullOrUndefinedFilter

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

NumberGreaterThanFilter

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

NumberGreaterThanOrEqualsFilter

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

NumberInFilter

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

NumberInRangeFilter

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

NumberLessThanFilter

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

NumberLessThanOrEqualsFilter

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

NumberNotInFilter

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

NumberNotInRangeFilter

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

StringBeginsWithFilter

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

StringContainsFilter

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

StringEndsWithFilter

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

StringInFilter

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

StringNotBeginsWithFilter

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

StringNotContainsFilter

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

StringNotEndsWithFilter

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

StringNotInFilter

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

ARM 範本資源定義

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

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

資源格式

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

{
  "type": "Microsoft.EventGrid/namespaces/topics/eventSubscriptions",
  "apiVersion": "2023-12-15-preview",
  "name": "string",
  "properties": {
    "deliveryConfiguration": {
      "deliveryMode": "string",
      "push": {
        "deadLetterDestinationWithResourceIdentity": {
          "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"
          }
        },
        "eventTimeToLive": "string",
        "maxDeliveryCount": "int"
      },
      "queue": {
        "deadLetterDestinationWithResourceIdentity": {
          "deadLetterDestination": {
            "endpointType": "string"
            // For remaining properties, see DeadLetterDestination objects
          },
          "identity": {
            "type": "string",
            "userAssignedIdentity": "string"
          }
        },
        "eventTimeToLive": "string",
        "maxDeliveryCount": "int",
        "receiveLockDurationInSeconds": "int"
      }
    },
    "eventDeliverySchema": "CloudEventSchemaV1_0",
    "filtersConfiguration": {
      "filters": [
        {
          "key": "string",
          "operatorType": "string"
          // For remaining properties, see Filter objects
        }
      ],
      "includedEventTypes": [ "string" ]
    }
  }
}

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

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

DeliveryAttributeMapping 物件

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

針對 Dynamic,請使用:

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

針對 靜態,請使用:

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

篩選物件

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

屬性值

namespaces/topics/eventSubscriptions

名稱 描述
類型 資源類型 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions'
apiVersion 資源 API 版本 '2023-12-15-preview'
NAME 資源名稱

請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。
字串 (必要)
properties 事件訂閱的屬性。 SubscriptionProperties

SubscriptionProperties

名稱 描述
deliveryConfiguration 事件訂閱傳遞組態的相關信息。 DeliveryConfiguration
eventDeliverySchema 事件訂閱的事件傳遞架構。 'CloudEventSchemaV1_0'
filtersConfiguration 事件訂閱篩選的相關信息。 FiltersConfiguration

DeliveryConfiguration

名稱 描述
deliveryMode 事件訂閱的傳遞模式。 'Push'
'Queue'
push 當 deliveryMode 推送時,應該填入此屬性,並表示發送訂閱的相關信息。 PushInfo
queue 當 deliveryMode 是佇列時,應該填入此屬性,並代表佇列訂閱的相關信息。 QueueInfo

PushInfo

名稱 描述
deadLetterDestinationWithResourceIdentity 事件訂閱的寄不出的信件目的地。 無法傳遞至目的地的任何事件都會傳送至寄不出的信件目的地。
在父資源上使用受控識別設定 (,也就是命名空間) ,以取得傳遞/寄不出的信件期間所使用的驗證令牌。
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity 事件訂用帳戶必須傳遞事件之目的地的相關信息。
在父資源上使用受控識別設定 (,也就是主題或網域) ,以取得傳遞/寄不出的信件期間所使用的驗證令牌。
DeliveryWithResourceIdentity
eventTimeToLive ISO 8601 格式的時間範圍持續時間,決定從訊息發佈時間起,訂閱可以使用多少時間長度。
此持續時間值是以下列格式表示:'P (n) Y (n) M (n) DT (n) H (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

DeadLetterWithResourceIdentity

名稱 描述
deadLetterDestination 事件訂用帳戶必須傳遞事件之目的地的相關信息。
在父資源上使用受控識別設定 (,也就是主題或網域) ,以取得傳遞/寄不出的信件期間所使用的驗證令牌。
DeadLetterDestination
身分識別 死信事件時要使用的身分識別。 EventSubscriptionIdentity

DeadLetterDestination

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

EventSubscriptionIdentity

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

DeliveryWithResourceIdentity

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

EventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

DeliveryAttributeMapping

名稱 描述
NAME 傳遞屬性或標頭的名稱。 字串
type 設定物件類型 動態
需要靜態 ()

DynamicDeliveryAttributeMapping

名稱 描述
類型 傳遞屬性或標頭名稱的類型。 需要 『Dynamic』 ()
properties 動態傳遞屬性對應的屬性。 DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

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

StaticDeliveryAttributeMapping

名稱 描述
類型 傳遞屬性或標頭名稱的類型。 需要 『Static』 ()
properties 靜態傳遞屬性對應的屬性。 StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

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

MonitorAlertEventSubscriptionDestination

名稱 描述
endpointType 事件訂用帳戶目的地的端點類型。 'MonitorAlert' (必要)
properties 監視事件訂閱目的地的警示屬性。 MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

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

NamespaceTopicEventSubscriptionDestination

名稱 描述
endpointType 事件訂用帳戶目的地的端點類型。 'NamespaceTopic' (必要)
properties 事件訂閱目的地的命名空間主題屬性。 NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

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

PartnerEventSubscriptionDestination

名稱 描述
endpointType 事件訂用帳戶目的地的端點類型。 必要) ('PartnerDestination'
properties 事件訂用帳戶目的地的合作夥伴目的地屬性。 PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

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

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationPropertie...

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

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationPropertie...

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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

名稱 描述
endpointType 事件訂用帳戶目的地的端點類型。 必要的 『WebHook』 ()
properties 事件訂閱目的地的 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

QueueInfo

名稱 描述
deadLetterDestinationWithResourceIdentity 事件訂閱的寄不出的信件目的地。 無法傳遞至目的地的任何事件都會傳送至寄不出的信件目的地。
在父資源上使用受控識別設定 (,也就是主題) ,以取得傳遞/寄不出的信件期間所使用的驗證令牌。
DeadLetterWithResourceIdentity
eventTimeToLive ISO 8601 格式的時間範圍持續時間,決定從訊息發佈時間起,訂閱可以使用多少時間長度。
此持續時間值是以下列格式表示:'P (n) Y (n) M (n) DT (n) H (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

FiltersConfiguration

名稱 描述
filters 篩選事件訂閱所使用的篩選陣列。 Filter[]
includedEventTypes 需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有預設事件類型,請將 IncludedEventTypes 設定為 null。 string[]

篩選

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

BoolEqualsFilter

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

IsNotNullFilter

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

IsNullOrUndefinedFilter

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

NumberGreaterThanFilter

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

NumberGreaterThanOrEqualsFilter

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

NumberInFilter

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

NumberInRangeFilter

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

NumberLessThanFilter

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

NumberLessThanOrEqualsFilter

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

NumberNotInFilter

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

NumberNotInRangeFilter

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

StringBeginsWithFilter

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

StringContainsFilter

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

StringEndsWithFilter

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

StringInFilter

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

StringNotBeginsWithFilter

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

StringNotContainsFilter

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

StringNotEndsWithFilter

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

StringNotInFilter

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

Terraform (AzAPI 提供者) 資源定義

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

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deliveryConfiguration = {
        deliveryMode = "string"
        push = {
          deadLetterDestinationWithResourceIdentity = {
            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"
            }
          }
          eventTimeToLive = "string"
          maxDeliveryCount = int
        }
        queue = {
          deadLetterDestinationWithResourceIdentity = {
            deadLetterDestination = {
              endpointType = "string"
              // For remaining properties, see DeadLetterDestination objects
            }
            identity = {
              type = "string"
              userAssignedIdentity = "string"
            }
          }
          eventTimeToLive = "string"
          maxDeliveryCount = int
          receiveLockDurationInSeconds = int
        }
      }
      eventDeliverySchema = "CloudEventSchemaV1_0"
      filtersConfiguration = {
        filters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see Filter objects
          }
        ]
        includedEventTypes = [
          "string"
        ]
      }
    }
  })
}

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

針對 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
  }

DeliveryAttributeMapping 物件

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

針對 Dynamic,請使用:

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

針對 Static,請使用:

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

篩選物件

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

屬性值

namespaces/topics/eventSubscriptions

名稱 描述
類型 資源類型 “Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview”
NAME 資源名稱 需要字串 ()
parent_id 此資源父系之資源的標識碼。 類型資源的標識碼: 主題
properties 事件訂閱的屬性。 SubscriptionProperties

SubscriptionProperties

名稱 描述
deliveryConfiguration 事件訂閱傳遞組態的相關信息。 DeliveryConfiguration
eventDeliverySchema 事件訂閱的事件傳遞架構。 “CloudEventSchemaV1_0”
filtersConfiguration 事件訂閱篩選的相關信息。 FiltersConfiguration

DeliveryConfiguration

名稱 描述
deliveryMode 事件訂閱的傳遞模式。 “Push”
“Queue”
push 當 deliveryMode 推送時,應該填入此屬性,並代表發送訂閱的相關信息。 PushInfo
queue 當 deliveryMode 是佇列,並代表佇列訂閱的相關信息時,應該填入這個屬性。 QueueInfo

PushInfo

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

DeadLetterWithResourceIdentity

名稱 描述
deadLetterDestination 事件訂閱必須傳遞事件之目的地的相關信息。
使用父資源上的受控識別設定 (名稱為主題或網域) ,以取得傳遞/寄不出的信件期間所使用的驗證令牌。
DeadLetterDestination
身分識別 當寄不出的信件事件時要使用的身分識別。 EventSubscriptionIdentity

DeadLetterDestination

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

EventSubscriptionIdentity

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

DeliveryWithResourceIdentity

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

EventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

DeliveryAttributeMapping

名稱 描述
NAME 傳遞屬性或標頭的名稱。 字串
type 設定物件類型 動態
靜態 (必要)

DynamicDeliveryAttributeMapping

名稱 描述
類型 傳遞屬性或標頭名稱的類型。 「動態」 (必要)
properties 動態傳遞屬性對應的屬性。 DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

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

StaticDeliveryAttributeMapping

名稱 描述
類型 傳遞屬性或標頭名稱的類型。 「靜態」 (必要)
properties 靜態傳遞屬性對應的屬性。 StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

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

MonitorAlertEventSubscriptionDestination

名稱 描述
endpointType 事件訂用帳戶目的地的端點類型。 必要) “MonitorAlert” (
properties 監視事件訂用帳戶目的地的警示屬性。 MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

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

NamespaceTopicEventSubscriptionDestination

名稱 描述
endpointType 事件訂用帳戶目的地的端點類型。 必要) “NamespaceTopic” (
properties 事件訂閱目的地的命名空間主題屬性。 NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

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

PartnerEventSubscriptionDestination

名稱 描述
endpointType 事件訂用帳戶目的地的端點類型。 必要) “PartnerDestination” (
properties 事件訂用帳戶目的地的合作夥伴目的地屬性。 PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

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

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationPropertie...

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

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationPropertie...

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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

名稱 描述
endpointType 事件訂用帳戶目的地的端點類型。 “WebHook” (必要)
properties 事件訂閱目的地的 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

QueueInfo

名稱 描述
deadLetterDestinationWithResourceIdentity 事件訂閱的寄不出的信件目的地。 無法傳遞至目的地的任何事件都會傳送至寄不出的信件目的地。
使用父資源上的受控識別設定 (也就是主題) ,以取得傳遞/寄不出的信件期間所使用的驗證令牌。
DeadLetterWithResourceIdentity
eventTimeToLive ISO 8601 格式的時間範圍持續時間,決定從訊息發佈時間起,訂用帳戶可以使用多少時間的訊息。
此持續時間值會使用下列格式來表示:'P (n) Y (n) M (n) DT (n) H (n) M (n) S',其中:
- (n) 會取代為 (n) 之後每個 time 元素的值。
- 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

FiltersConfiguration

名稱 描述
filters 篩選事件訂閱所使用的篩選陣列。 Filter[]
includedEventTypes 需要屬於事件訂閱一部分的適用事件類型清單。 如果需要訂閱所有預設事件類型,請將 IncludedEventTypes 設定為 null。 string[]

篩選

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

BoolEqualsFilter

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

IsNotNullFilter

名稱 描述
operatorType 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 “IsNotNull” (必要)

IsNullOrUndefinedFilter

名稱 描述
operatorType 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 “IsNullOrUndefined” (必要)

NumberGreaterThanFilter

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

NumberGreaterThanOrEqualsFilter

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

NumberInFilter

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

NumberInRangeFilter

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

NumberLessThanFilter

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

NumberLessThanOrEqualsFilter

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

NumberNotInFilter

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

NumberNotInRangeFilter

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

StringBeginsWithFilter

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

StringContainsFilter

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

StringEndsWithFilter

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

StringInFilter

名稱 描述
operatorType 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 “StringIn” (必要)
篩選值集。 string[]

StringNotBeginsWithFilter

名稱 描述
operatorType 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 “StringNotBeginsWith” (必要)
篩選值集。 string[]

StringNotContainsFilter

名稱 描述
operatorType 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 “StringNotContains” (必要)
篩選值集。 string[]

StringNotEndsWithFilter

名稱 描述
operatorType 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 “StringNotEndsWith” (必要)
篩選值集。 string[]

StringNotInFilter

名稱 描述
operatorType 用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 “StringNotIn” (必要)
篩選值集。 string[]