Microsoft.EventGrid eventSubscriptions 2020-06-01

Artikel
12/19/2024

Bicep-Ressourcendefinition

Der Ressourcentyp "eventSubscriptions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.EventGrid/eventSubscriptions-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2020-06-01' = {
  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-Objekte

Legen Sie den endpointType--Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für StorageBlob-:

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

EventSubscriptionDestination-Objekte

Legen Sie den endpointType--Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AzureFunction:

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

Verwenden Sie für EventHub-:

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

Verwenden Sie für HybridConnection-:

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

Verwenden Sie für ServiceBusQueue:

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

Verwenden Sie für ServiceBusTopic-:

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

Verwenden Sie für StorageQueue-:

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

Verwenden Sie für WebHook-:

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

AdvancedFilter-Objekte

Legen Sie die operatorType--Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für BoolEquals:

{
  operatorType: 'BoolEquals'
  value: bool
}

Verwenden Sie für NumberGreaterThan:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

Verwenden Sie für NumberGreaterThanOrEquals:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

Verwenden Sie für NumberIn-Folgendes:

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

Verwenden Sie für NumberLessThan-:

{
  operatorType: 'NumberLessThan'
  value: int
}

Verwenden Sie für NumberLessThanOrEquals:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

Verwenden Sie für NumberNotIn-Folgendes:

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

Verwenden Sie für StringBeginsWith:

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

Verwenden Sie für StringContains-:

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

Verwenden Sie für StringEndsWith:

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

Verwenden Sie für StringIn-:

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

Verwenden Sie für StringNotIn-:

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

Eigenschaftswerte

AdvancedFilter

Name	Beschreibung	Wert
Schlüssel	Das Feld/die Eigenschaft im Ereignis, auf dem Sie filtern möchten.	Schnur
operatorType	Legen Sie für den Typ BoolEqualsAdvancedFilterauf "BoolEquals" fest. Set to 'NumberGreaterThan' for type NumberGreaterThanAdvancedFilter. Set to 'NumberGreaterThanOrEquals' for type NumberGreaterThanOrEqualsAdvancedFilter. Set to 'NumberIn' for type NumberInAdvancedFilter. Set to 'NumberLessThan' for type NumberLessThanAdvancedFilter. Set to 'NumberLessThanOrEquals' for type NumberLessThanOrEqualsAdvancedFilter. Legen Sie für den Typ NumberNotInAdvancedFilterauf "NumberNotIn" fest. Set to 'StringBeginsWith' for type StringBeginsWithAdvancedFilter. Set to 'StringContains' for type StringContainsAdvancedFilter. Set to 'StringEndsWith' for type StringEndsWithAdvancedFilter. Set to 'StringIn' for type StringInAdvancedFilter. Set to 'StringNotIn' for type StringNotInAdvancedFilter.	"BoolEquals" "NumberGreaterThan" "NumberGreaterThanOrEquals" 'NumberIn' "NumberLessThan" "NumberLessThanOrEquals" 'NumberNotIn' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotIn' (erforderlich)

AzureFunctionEventSubscriptionDestination

Name	Beschreibung	Wert
endpointType	Typ des Endpunkts für das Ereignisabonnementziel.	"AzureFunction" (erforderlich)
Eigenschaften	Azure-Funktionseigenschaften des Ereignisabonnementsziels.	AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Name	Beschreibung	Wert
maxEventsPerBatch	Maximale Anzahl von Ereignissen pro Batch.	Int
preferredBatchSizeInKilobytes	Bevorzugte Batchgröße in Kilobyte.	Int
resourceId	Die Azure-Ressourcen-ID, die den Endpunkt des Azure-Funktionsziels eines Ereignisabonnements darstellt.	Schnur

BoolEqualsAdvancedFilter

Name	Beschreibung	Wert
operatorType	Der Zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere.	"BoolEquals" (erforderlich)
Wert	Der boolesche Filterwert.	Bool

DeadLetterDestination

Name	Beschreibung	Wert
endpointType	Legen Sie für den Typ StorageBlobDeadLetterDestinationauf "StorageBlob" fest.	"StorageBlob" (erforderlich)

EventHubEventSubscriptionDestination

Name	Beschreibung	Wert
endpointType	Typ des Endpunkts für das Ereignisabonnementziel.	'EventHub' (erforderlich)
Eigenschaften	Event Hub-Eigenschaften des Ziels des Ereignisabonnements.	EventHubEventSubscriptionDestinationProperties-

EventHubEventSubscriptionDestinationProperties

Name	Beschreibung	Wert
resourceId	Die Azure-Ressourcen-ID, die den Endpunkt eines Event Hub-Ziels eines Ereignisabonnements darstellt.	Schnur

EventSubscriptionDestination

Name	Beschreibung	Wert
endpointType	Legen Sie für den Typ AzureFunctionEventSubscriptionDestinationauf "AzureFunctionFunction" fest. Set to 'EventHub' for type EventHubEventSubscriptionDestination. Set to 'HybridConnection' for type HybridConnectionEventSubscriptionDestination. Set to 'ServiceBusQueue' for type ServiceBusQueueEventSubscriptionDestination. Set to 'ServiceBusTopic' for type ServiceBusTopicEventSubscriptionDestination. Legen Sie für den Typ StorageQueueEventSubscriptionDestinationauf "StorageQueue" fest. Legen Sie für den Typ WebHookEventSubscriptionDestinationauf 'WebHook' fest.	"AzureFunction" 'EventHub' "HybridConnection" 'ServiceBusQueue' 'ServiceBusTopic' "StorageQueue" 'WebHook' (erforderlich)

EventSubscriptionFilter

Name	Beschreibung	Wert
advancedFilters	Ein Array erweiterter Filter, die zum Filtern von Ereignisabonnements verwendet werden.	AdvancedFilter-[]
includedEventTypes	Eine Liste der anwendbaren Ereignistypen, die Teil des Ereignisabonnements sein müssen. Wenn alle Standardereignistypen abonniert werden sollen, legen Sie die IncludedEventTypes auf NULL fest.	string[]
isSubjectCaseSensitive	Gibt an, ob die Eigenschaften SubjectBeginsWith und SubjectEndsWith des Filters sollte auf die Groß-/Kleinschreibung unterschieden werden.	Bool
subjectBeginsWith	Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadpräfix. Das Format dieser Ereignisse hängt vom Herausgeber der Ereignisse ab. In diesem Pfad werden keine Wildcardzeichen unterstützt.	Schnur
subjectEndsWith	Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadsuffix. In diesem Pfad werden keine Wildcardzeichen unterstützt.	Schnur

EventSubscriptionProperties

Name	Beschreibung	Wert
deadLetterDestination	Das DeadLetter-Ziel des Ereignisabonnements.	DeadLetterDestination
Bestimmungsort	Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen.	EventSubscriptionDestination
eventDeliverySchema	Das Ereignisübermittlungsschema für das Ereignisabonnement.	"CloudEventSchemaV1_0" 'CustomInputSchema' 'EventGridSchema'
expirationTimeUtc	Ablaufzeit des Ereignisabonnements.	Schnur
Filter	Informationen zum Filter für das Ereignisabonnement.	EventSubscriptionFilter-
etiketten	Liste der benutzerdefinierten Bezeichnungen.	string[]
retryPolicy	Die Wiederholungsrichtlinie für Ereignisse. Dies kann verwendet werden, um die maximale Anzahl von Übermittlungsversuchen und Zeit für Ereignisse zu konfigurieren.	RetryPolicy-

HybridConnectionEventSubscriptionDestination

Name	Beschreibung	Wert
endpointType	Typ des Endpunkts für das Ereignisabonnementziel.	"HybridConnection" (erforderlich)
Eigenschaften	Hybridverbindungseigenschaften des Ereignisabonnementziels.	HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Name	Beschreibung	Wert
resourceId	Die Azure-Ressourcen-ID einer Hybridverbindung, die das Ziel eines Ereignisabonnements ist.	Schnur