Microsoft.EventGrid eventSubscriptions

Článek
12/16/2024

nejnovější
12. 12. 2024 ve verzi Preview
2024-06-01-preview
z 12. 12. 2023 ve verzi Preview
2023-06-01-preview
15. 6. 2022
12. 12. 2021
10. 10. 2021 ve verzi Preview
2021-06-01-preview
10. 10. 2020 ve verzi Preview
06.06.2020
2020-04-01-preview
1. 1. 2020 ve verzi Preview
06.06.2019
2019-02-01-preview
1. 1. 2019
1 5. 9. 2018
z 5. 5. 2018 ve verzi Preview
1. 1. 2018
15. 9. 2017
15. 6. 2017

Definice prostředku Bicep

Typ prostředku eventSubscriptions lze nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.EventGrid/eventSubscriptions, přidejte do šablony následující 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 – objekty

Nastavte vlastnost endpointType, která určuje typ objektu.

Pro StorageBlob použijte:

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

Objekty DeliveryAttributeMapping

Nastavte typ vlastnost určit typ objektu.

Pro Dynamicképoužijte:

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

Pro Staticpoužijte:

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

Objekty AdvancedFilter

Nastavte operatorType vlastnost určit typ objektu.

Pro BoolEqualspoužijte:

{
  operatorType: 'BoolEquals'
  value: bool
}

Pro IsNotNullpoužijte:

{
  operatorType: 'IsNotNull'
}

Pro IsNullOrUndefinedpoužijte:

{
  operatorType: 'IsNullOrUndefined'
}

Pro NumberGreaterThanpoužijte:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

Pro NumberGreaterThanOrEqualspoužijte:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

Pro NumberInpoužijte:

{
  operatorType: 'NumberIn'
  values: [
    int
  ]
}

Pro NumberInRangepoužijte:

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

Pro NumberLessThanpoužijte:

{
  operatorType: 'NumberLessThan'
  value: int
}

Pro NumberLessThanOrEqualspoužijte:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

Pro NumberNotInpoužijte:

{
  operatorType: 'NumberNotIn'
  values: [
    int
  ]
}

Pro NumberNotInRangepoužijte:

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

Pro StringBeginsWithpoužijte:

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

Pro StringContainspoužijte:

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

Pro StringEndsWithpoužijte:

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

Pro StringInpoužijte:

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

Pro StringNotBeginsWithpoužijte:

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

Pro StringNotContainspoužijte:

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

Pro StringNotEndsWithpoužijte:

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

Pro StringNotInpoužijte:

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

EventSubscriptionDestination – objekty

Nastavte vlastnost endpointType, která určuje typ objektu.

Pro AzureFunctionpoužijte:

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

Pro EventHubu použijte:

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

ProHybridConnection použijte:

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

Pro MonitorAlert použijte:

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

Pro obor názvůTopicpoužijte:

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

Pro PartnerDestinationpoužijte:

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

Pro ServiceBusQueuepoužijte:

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

Pro ServiceBusTopicpoužijte:

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

Pro služby StorageQueue použijte:

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

Pro webhookpoužijte:

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

Hodnoty vlastností

AdvancedFilter

Jméno	Popis	Hodnota
klíč	Pole nebo vlastnost v události, na základě které chcete filtrovat.	řetězec
operatorType	Pro typ BoolEqualsAdvancedFilternastavte na hodnotu BoolEqualsAdvancedFilter . Nastavte na IsNotNull pro typ IsNotNullAdvancedFilter. Nastavte na IsNullOrUndefined pro typ IsNullOrUndefinedAdvancedFilter. Pro typ NumberGreaterThanAdvancedFilternastavte hodnotu NumberGreaterThanAdVancedFilter . Nastavte na NumberGreaterThanOrEquals pro typ NumberGreaterThanOrEqualsAdvancedFilter. Pro typ NumberIn nastavte hodnotu NumberInAdvancedFilter. Nastavte na NumberInRange pro typ NumberInRangeAdvancedFilter. Pro typ NumberLessThanAdvancedFilternastavte hodnotu NumberLessThan. Nastavit na 'NumberLessThanOrEquals' pro typ NumberLessThanOrEqualsAdvancedFilter. Pro typ NumberNotInAdvancedFilternastavte hodnotu NumberNotInIn. Nastavte na NumberNotInRange pro typ NumberNotInRangeAdvancedFilter. Pro typ StringBeginsWithAdvancedFilternastavte hodnotu StringBeginsWithAdvancedFilter . Pro typ StringContainsAdvancedFilternastavte hodnotu StringContainsAdvancedFilter . Nastavte na StringEndsWith pro typ StringEndsWithAdvancedFilter. Nastavte na StringIn pro typ StringInAdvancedFilter. Nastavte na StringNotBeginsWith pro typ StringNotBeginsWithAdvancedFilter. Nastavte na StringNotContains pro typ StringNotContainsAdvancedFilter. Nastavte na StringNotEndsWith pro typ StringNotEndsWithAdvancedFilter. Pro typ StringNotInAdvancedFilter nastavte hodnotu StringNotInAdvancedFilter.	BoolEquals IsNotNull IsNullOrUndefined 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' NumberInRange 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (povinné)

AzureFunctionEventSubscriptionDestination

Jméno	Popis	Hodnota
endpointType	Typ koncového bodu pro cíl odběru událostí	AzureFunction (povinné)
vlastnosti	Vlastnosti funkce Azure v cíli odběru událostí	AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Jméno	Popis	Hodnota
deliveryAttributeMappings	Podrobnosti o atributu doručení	DeliveryAttributeMapping[]
maxEventsPerBatch	Maximální počet událostí na dávku	Int
preferredBatchSizeInKilobytes	Upřednostňovaná velikost dávky v kilobajtech.	Int
resourceId	ID prostředku Azure, které představuje koncový bod cíle funkce Azure v odběru událostí.	řetězec

BoolEqualsAdvancedFilter

Jméno	Popis	Hodnota
operatorType	Typ operátoru použitý pro filtrování, například NumberIn, StringContains, BoolEquals a další.	BoolEquals (povinné)
hodnota	Logická hodnota filtru.	Bool

DeadLetterDestination

Jméno	Popis	Hodnota
endpointType	Nastavte na StorageBlob pro typ StorageBlobDeadLetterDestination.	StorageBlob (povinné)

DeadLetterWithResourceIdentity

Jméno	Popis	Hodnota
deadLetterDestination	Informace o cíli, kde se události musí doručovat pro odběr událostí. Používá nastavení spravované identity u nadřazeného prostředku (konkrétně tématu nebo domény) k získání ověřovacích tokenů používaných během nedoručených dopisů.	DeadLetterDestination
identita	Identita, která se má použít při nedoručených událostech.	EventSubscriptionIdentity

DeliveryAttributeMapping

Jméno	Popis	Hodnota
Jméno	Název atributu doručení nebo hlavičky	řetězec
typ	Pro typ DynamicDeliveryAttributeMapping na hodnotu DynamicDeliveryAttributeMapping. Nastavte na Static pro typ StaticDeliveryAttributeMapping.	Dynamická Statická (povinné)

DeliveryWithResourceIdentity

Jméno	Popis	Hodnota
cíl	Informace o cíli, kde se události musí doručovat pro odběr událostí. Používá nastavení spravované identity u nadřazeného prostředku (konkrétně tématu nebo domény) k získání ověřovacích tokenů používaných během doručování.	EventSubscriptionDestination
identita	Identita, která se má použít při doručování událostí.	EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Jméno	Popis	Hodnota
vlastnosti	Vlastnosti mapování atributů dynamického doručování	DynamicDeliveryAttributeMappingProperties
typ	Typ atributu doručení nebo názvu hlavičky	Dynamické (povinné)

DynamicDeliveryAttributeMappingProperties

Jméno	Popis	Hodnota
sourceField	Cesta JSON v události, která obsahuje hodnotu atributu.	řetězec

EventHubEventSubscriptionDestination

Jméno	Popis	Hodnota
endpointType	Typ koncového bodu pro cíl odběru událostí	EventHub (povinné)
vlastnosti	Vlastnosti centra událostí cíle odběru událostí.	EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Jméno	Popis	Hodnota
deliveryAttributeMappings	Podrobnosti o atributu doručení	DeliveryAttributeMapping[]
resourceId	ID prostředku Azure, které představuje koncový bod cíle centra událostí odběru událostí.	řetězec

EventSubscriptionDestination

Jméno	Popis	Hodnota
endpointType	Nastavte na AzureFunction pro typ AzureFunctionEventSubscriptionDestination. Nastavte na EventHub pro typ EventHubEventSubscriptionDestination. Pro typ HybridConnectionEventSubscriptionDestinationna hodnotu HybridConnectionEventSubscriptionDestination . Pro typ MonitorAlertEventSubscriptionDestinationnastavte hodnotu MonitorAlertEventSubscriptionDestination . Pro typ NamespaceTopicEventSubscriptionDestinationna hodnotu NamespaceTopicEventSubscriptionDestination . Nastavte na PartnerDestination pro typ PartnerEventSubscriptionDestination. Nastavte na ServiceBusQueue pro typ ServiceBusQueueEventSubscriptionDestination. Nastavte na ServiceBusTopic pro typ ServiceBusTopicEventSubscriptionDestination. Nastavte na StorageQueue pro typ StorageQueueEventSubscriptionDestination. Pro typ WebHookEventSubscriptionDestinationna hodnotu WebHookEventSubscriptionDestination .	AzureFunction EventHub HybridConnection MonitorAlert 'NamespaceTopic' PartnerDestination ServiceBusQueue ServiceBusTopic 'StorageQueue' WebHook (povinné)

EventSubscriptionFilter

Jméno	Popis	Hodnota
advancedFilters	Pole rozšířených filtrů, které se používají k filtrování odběrů událostí.	AdvancedFilter[]
enableAdvancedFilteringOnArrays	Umožňuje, aby se rozšířené filtry vyhodnocovaly proti poli hodnot místo toho, aby nečekaly hodnotu v jednotném čísle.	Bool
includedEventTypes	Seznam použitelných typů událostí, které musí být součástí odběru událostí. Pokud se chcete přihlásit k odběru všech výchozích typů událostí, nastavte IncludedEventTypes na hodnotu null.	string[]
isSubjectCaseSensitive	Určuje, jestli vlastnosti SubjectBeginsWith a SubjectEndsWith filtru rozlišovat malá a velká písmena.	Bool
subjectBeginsWith	Volitelný řetězec pro filtrování událostí odběru událostí na základě předpony cesty prostředku. Formát závisí na vydavateli událostí. V této cestě nejsou podporovány zástupné znaky.	řetězec
subjectEndsWith	Volitelný řetězec pro filtrování událostí odběru událostí na základě přípony cesty prostředku. V této cestě nejsou podporovány zástupné znaky.	řetězec

EventSubscriptionIdentity

Jméno	Popis	Hodnota
federatedIdentityCredentialInfo	Podrobnosti o přihlašovacích údajích federované identity (FIC) používané s doručováním prostředků	FederatedIdentityCredentialInfo
typ	Typ použité spravované identity. Může být buď SystemAssigned, nebo UserAssigned.	SystemAssigned UserAssigned
userAssignedIdentity	Identita uživatele přidružená k prostředku.	řetězec

EventSubscriptionProperties

Jméno	Popis	Hodnota
deadLetterDestination	Cíl nedoručených dopisů odběru události. Všechny události, které nelze doručit do cíle, se odešlou do cíle nedoručených dopisů. Používá identitu služby Azure Event Grid k získání ověřovacích tokenů používaných během doručování nebo nedoručování dopisů.	DeadLetterDestination
deadLetterWithResourceIdentity	Cíl nedoručených dopisů odběru události. Všechny události, které nelze doručit do cíle, se odešlou do cíle nedoručených dopisů. Používá nastavení spravované identity u nadřazeného prostředku (konkrétně tématu nebo domény) k získání ověřovacích tokenů používaných během doručování nebo nedoručených dopisů.	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	Informace o cíli, kde se události musí doručovat pro odběr událostí. Používá nastavení spravované identity u nadřazeného prostředku (konkrétně tématu nebo domény) k získání ověřovacích tokenů používaných během doručování nebo nedoručených dopisů.	DeliveryWithResourceIdentity
cíl	Informace o cíli, kde se události musí doručovat pro odběr událostí. Používá identitu služby Azure Event Grid k získání ověřovacích tokenů používaných během doručování nebo nedoručování dopisů.	EventSubscriptionDestination
eventDeliverySchema	Schéma doručování událostí pro odběr událostí.	CloudEventSchemaV1_0 CustomInputSchema EventGridSchema
expirationTimeUtc	Čas vypršení platnosti odběru události.	řetězec
filtr	Informace o filtru odběru událostí	EventSubscriptionFilter
popisky	Seznam popisků definovaných uživatelem	string[]
retryPolicy	Zásady opakování pro události. Můžete ho použít ke konfiguraci maximálního počtu pokusů o doručení a času na živé události.	RetryPolicy

FederatedIdentityCredentialInfo

Jméno	Popis	Hodnota
federatedClientId	Aplikace AAD s více tenanty, ke které jsou přidružené přihlašovací údaje federované identity (FIC).	řetězec Omezení: Minimální délka = 36 Maximální délka = 36 Model = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (povinné)

HybridConnectionEventSubscriptionDestination

Jméno	Popis	Hodnota
endpointType	Typ koncového bodu pro cíl odběru událostí	HybridConnection (povinné)
vlastnosti	Vlastnosti hybridního připojení cíle odběru událostí.	HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Jméno	Popis	Hodnota
deliveryAttributeMappings	Podrobnosti o atributu doručení	DeliveryAttributeMapping[]
resourceId	ID prostředku Azure hybridního připojení, které je cílem odběru událostí.	řetězec

IsNotNullAdvancedFilter

Jméno	Popis	Hodnota
operatorType	Typ operátoru použitý pro filtrování, například NumberIn, StringContains, BoolEquals a další.	IsNotNull (povinné)

IsNullOrUndefinedAdvancedFilter

Jméno	Popis	Hodnota
operatorType	Typ operátoru použitý pro filtrování, například NumberIn, StringContains, BoolEquals a další.	IsNullOrUndefined (povinné)