Microsoft.EventGrid eventSubscriptions 2020-01-01-preview

Č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@2020-01-01-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    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
        }
      ]
      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 AdvancedFilter

Nastavte operatorType vlastnost určit typ objektu.

Pro BoolEqualspoužijte:

{
  operatorType: 'BoolEquals'
  value: bool
}

Pro NumberGreaterThanpoužijte:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

Pro NumberGreaterThanOrEqualspoužijte:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

Pro NumberInpoužijte:

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

Pro NumberLessThanpoužijte:

{
  operatorType: 'NumberLessThan'
  value: int
}

Pro NumberLessThanOrEqualspoužijte:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

Pro NumberNotInpoužijte:

{
  operatorType: 'NumberNotIn'
  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 StringNotInpoužijte:

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

EventSubscriptionDestination – objekty

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

Pro AzureFunctionpoužijte:

{
  endpointType: 'AzureFunction'
  properties: {
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
    resourceId: 'string'
  }
}

Pro EventHubu použijte:

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

ProHybridConnection použijte:

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

Pro ServiceBusQueuepoužijte:

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

Pro ServiceBusTopicpoužijte:

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

Pro služby StorageQueue použijte:

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

Pro webhookpoužijte:

{
  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    endpointUrl: 'string'
    maxEventsPerBatch: int
    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 . Pro typ NumberGreaterThanAdvancedFilternastavte hodnotu NumberGreaterThanAdVancedFilter . Nastavte na NumberGreaterThanOrEquals pro typ NumberGreaterThanOrEqualsAdvancedFilter. Pro typ NumberIn nastavte hodnotu NumberInAdvancedFilter. Pro typ NumberLessThanAdvancedFilternastavte hodnotu NumberLessThan. Nastavit na 'NumberLessThanOrEquals' pro typ NumberLessThanOrEqualsAdvancedFilter. Pro typ NumberNotInAdvancedFilternastavte hodnotu NumberNotInIn. Pro typ StringBeginsWithAdvancedFilternastavte hodnotu StringBeginsWithAdvancedFilter . Pro typ StringContainsAdvancedFilternastavte hodnotu StringContainsAdvancedFilter . Nastavte na StringEndsWith pro typ StringEndsWithAdvancedFilter. Nastavte na StringIn pro typ StringInAdvancedFilter. Pro typ StringNotInAdvancedFilter nastavte hodnotu StringNotInAdvancedFilter.	BoolEquals 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' StringBeginsWith StringContains StringEndsWith StringIn 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
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é)

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
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 . 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 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[]
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

EventSubscriptionProperties

Jméno	Popis	Hodnota
deadLetterDestination	Cíl DeadLetter odběru událostí.	DeadLetterDestination
cíl	Informace o cíli, kde se události musí doručovat pro odběr událostí.	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

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
resourceId	ID prostředku Azure hybridního připojení, které je cílem odběru událostí.	řetězec