Microsoft.EventGrid eventSubscriptions

發行項
12/16/2024

Bicep 資源定義

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

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

資源格式

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2024-12-15-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    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'
  }
}

DeliveryAttributeMapping 物件

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

針對 Dynamic，請使用：

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

針對 Static，請使用：

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

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

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

屬性值

AdvancedFilter

名字	描述	價值
鑰匙	事件中的欄位/屬性，根據您想要篩選的欄位/屬性。	字串
operatorType	將類型設定為 'BoolEquals'，BoolEqualsAdvancedFilter。針對isNotNullAdvancedFilter類型設定為 'IsNotNull'。針對isNullOrUndefined 類型設定為 'IsNullOrUndefined' IsNullOrUndefinedAdvancedFilter。針對 type NumberGreaterThanAdvancedFilter，設定為 'NumberGreaterThan'。針對 type NumberGreaterThanOrEquals 設定為 'NumberGreaterThanOrEqualsAdvancedFilter。針對 type NumberInAdvancedFilter設定為 'NumberIn'。針對 type NumberInRangeAdvancedFilter，設定為 'NumberInRange'。針對 type NumberLessThanAdvancedFilter設定為 'NumberLessThan'。針對 type NumberLessThanOrEqualsAdvancedFilter，設定為 'NumberLessThanOrEquals'。針對 type NumberNotInAdvancedFilter設定為 'NumberNotIn'。針對 type NumberNotInRangeAdvancedFilter，設定為 'NumberNotInRange'。將設定為 'StringBeginsWith' 類型 StringBeginsWithAdvancedFilter。針對 stringContainsAdvancedFilter類型，將設定為 'StringContains'。針對 stringEndsWi thsWith 類型設定為『StringEndsWithAdvancedFilter。針對 stringInAdvancedFilter 類型設定為 'StringIn'，。針對 stringNotBeginsWith 類型設定為『StringNotBeginsWithAdvancedFilter類型。針對 stringNotContains 類型設定為『StringNotContains』。針對 stringNotEndsWith 類型設定為『StringNotEndsWithAdvancedFilter類型。針對 stringNotInAdvancedFilter類型設定為 'StringNotIn'。	'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' （必要）

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

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

DeadLetterDestination

名字	描述	價值
endpointType	針對 storageBlobDeadLetterDestination類型設定為 'StorageBlob'。	'StorageBlob' （必要）

DeadLetterWithResourceIdentity

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

DeliveryAttributeMapping

名字	描述	價值
名字	傳遞屬性或標頭的名稱。	字串
類型	針對 dynamicDeliveryAttributeMapping 類型設定為 'Dynamic'，。將類型設定為 'Static' StaticDeliveryAttributeMapping。	'Dynamic' 'Static' （必要）

DeliveryWithResourceIdentity

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

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

名字	描述	價值
endpointType	針對 azureFunctionEventSubscriptionDestination類型設定為 'AzureFunction'。針對 eventHubEventSubscriptionDestination類型設定為 'EventHub'。針對 hybridConnectionEventSubscriptionDestination類型，設定為 'HybridConnection'。設定為類型為 'MonitorAlert' MonitorAlertEventSubscriptionDestination。針對 NamespaceTopicEventSubscriptionDestination 類型設定為 'NamespaceTopic'，。針對 partnerEventSubscriptionDestination類型設定為 'PartnerDestination'。針對 serviceBusQueueEventSubscriptionDestination 類型設定為 'ServiceBusQueue'，。針對 type ServiceBusTopicEventSubscriptionDestination，設定為 'ServiceBusTopic'。針對 storageQueueEventSubscriptionDestination類型設定為 'StorageQueue'。針對類型 WebHookEventSubscriptionDestination，設定為 'WebHook'。	'AzureFunction' 'EventHub' 'HybridConnection' 'MonitorAlert' 'NamespaceTopic' 'PartnerDestination' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' （必要）

EventSubscriptionFilter

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

EventSubscriptionIdentity

名字	描述	價值
federatedIdentityCredentialInfo	與資源傳遞搭配使用的同盟身分識別認證（FIC）詳細數據。	FederatedIdentityCredentialInfo
類型	所使用的受控識別類型。可以是 'SystemAssigned' 或 'UserAssigned'。	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	與資源相關聯的使用者身分識別。	字串

EventSubscriptionProperties

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

FederatedIdentityCredentialInfo

名字	描述	價值
federatedClientId	與同盟身分識別認證（FIC）相關聯的多租使用者 AAD 應用程式。	字串約束：最小長度 = 36 最大長度 = 36 模式 = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` （必要）

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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