Microsoft.EventGrid 主題/eventSubscriptions 2022-06-15
Bicep 資源定義
主題/eventSubscriptions 資源類型可以使用目標作業進行部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.EventGrid/topics/eventSubscriptions 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.EventGrid/topics/eventSubscriptions@2022-06-15' = {
name: 'string'
parent: resourceSymbolicName
properties: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
deadLetterWithResourceIdentity: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
deliveryWithResourceIdentity: {
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
eventDeliverySchema: 'string'
expirationTimeUtc: 'string'
filter: {
advancedFilters: [
{
key: 'string'
operatorType: 'string'
// For remaining properties, see AdvancedFilter objects
}
]
enableAdvancedFilteringOnArrays: bool
includedEventTypes: [
'string'
]
isSubjectCaseSensitive: bool
subjectBeginsWith: 'string'
subjectEndsWith: 'string'
}
labels: [
'string'
]
retryPolicy: {
eventTimeToLiveInMinutes: int
maxDeliveryAttempts: int
}
}
}
DeadLetterDestination 物件
設定 endpointType 屬性以指定物件的類型。
針對 StorageBlob，請使用：
endpointType: 'StorageBlob'
properties: {
blobContainerName: 'string'
resourceId: 'string'
}
EventSubscriptionDestination 物件
設定 endpointType 屬性以指定物件的類型。
針對 AzureFunction，請使用：
endpointType: 'AzureFunction'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
maxEventsPerBatch: int
preferredBatchSizeInKilobytes: int
resourceId: 'string'
}
針對 EventHub，請使用：
endpointType: 'EventHub'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
針對 HybridConnection，請使用：
endpointType: 'HybridConnection'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
針對 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
preferredBatchSizeInKilobytes: int
}
DeliveryAttributeMapping 物件
設定 type 屬性以指定物件的類型。
針對 Dynamic，請使用：
type: 'Dynamic'
properties: {
sourceField: 'string'
}
針對 Static，請使用：
type: 'Static'
properties: {
isSecret: bool
value: 'string'
}
AdvancedFilter 物件
設定 operatorType 屬性以指定物件的類型。
針對 BoolEquals，請使用：
operatorType: 'BoolEquals'
value: bool
針對 IsNotNull，請使用：
operatorType: 'IsNotNull'
針對 IsNullOrUndefined，請使用：
operatorType: 'IsNullOrUndefined'
針對 NumberGreaterThan，請使用：
operatorType: 'NumberGreaterThan'
value: int
針對 NumberGreaterThanOrEquals，請使用：
operatorType: 'NumberGreaterThanOrEquals'
value: int
針對 NumberIn，請使用：
operatorType: 'NumberIn'
values: [
int
]
針對 NumberInRange，請使用：
operatorType: 'NumberInRange'
values: [
[
int
]
]
針對 NumberLessThan，請使用：
operatorType: 'NumberLessThan'
value: int
針對 NumberLessThanOrEquals，請使用：
operatorType: 'NumberLessThanOrEquals'
value: int
針對 NumberNotIn，請使用：
operatorType: 'NumberNotIn'
values: [
int
]
針對 NumberNotInRange，請使用：
operatorType: 'NumberNotInRange'
values: [
[
int
]
]
針對 StringBeginsWith，請使用：
operatorType: 'StringBeginsWith'
values: [
'string'
]
針對 StringContains，請使用：
operatorType: 'StringContains'
values: [
'string'
]
針對 StringEndsWith，請使用：
operatorType: 'StringEndsWith'
values: [
'string'
]
針對 StringIn，請使用：
operatorType: 'StringIn'
values: [
'string'
]
針對 StringNotBeginsWith，請使用：
operatorType: 'StringNotBeginsWith'
values: [
'string'
]
針對 StringNotContains，請使用：
operatorType: 'StringNotContains'
values: [
'string'
]
針對 StringNotEndsWith，請使用：
operatorType: 'StringNotEndsWith'
values: [
'string'
]
針對 StringNotIn，請使用：
operatorType: 'StringNotIn'
values: [
'string'
]
屬性值
topics/eventSubscriptions
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 資源名稱 瞭解如何在 Bicep 中設定子資源的名稱和類型。 |
需要字串 () |
| 父系 (parent) | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增此屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型資源的符號名稱： 主題 |
| properties | 事件訂閱的屬性。 | EventSubscriptionProperties |
EventSubscriptionProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| deadLetterDestination | 事件訂閱的寄不出的信件目的地。 無法傳遞至目的地的任何事件都會傳送至寄不出的信件目的地。 使用 Azure 事件方格 的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
DeadLetterDestination |
| deadLetterWithResourceIdentity | 事件訂閱的寄不出的信件目的地。 無法傳遞至目的地的任何事件都會傳送至寄不出的信件目的地。 使用父資源上的受控識別設定 (名稱為主題或網域) ，以取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | 事件訂閱必須傳遞事件之目的地的相關信息。 使用父資源上的受控識別設定 (名稱為主題或網域) ，以取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
DeliveryWithResourceIdentity |
| 目的地 | 事件訂閱必須傳遞事件之目的地的相關信息。 使用 Azure 事件方格 的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
EventSubscriptionDestination |
| eventDeliverySchema | 事件訂閱的事件傳遞架構。 | 'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema' |
| expirationTimeUtc | 事件訂閱的到期時間。 | 字串 |
| filter | 事件訂閱篩選的相關信息。 | EventSubscriptionFilter |
| 標籤 | 使用者定義標籤的清單。 | string[] |
| RetryPolicy | 事件的重試原則。 這可以用來設定事件的最大傳遞嘗試次數和存留時間。 | RetryPolicy |
DeadLetterDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 設定物件類型 | StorageBlob (必要) |
StorageBlobDeadLetterDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 寄不出的信件目的地端點類型 | 'StorageBlob' (必要) |
| properties | 記憶體 Blob 型死信目的地的屬性 | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| blobContainerName | 記憶體 Blob 容器的名稱，該容器是寄不出的事件目的地 | 字串 |
| resourceId | 記憶體帳戶的 Azure 資源識別符，該帳戶是寄不出的事件目的地 | 字串 |
DeadLetterWithResourceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| deadLetterDestination | 事件訂用帳戶必須傳遞事件之目的地的相關信息。 在父資源上使用受控識別設定 (，也就是主題或網域) ，以取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
DeadLetterDestination |
| 身分識別 | 死信事件時要使用的身分識別。 | EventSubscriptionIdentity |
EventSubscriptionIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 使用的受控識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。 | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | 與資源相關聯的使用者身分識別。 | 字串 |
DeliveryWithResourceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 目的地 | 事件訂用帳戶必須傳遞事件之目的地的相關信息。 使用 Azure 事件方格 的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
EventSubscriptionDestination |
| 身分識別 | 傳遞事件時要使用的身分識別。 | EventSubscriptionIdentity |
EventSubscriptionDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 設定物件類型 | AzureFunction EventHub HybridConnection 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 資源識別碼。 | 字串 |
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 | 儲存佇列訊息存留時間，以秒為單位。 | 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 |
| preferredBatchSizeInKilobytes | 慣用的批次大小以 KB 為單位。 | int |
EventSubscriptionFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| advancedFilters | 用於篩選事件訂閱的進階篩選陣列。 | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | 允許針對值的數位評估進階篩選，而不是預期單一值。 | bool |
| includedEventTypes | 需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有預設事件類型，請將 IncludedEventTypes 設定為 null。 | string[] |
| isSubjectCaseSensitive | 指定 Filter 的 SubjectBeginsWith 和 SubjectEndsWith 屬性是否為 應該以區分大小寫的方式進行比較。 |
bool |
| subjectBeginsWith | 選擇性字串，可根據資源路徑前置詞篩選事件訂閱的事件。 此格式取決於事件的發行者。 此路徑不支援通配符。 |
字串 |
| subjectEndsWith | 選擇性字串，可根據資源路徑後綴篩選事件訂閱的事件。 此路徑不支援通配符。 |
字串 |
AdvancedFilter
BoolEqualsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'BoolEquals' (必要) |
| 值 | 布爾篩選值。 | bool |
IsNotNullAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'IsNotNull' (必要) |
IsNullOrUndefinedAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'IsNullOrUndefined' (必要) |
NumberGreaterThanAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 必要) 'NumberGreaterThan' ( |
| 值 | 篩選值。 | int |
NumberGreaterThanOrEqualsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'NumberGreaterThanOrEquals' (必要) |
| 值 | 篩選值。 | int |
NumberInAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | 需要 『NumberIn』 () |
| 值 | 篩選值集。 | int[] |
NumberInRangeAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | 需要 'NumberInRange' () |
| 值 | 篩選值集。 | int[][] |
NumberLessThanAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | 必要 ('NumberLessThan') |
| 值 | 篩選值。 | int |
NumberLessThanOrEqualsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | 'NumberLessThanOrEquals' (必要) |
| 值 | 篩選值。 | int |
NumberNotInAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | 需要 『NumberNotIn』 () |
| 值 | 篩選值集。 | int[] |
NumberNotInRangeAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | 'NumberNotInRange' (必要) |
| 值 | 篩選值集。 | int[][] |
StringBeginsWithAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | 'StringBeginsWith' (必要) |
| 值 | 篩選值集。 | string[] |
StringContainsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | 'StringContains' (必要) |
| 值 | 篩選值集。 | string[] |
StringEndsWithAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | 'StringEndsWith' (必要) |
| 值 | 篩選值集。 | string[] |
StringInAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | 'StringIn' (必要) |
| 值 | 篩選值集。 | string[] |
StringNotBeginsWithAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'StringNotBeginsWith' (必要) |
| 值 | 篩選值集。 | string[] |
StringNotContainsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'StringNotContains' (必要) |
| 值 | 篩選值集。 | string[] |
StringNotEndsWithAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'StringNotEndsWith' (必要) |
| 值 | 篩選值集。 | string[] |
StringNotInAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'StringNotIn' (必要) |
| 值 | 篩選值集。 | string[] |
RetryPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| eventTimeToLiveInMinutes | 活動) 分鐘 (存留時間。 | int |
| maxDeliveryAttempts | 事件的傳遞重試嘗試次數上限。 | int |
ARM 範本資源定義
主題/eventSubscriptions 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.EventGrid/topics/eventSubscriptions 資源，請將下列 JSON 新增至您的範本。
{
"type": "Microsoft.EventGrid/topics/eventSubscriptions",
"apiVersion": "2022-06-15",
"name": "string",
"properties": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"deadLetterWithResourceIdentity": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"deliveryWithResourceIdentity": {
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"eventDeliverySchema": "string",
"expirationTimeUtc": "string",
"filter": {
"advancedFilters": [
{
"key": "string",
"operatorType": "string"
// For remaining properties, see AdvancedFilter objects
}
],
"enableAdvancedFilteringOnArrays": "bool",
"includedEventTypes": [ "string" ],
"isSubjectCaseSensitive": "bool",
"subjectBeginsWith": "string",
"subjectEndsWith": "string"
},
"labels": [ "string" ],
"retryPolicy": {
"eventTimeToLiveInMinutes": "int",
"maxDeliveryAttempts": "int"
}
}
}
DeadLetterDestination 物件
設定 endpointType 屬性以指定物件的類型。
針對 StorageBlob，請使用：
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "string",
"resourceId": "string"
}
EventSubscriptionDestination 物件
設定 endpointType 屬性以指定物件的類型。
針對 AzureFunction，請使用：
"endpointType": "AzureFunction",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"maxEventsPerBatch": "int",
"preferredBatchSizeInKilobytes": "int",
"resourceId": "string"
}
針對 EventHub，請使用：
"endpointType": "EventHub",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"resourceId": "string"
}
針對 HybridConnection，請使用：
"endpointType": "HybridConnection",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"resourceId": "string"
}
針對 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",
"preferredBatchSizeInKilobytes": "int"
}
DeliveryAttributeMapping 物件
設定 type 屬性以指定物件的類型。
針對 Dynamic，請使用：
"type": "Dynamic",
"properties": {
"sourceField": "string"
}
針對 靜態，請使用：
"type": "Static",
"properties": {
"isSecret": "bool",
"value": "string"
}
AdvancedFilter 物件
設定 operatorType 屬性以指定物件的類型。
針對 BoolEquals，請使用：
"operatorType": "BoolEquals",
"value": "bool"
針對 IsNotNull，請使用：
"operatorType": "IsNotNull"
針對 IsNullOrUndefined，請使用：
"operatorType": "IsNullOrUndefined"
針對 NumberGreaterThan，請使用：
"operatorType": "NumberGreaterThan",
"value": "int"
針對 NumberGreaterThanOrEquals，請使用：
"operatorType": "NumberGreaterThanOrEquals",
"value": "int"
針對 NumberIn，請使用：
"operatorType": "NumberIn",
"values": [ "int" ]
針對 NumberInRange，請使用：
"operatorType": "NumberInRange",
"values": [ [ "int" ] ]
針對 NumberLessThan，請使用：
"operatorType": "NumberLessThan",
"value": "int"
針對 NumberLessThanOrEquals，請使用：
"operatorType": "NumberLessThanOrEquals",
"value": "int"
針對 NumberNotIn，請使用：
"operatorType": "NumberNotIn",
"values": [ "int" ]
針對 NumberNotInRange，請使用：
"operatorType": "NumberNotInRange",
"values": [ [ "int" ] ]
針對 StringBeginsWith，請使用：
"operatorType": "StringBeginsWith",
"values": [ "string" ]
針對 StringContains，請使用：
"operatorType": "StringContains",
"values": [ "string" ]
針對 StringEndsWith，請使用：
"operatorType": "StringEndsWith",
"values": [ "string" ]
針對 StringIn，請使用：
"operatorType": "StringIn",
"values": [ "string" ]
針對 StringNotBeginsWith，請使用：
"operatorType": "StringNotBeginsWith",
"values": [ "string" ]
針對 StringNotContains，請使用：
"operatorType": "StringNotContains",
"values": [ "string" ]
針對 StringNotEndsWith，請使用：
"operatorType": "StringNotEndsWith",
"values": [ "string" ]
針對 StringNotIn，請使用：
"operatorType": "StringNotIn",
"values": [ "string" ]
屬性值
topics/eventSubscriptions
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.EventGrid/topics/eventSubscriptions' |
| apiVersion | 資源 API 版本 | '2022-06-15' |
| NAME | 資源名稱 請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。 |
字串 (必要) |
| properties | 事件訂閱的屬性。 | EventSubscriptionProperties |
EventSubscriptionProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| deadLetterDestination | 事件訂閱的寄不出的信件目的地。 無法傳遞至目的地的任何事件都會傳送至寄不出的信件目的地。 使用 Azure 事件方格 的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
DeadLetterDestination |
| deadLetterWithResourceIdentity | 事件訂閱的寄不出的信件目的地。 無法傳遞至目的地的任何事件都會傳送至寄不出的信件目的地。 在父資源上使用受控識別設定 (，也就是主題或網域) ，以取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | 事件訂用帳戶必須傳遞事件之目的地的相關信息。 在父資源上使用受控識別設定 (，也就是主題或網域) ，以取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
DeliveryWithResourceIdentity |
| 目的地 | 事件訂用帳戶必須傳遞事件之目的地的相關信息。 使用 Azure 事件方格 的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
EventSubscriptionDestination |
| eventDeliverySchema | 事件訂閱的事件傳遞架構。 | 'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema' |
| expirationTimeUtc | 事件訂閱的到期時間。 | 字串 |
| filter | 事件訂閱篩選的相關信息。 | EventSubscriptionFilter |
| 標籤 | 使用者定義標籤的清單。 | string[] |
| RetryPolicy | 事件的重試原則。 這可以用來設定事件的最大傳遞嘗試次數和存留時間。 | RetryPolicy |
DeadLetterDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 設定物件類型 | StorageBlob (必要) |
StorageBlobDeadLetterDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 寄不出的信件目的地端點類型 | 'StorageBlob' (必要) |
| properties | 記憶體 Blob 型死信目的地的屬性 | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| blobContainerName | 記憶體 Blob 容器的名稱，該容器是寄不出的事件目的地 | 字串 |
| resourceId | 記憶體帳戶的 Azure 資源識別符，該帳戶是寄不出的事件目的地 | 字串 |
DeadLetterWithResourceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| deadLetterDestination | 事件訂用帳戶必須傳遞事件之目的地的相關信息。 在父資源上使用受控識別設定 (，也就是主題或網域) ，以取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
DeadLetterDestination |
| 身分識別 | 死信事件時要使用的身分識別。 | EventSubscriptionIdentity |
EventSubscriptionIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 使用的受控識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。 | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | 與資源相關聯的使用者身分識別。 | 字串 |
DeliveryWithResourceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 目的地 | 事件訂用帳戶必須傳遞事件之目的地的相關信息。 使用 Azure 事件方格 的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
EventSubscriptionDestination |
| 身分識別 | 傳遞事件時要使用的身分識別。 | EventSubscriptionIdentity |
EventSubscriptionDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 設定物件類型 | AzureFunction EventHub HybridConnection 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 資源識別碼。 | 字串 |
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 | 記憶體佇列訊息存留時間，以秒為單位。 | 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 |
| preferredBatchSizeInKilobytes | 慣用的批次大小以 KB 為單位。 | int |
EventSubscriptionFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| advancedFilters | 用於篩選事件訂閱的進階篩選陣列。 | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | 允許針對值的數位評估進階篩選，而不是預期單一值。 | bool |
| includedEventTypes | 需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有預設事件類型，請將 IncludedEventTypes 設定為 null。 | string[] |
| isSubjectCaseSensitive | 指定 Filter 的 SubjectBeginsWith 和 SubjectEndsWith 屬性是否為 應該以區分大小寫的方式進行比較。 |
bool |
| subjectBeginsWith | 選擇性字串，可根據資源路徑前置詞篩選事件訂閱的事件。 此格式取決於事件的發行者。 此路徑不支援通配符。 |
字串 |
| subjectEndsWith | 選擇性字串，可根據資源路徑後綴篩選事件訂閱的事件。 此路徑不支援通配符。 |
字串 |
AdvancedFilter
BoolEqualsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'BoolEquals' (必要) |
| 值 | 布爾篩選值。 | bool |
IsNotNullAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'IsNotNull' (必要) |
IsNullOrUndefinedAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'IsNullOrUndefined' (必要) |
NumberGreaterThanAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 必要) 'NumberGreaterThan' ( |
| 值 | 篩選值。 | int |
NumberGreaterThanOrEqualsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'NumberGreaterThanOrEquals' (必要) |
| 值 | 篩選值。 | int |
NumberInAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'NumberIn' (必要) |
| 值 | 篩選值集。 | int[] |
NumberInRangeAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 需要 'NumberInRange' () |
| 值 | 篩選值集。 | int[][] |
NumberLessThanAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 必要 ('NumberLessThan') |
| 值 | 篩選值。 | int |
NumberLessThanOrEqualsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 必要) 'NumberLessThanOrEquals' ( |
| 值 | 篩選值。 | int |
NumberNotInAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 需要 『NumberNotIn』 () |
| 值 | 篩選值集。 | int[] |
NumberNotInRangeAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 必要) ('NumberNotInRange' |
| 值 | 篩選值集。 | int[][] |
StringBeginsWithAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'StringBeginsWith' (必要) |
| 值 | 篩選值集。 | string[] |
StringContainsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'StringContains' (必要) |
| 值 | 篩選值集。 | string[] |
StringEndsWithAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'StringEndsWith' (必要) |
| 值 | 篩選值集。 | string[] |
StringInAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'StringIn' (必要) |
| 值 | 篩選值集。 | string[] |
StringNotBeginsWithAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'StringNotBeginsWith' (必要) |
| 值 | 篩選值集。 | string[] |
StringNotContainsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'StringNotContains' (必要) |
| 值 | 篩選值集。 | string[] |
StringNotEndsWithAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'StringNotEndsWith' (必要) |
| 值 | 篩選值集。 | string[] |
StringNotInAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 'StringNotIn' (必要) |
| 值 | 篩選值集。 | string[] |
RetryPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| eventTimeToLiveInMinutes | 活動) 分鐘 (存留時間。 | int |
| maxDeliveryAttempts | 事件的傳遞重試嘗試次數上限。 | int |
Terraform (AzAPI 提供者) 資源定義
主題/eventSubscriptions 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.EventGrid/topics/eventSubscriptions 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/topics/eventSubscriptions@2022-06-15"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
deadLetterWithResourceIdentity = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
deliveryWithResourceIdentity = {
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
eventDeliverySchema = "string"
expirationTimeUtc = "string"
filter = {
advancedFilters = [
{
key = "string"
operatorType = "string"
// For remaining properties, see AdvancedFilter objects
}
]
enableAdvancedFilteringOnArrays = bool
includedEventTypes = [
"string"
]
isSubjectCaseSensitive = bool
subjectBeginsWith = "string"
subjectEndsWith = "string"
}
labels = [
"string"
]
retryPolicy = {
eventTimeToLiveInMinutes = int
maxDeliveryAttempts = int
}
}
})
}
DeadLetterDestination 物件
設定 endpointType 屬性以指定物件的類型。
針對 StorageBlob，請使用：
endpointType = "StorageBlob"
properties = {
blobContainerName = "string"
resourceId = "string"
}
EventSubscriptionDestination 物件
設定 endpointType 屬性以指定物件的類型。
針對 AzureFunction，請使用：
endpointType = "AzureFunction"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
maxEventsPerBatch = int
preferredBatchSizeInKilobytes = int
resourceId = "string"
}
針對 EventHub，請使用：
endpointType = "EventHub"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
針對 HybridConnection，請使用：
endpointType = "HybridConnection"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
針對 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
preferredBatchSizeInKilobytes = int
}
DeliveryAttributeMapping 物件
設定 type 屬性以指定物件的類型。
針對 Dynamic，請使用：
type = "Dynamic"
properties = {
sourceField = "string"
}
針對 Static，請使用：
type = "Static"
properties = {
isSecret = bool
value = "string"
}
AdvancedFilter 物件
設定 operatorType 屬性以指定物件的類型。
針對 BoolEquals，請使用：
operatorType = "BoolEquals"
value = bool
針對 IsNotNull，請使用：
operatorType = "IsNotNull"
針對 IsNullOrUndefined，請使用：
operatorType = "IsNullOrUndefined"
針對 NumberGreaterThan，請使用：
operatorType = "NumberGreaterThan"
value = int
針對 NumberGreaterThanOrEquals，請使用：
operatorType = "NumberGreaterThanOrEquals"
value = int
針對 NumberIn，請使用：
operatorType = "NumberIn"
values = [
int
]
針對 NumberInRange，請使用：
operatorType = "NumberInRange"
values = [
[
int
]
]
針對 NumberLessThan，請使用：
operatorType = "NumberLessThan"
value = int
針對 NumberLessThanOrEquals，請使用：
operatorType = "NumberLessThanOrEquals"
value = int
針對 NumberNotIn，請使用：
operatorType = "NumberNotIn"
values = [
int
]
針對 NumberNotInRange，請使用：
operatorType = "NumberNotInRange"
values = [
[
int
]
]
針對 StringBeginsWith，請使用：
operatorType = "StringBeginsWith"
values = [
"string"
]
針對 StringContains，請使用：
operatorType = "StringContains"
values = [
"string"
]
針對 StringEndsWith，請使用：
operatorType = "StringEndsWith"
values = [
"string"
]
針對 StringIn，請使用：
operatorType = "StringIn"
values = [
"string"
]
針對 StringNotBeginsWith，請使用：
operatorType = "StringNotBeginsWith"
values = [
"string"
]
針對 StringNotContains，請使用：
operatorType = "StringNotContains"
values = [
"string"
]
針對 StringNotEndsWith，請使用：
operatorType = "StringNotEndsWith"
values = [
"string"
]
針對 StringNotIn，請使用：
operatorType = "StringNotIn"
values = [
"string"
]
屬性值
topics/eventSubscriptions
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.EventGrid/topics/eventSubscriptions@2022-06-15” |
| NAME | 資源名稱 | 需要字串 () |
| parent_id | 此資源父系之資源的標識碼。 | 類型資源的標識碼： 主題 |
| properties | 事件訂閱的屬性。 | EventSubscriptionProperties |
EventSubscriptionProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| deadLetterDestination | 事件訂閱的寄不出的信件目的地。 無法傳遞至目的地的任何事件都會傳送至寄不出的信件目的地。 使用 Azure 事件方格 的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
DeadLetterDestination |
| deadLetterWithResourceIdentity | 事件訂閱的寄不出的信件目的地。 無法傳遞至目的地的任何事件都會傳送至寄不出的信件目的地。 使用父資源上的受控識別設定 (名稱為主題或網域) ，以取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | 事件訂閱必須傳遞事件之目的地的相關信息。 使用父資源上的受控識別設定 (名稱為主題或網域) ，以取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
DeliveryWithResourceIdentity |
| 目的地 | 事件訂閱必須傳遞事件之目的地的相關信息。 使用 Azure 事件方格 的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
EventSubscriptionDestination |
| eventDeliverySchema | 事件訂閱的事件傳遞架構。 | “CloudEventSchemaV1_0” “CustomInputSchema” “EventGridSchema” |
| expirationTimeUtc | 事件訂閱的到期時間。 | 字串 |
| filter | 事件訂閱篩選的相關信息。 | EventSubscriptionFilter |
| 標籤 | 使用者定義的標籤清單。 | string[] |
| RetryPolicy | 事件的重試原則。 這可用來設定事件的最大傳遞嘗試次數和存留時間。 | RetryPolicy |
DeadLetterDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 設定物件類型 | 需要 StorageBlob () |
StorageBlobDeadLetterDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 無效信件目的地的端點類型 | “StorageBlob” (必要) |
| properties | 記憶體 Blob 型寄不出的目的地屬性 | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| blobContainerName | 記憶體 Blob 容器的名稱，該容器是寄不出的事件目的地 | 字串 |
| resourceId | 記憶體帳戶的 Azure 資源識別符，該帳戶是寄不出的事件目的地 | 字串 |
DeadLetterWithResourceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| deadLetterDestination | 事件訂用帳戶必須傳遞事件之目的地的相關信息。 在父資源上使用受控識別設定 (，也就是主題或網域) ，以取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
DeadLetterDestination |
| 身分識別 | 死信事件時要使用的身分識別。 | EventSubscriptionIdentity |
EventSubscriptionIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 使用的受控識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。 | “SystemAssigned” “UserAssigned” |
| userAssignedIdentity | 與資源相關聯的使用者身分識別。 | 字串 |
DeliveryWithResourceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 目的地 | 事件訂用帳戶必須傳遞事件之目的地的相關信息。 使用 Azure 事件方格 的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
EventSubscriptionDestination |
| 身分識別 | 傳遞事件時要使用的身分識別。 | EventSubscriptionIdentity |
EventSubscriptionDestination
| 名稱 | 描述 | 值 |
|---|---|---|
| endpointType | 設定物件類型 | AzureFunction EventHub HybridConnection 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 資源識別碼。 | 字串 |
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 | 儲存佇列訊息存留時間，以秒為單位。 | 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 |
| preferredBatchSizeInKilobytes | 慣用的批次大小以 KB 為單位。 | int |
EventSubscriptionFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| advancedFilters | 用於篩選事件訂閱的進階篩選陣列。 | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | 允許針對值的數位評估進階篩選，而不是預期單一值。 | bool |
| includedEventTypes | 需要屬於事件訂用帳戶一部分的適用事件類型清單。 如果想要訂閱所有預設事件類型，請將 IncludedEventTypes 設定為 null。 | string[] |
| isSubjectCaseSensitive | 指定 Filter 的 SubjectBeginsWith 和 SubjectEndsWith 屬性是否為 應該以區分大小寫的方式進行比較。 |
bool |
| subjectBeginsWith | 選擇性字串，可根據資源路徑前置詞篩選事件訂閱的事件。 此格式取決於事件的發行者。 此路徑不支援通配符。 |
字串 |
| subjectEndsWith | 選擇性字串，可根據資源路徑後綴篩選事件訂閱的事件。 此路徑不支援通配符。 |
字串 |
AdvancedFilter
BoolEqualsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | “BoolEquals” (必要) |
| 值 | 布爾篩選值。 | bool |
IsNotNullAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | “IsNotNull” (必要) |
IsNullOrUndefinedAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | “IsNullOrUndefined” (必要) |
NumberGreaterThanAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | “NumberGreaterThan” (必要) |
| 值 | 篩選值。 | int |
NumberGreaterThanOrEqualsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | “NumberGreaterThanOrEquals” (必要) |
| 值 | 篩選值。 | int |
NumberInAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | “NumberIn” (必要) |
| 值 | 篩選值集。 | int[] |
NumberInRangeAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | “NumberInRange” (必要) |
| 值 | 篩選值集。 | int[][] |
NumberLessThanAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | “NumberLessThan” (必要) |
| 值 | 篩選值。 | int |
NumberLessThanOrEqualsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | “NumberLessThanOrEquals” (必要) |
| 值 | 篩選值。 | int |
NumberNotInAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | 必要 (「NumberNotIn」) |
| 值 | 篩選值集。 | int[] |
NumberNotInRangeAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | “NumberNotInRange” (必要) |
| 值 | 篩選值集。 | int[][] |
StringBeginsWithAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | “StringBeginsWith” (必要) |
| 值 | 篩選值集。 | string[] |
StringContainsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | “StringContains” (必要) |
| 值 | 篩選值集。 | string[] |
StringEndsWithAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | “StringEndsWith” (必要) |
| 值 | 篩選值集。 | string[] |
StringInAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | “StringIn” (必要) |
| 值 | 篩選值集。 | string[] |
StringNotBeginsWithAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | “StringNotBeginsWith” (必要) |
| 值 | 篩選值集。 | string[] |
StringNotContainsAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | “StringNotContains” (必要) |
| 值 | 篩選值集。 | string[] |
StringNotEndsWithAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 和其他類型。 | “StringNotEndsWith” (必要) |
| 值 | 篩選值集。 | string[] |
StringNotInAdvancedFilter
| 名稱 | 描述 | 值 |
|---|---|---|
| operatorType | 用於篩選的運算符類型，例如 NumberIn、StringContains、BoolEquals 等等。 | “StringNotIn” (必要) |
| 值 | 篩選值集。 | string[] |
RetryPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| eventTimeToLiveInMinutes | 活動) 分鐘 (存留時間。 | int |
| maxDeliveryAttempts | 事件的傳遞重試嘗試次數上限。 | int |