Microsoft.EventGrid eventSubscriptions 2020-01-01-preview

Artikel
12/16/2024

Bicep-resursdefinition

Resurstypen eventSubscriptions kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.EventGrid/eventSubscriptions-resurs lägger du till följande Bicep i mallen.

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

EventSubscriptionDestination-objekt

Ange egenskapen endpointType för att ange typ av objekt.

För AzureFunctionanvänder du:

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

För EventHubanvänder du:

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

För HybridConnectionanvänder du:

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

För ServiceBusQueueanvänder du:

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

För ServiceBusTopicanvänder du:

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

För StorageQueueanvänder du:

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

För WebHookanvänder du:

{
  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    endpointUrl: 'string'
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
  }
}

DeadLetterDestination-objekt

Ange egenskapen endpointType för att ange typ av objekt.

För StorageBlobanvänder du:

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

AdvancedFilter-objekt

Ange egenskapen operatorType för att ange typ av objekt.

För BoolEqualsanvänder du:

{
  operatorType: 'BoolEquals'
  value: bool
}

För NumberGreaterThananvänder du:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

För NumberGreaterThanOrEqualsanvänder du:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

För NumberInanvänder du:

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

För NumberLessThananvänder du:

{
  operatorType: 'NumberLessThan'
  value: int
}

För NumberLessThanOrEqualsanvänder du:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

För NumberNotInanvänder du:

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

För StringBeginsWithanvänder du:

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

För StringContainsanvänder du:

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

För StringEndsWithanvänder du:

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

För StringInanvänder du:

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

För StringNotInanvänder du:

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

Egenskapsvärden

AdvancedFilter

Namn	Beskrivning	Värde
nyckel	Fältet/egenskapen i händelsen baserat på vilken du vill filtrera.	sträng
operatorType	Ange till "BoolEquals" för typen BoolEqualsAdvancedFilter. Ange till NumberGreaterThan för typ NumberGreaterThanAdvancedFilter. Ange till NumberGreaterThanOrEquals för typen NumberGreaterThanOrEqualsAdvancedFilter. Ange till NumberIn för typ NumberInAdvancedFilter. Ange till NumberLessThan för typen NumberLessThanAdvancedFilter. Ange till NumberLessThanOrEquals för typen NumberLessThanOrEqualsAdvancedFilter. Ange till NumberNotIn för typ NumberNotInAdvancedFilter. Ange till StringBeginsWith för typ StringBeginsWithAdvancedFilter. Ange till "StringContains" för typen StringContainsAdvancedFilter. Ange till StringEndsWith för typen StringEndsWithAdvancedFilter. Ange till StringIn för typen StringInAdvancedFilter. Ange till "StringNotIn" för typ StringNotInAdvancedFilter.	"BoolEquals" "NumberGreaterThan" "NumberGreaterThanOrEquals" "NumberIn" "NumberLessThan" "NumberLessThanOrEquals" "NumberNotIn" "StringBeginsWith" "StringContains" "StringEndsWith" 'StringIn' "StringNotIn" (krävs)

AzureFunctionEventSubscriptionDestination

Namn	Beskrivning	Värde
endpointType	Typ av slutpunkt för händelseprenumerationsmålet	"AzureFunction" (krävs)
Egenskaper	Azure-funktionsegenskaper för händelseprenumerationens mål.	AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Namn	Beskrivning	Värde
maxEventsPerBatch	Maximalt antal händelser per batch.	Int
preferredBatchSizeInKilobytes	Önskad batchstorlek i Kilobytes.	Int
resourceId	Det Azure-resurs-ID som representerar slutpunkten för Azure-funktionsmålet för en händelseprenumeration.	sträng

BoolEqualsAdvancedFilter

Namn	Beskrivning	Värde
operatorType	Operatortypen som används för filtrering, t.ex. NumberIn, StringContains, BoolEquals och andra.	"BoolEquals" (krävs)
värde	Det booleska filtervärdet.	Bool

DeadLetterDestination

Namn	Beskrivning	Värde
endpointType	Ange till "StorageBlob" för typen StorageBlobDeadLetterDestination.	"StorageBlob" (krävs)

EventHubEventSubscriptionDestination

Namn	Beskrivning	Värde
endpointType	Typ av slutpunkt för händelseprenumerationsmålet	"EventHub" (krävs)
Egenskaper	Event Hub-egenskaper för händelseprenumerationsmålet	EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Namn	Beskrivning	Värde
resourceId	Det Azure-resurs-ID som representerar slutpunkten för ett Event Hub-mål för en händelseprenumeration.	sträng

EventSubscriptionDestination

Namn	Beskrivning	Värde
endpointType	Ange till "AzureFunction" för typen AzureFunctionEventSubscriptionDestination. Ange till EventHub för typen EventHubEventSubscriptionDestination. Ange till "HybridConnection" för typen HybridConnectionEventSubscriptionDestination. Ange till "ServiceBusQueue" för typen ServiceBusQueueEventSubscriptionDestination. Ange till "ServiceBusTopic" för typen ServiceBusTopicEventSubscriptionDestination. Ange till "StorageQueue" för typen StorageQueueEventSubscriptionDestination. Ange till WebHook för typen WebHookEventSubscriptionDestination.	"AzureFunction" "EventHub" "HybridConnection" "ServiceBusQueue" "ServiceBusTopic" "StorageQueue" "WebHook" (krävs)

EventSubscriptionFilter

Namn	Beskrivning	Värde
advancedFilters	En matris med avancerade filter som används för att filtrera händelseprenumerationer.	AdvancedFilter[]
includedEventTypes	En lista över tillämpliga händelsetyper som måste ingå i händelseprenumerationen. Om du vill prenumerera på alla standardhändelsetyper anger du IncludedEventTypes till null.	string[]
isSubjectCaseSensitive	Anger om egenskaperna SubjectBeginsWith och SubjectEndsWith för filtret bör jämföras på ett skiftlägeskänsligt sätt.	Bool
subjectBeginsWith	En valfri sträng för att filtrera händelser för en händelseprenumeration baserat på ett resurssökvägsprefix. Formatet för detta beror på utgivaren av händelserna. Jokertecken stöds inte i den här sökvägen.	sträng
subjectEndsWith	En valfri sträng för att filtrera händelser för en händelseprenumeration baserat på ett suffix för resurssökväg. Jokertecken stöds inte i den här sökvägen.	sträng

EventSubscriptionProperties

Namn	Beskrivning	Värde
deadLetterDestination	DeadLetter-målet för händelseprenumerationen.	DeadLetterDestination
destination	Information om målet där händelser måste levereras för händelseprenumerationen.	EventSubscriptionDestination
eventDeliverySchema	Händelseleveransschemat för händelseprenumerationen.	"CloudEventSchemaV1_0" "CustomInputSchema" "EventGridSchema"
expirationTimeUtc	Förfallotid för händelseprenumerationen.	sträng
filter	Information om filtret för händelseprenumerationen.	EventSubscriptionFilter
Etiketter	Lista över användardefinierade etiketter.	string[]
retryPolicy	Återförsöksprincipen för händelser. Detta kan användas för att konfigurera maximalt antal leveransförsök och tid att leva för händelser.	RetryPolicy

HybridConnectionEventSubscriptionDestination

Namn	Beskrivning	Värde
endpointType	Typ av slutpunkt för händelseprenumerationsmålet	"HybridConnection" (krävs)
Egenskaper	Hybridanslutningsegenskaper för händelseprenumerationsmålet	HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Namn	Beskrivning	Värde
resourceId	Azure-resurs-ID för en hybridanslutning som är målet för en händelseprenumeration.	sträng