Microsoft.EventGrid eventSubscriptions

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@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-objekt

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

För StorageBlobanvänder du:

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

EventSubscriptionDestination-objekt

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

För AzureFunctionanvänder du:

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

För EventHubanvänder du:

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

För HybridConnectionanvänder du:

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

För MonitorAlertanvänder du:

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

För NamespaceTopicanvänder du:

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

För PartnerDestinationanvänder du:

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

För ServiceBusQueueanvänder du:

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

För ServiceBusTopicanvänder du:

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

För StorageQueueanvänder du:

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

För WebHookanvänder du:

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

DeliveryAttributeMapping-objekt

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

För dynamiskanvänder du:

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

För Staticanvänder du:

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

AdvancedFilter-objekt

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

För BoolEqualsanvänder du:

{
  operatorType: 'BoolEquals'
  value: bool
}

För IsNotNullanvänder du:

{
  operatorType: 'IsNotNull'
}

För IsNullOrUndefinedanvänder du:

{
  operatorType: 'IsNullOrUndefined'
}

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 NumberInRangeanvänder du:

{
  operatorType: 'NumberInRange'
  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 NumberNotInRange-använder du:

{
  operatorType: 'NumberNotInRange'
  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 StringNotBeginsWithanvänder du:

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

För StringNotContainsanvänder du:

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

För StringNotEndsWithanvänder du:

{
  operatorType: 'StringNotEndsWith'
  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 IsNotNull för typen IsNotNullAdvancedFilter. Ange till "IsNullOrUndefined" för typen IsNullOrUndefinedAdvancedFilter. Ange till NumberGreaterThan för typ NumberGreaterThanAdvancedFilter. Ange till NumberGreaterThanOrEquals för typen NumberGreaterThanOrEqualsAdvancedFilter. Ange till NumberIn för typ NumberInAdvancedFilter. Ange till NumberInRange för typ NumberInRangeAdvancedFilter. Ange till NumberLessThan för typen NumberLessThanAdvancedFilter. Ange till NumberLessThanOrEquals för typen NumberLessThanOrEqualsAdvancedFilter. Ange till NumberNotIn för typ NumberNotInAdvancedFilter. Ange till NumberNotInRange för typ NumberNotInRangeAdvancedFilter. 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 StringNotBeginsWith för typ StringNotBeginsWithAdvancedFilter. Ange till "StringNotContains" för typen StringNotContainsAdvancedFilter. Ange till StringNotEndsWith för typ StringNotEndsWithAdvancedFilter. Ange till "StringNotIn" för typ StringNotInAdvancedFilter.	"BoolEquals" "IsNotNull" "IsNullOrUndefined" "NumberGreaterThan" "NumberGreaterThanOrEquals" "NumberIn" "NumberInRange" "NumberLessThan" "NumberLessThanOrEquals" "NumberNotIn" "NumberNotInRange" "StringBeginsWith" "StringContains" "StringEndsWith" 'StringIn' "StringNotBeginsWith" "StringNotContains" "StringNotEndsWith" "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
deliveryAttributeMappings	Information om leveransattribut.	DeliveryAttributeMapping[]
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)

DeadLetterWithResourceIdentity

Namn	Beskrivning	Värde
deadLetterDestination	Information om målet där händelser måste levereras för händelseprenumerationen. Använder konfigurationen av hanterad identitet på den överordnade resursen (dvs. ämne eller domän) för att hämta de autentiseringstoken som används under obeställbara bokstäver.	DeadLetterDestination
identitet	Identiteten som ska användas vid händelser med obeställbara bokstäver.	EventSubscriptionIdentity

DeliveryAttributeMapping

Namn	Beskrivning	Värde
Namn	Namnet på leveransattributet eller huvudet.	sträng
typ	Ange till Dynamisk för typen DynamicDeliveryAttributeMapping. Ange till "Static" för typen StaticDeliveryAttributeMapping.	"Dynamisk" "Statisk" (krävs)

DeliveryWithResourceIdentity

Namn	Beskrivning	Värde
destination	Information om målet där händelser måste levereras för händelseprenumerationen. Använder konfigurationen av hanterad identitet på den överordnade resursen (dvs. ämne eller domän) för att hämta de autentiseringstoken som används under leveransen.	EventSubscriptionDestination
identitet	Identiteten som ska användas när händelser levereras.	EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Namn	Beskrivning	Värde
Egenskaper	Egenskaper för mappning av dynamiska leveransattribut.	DynamicDeliveryAttributeMappingProperties
typ	Typ av leveransattribut eller rubriknamn.	"Dynamisk" (krävs)

DynamicDeliveryAttributeMappingProperties

Namn	Beskrivning	Värde
sourceField	JSON-sökväg i händelsen som innehåller attributvärde.	sträng

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Namn	Beskrivning	Värde
deliveryAttributeMappings	Information om leveransattribut.	DeliveryAttributeMapping[]
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 "MonitorAlert" för typen MonitorAlertEventSubscriptionDestination. Ange till "NamespaceTopic" för typen NamespaceTopicEventSubscriptionDestination. Ange till PartnerDestination för typen PartnerEventSubscriptionDestination. 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" "MonitorAlert" "NamespaceTopic" "PartnerDestination" "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[]
enableAdvancedFilteringOnArrays	Gör att avancerade filter kan utvärderas mot en matris med värden i stället för att förvänta sig ett singularvärde.	Bool
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

EventSubscriptionIdentity

Namn	Beskrivning	Värde
federatedIdentityCredentialInfo	Information om federerade identitetsautentiseringsuppgifter (FIC) som används med resursleveransen.	FederatedIdentityCredentialInfo
typ	Den typ av hanterad identitet som används. Kan vara antingen "SystemAssigned" eller "UserAssigned".	"SystemAssigned" "UserAssigned"
userAssignedIdentity	Användaridentiteten som är associerad med resursen.	sträng

EventSubscriptionProperties

Namn	Beskrivning	Värde
deadLetterDestination	Målet för händelseprenumerationen med obeställbara bokstäver. Alla händelser som inte kan levereras till målet skickas till målet med obeställbara meddelanden. Använder Azure Event Grids identitet för att hämta de autentiseringstoken som används under leverans/obeställbara bokstäver.	DeadLetterDestination
deadLetterWithResourceIdentity	Målet för händelseprenumerationen med obeställbara bokstäver. Alla händelser som inte kan levereras till målet skickas till målet med obeställbara meddelanden. Använder konfigurationen av hanterad identitet på den överordnade resursen (dvs. ämne eller domän) för att hämta de autentiseringstoken som används under leverans/obeställbara bokstäver.	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	Information om målet där händelser måste levereras för händelseprenumerationen. Använder konfigurationen av hanterad identitet på den överordnade resursen (dvs. ämne eller domän) för att hämta de autentiseringstoken som används under leverans/obeställbara bokstäver.	DeliveryWithResourceIdentity
destination	Information om målet där händelser måste levereras för händelseprenumerationen. Använder Azure Event Grids identitet för att hämta de autentiseringstoken som används under leverans/obeställbara bokstäver.	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

FederatedIdentityCredentialInfo

Namn	Beskrivning	Värde
federatedClientId	AAD-programmet för flera klientorganisationer där FIC (Federated Identity Credential) är associerat med.	sträng Begränsningar: Min längd = 36 Maximal längd = 36 Mönster = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (krävs)

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

Namn	Beskrivning	Värde
deliveryAttributeMappings	Information om leveransattribut.	DeliveryAttributeMapping[]
resourceId	Azure-resurs-ID för en hybridanslutning som är målet för en händelseprenumeration.	sträng

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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