Microsoft.EventGrid topics/eventSubscriptions 2023-06-01-preview

Artikel
12/16/2024

Bicep-Ressourcendefinition

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

Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

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

Ressourcenformat

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

resource symbolicname 'Microsoft.EventGrid/topics/eventSubscriptions@2023-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        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
    }
  }
}

DeliveryAttributeMapping-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für dynamischenFolgendes:

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

Verwenden Sie für Static:

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

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: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
    resourceId: 'string'
  }
}

Verwenden Sie für EventHub-:

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

Verwenden Sie für HybridConnection-:

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

Verwenden Sie für PartnerDestination:

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

Verwenden Sie für ServiceBusQueue:

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

Verwenden Sie für ServiceBusTopic-:

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

Verwenden Sie für StorageQueue-:

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

Verwenden Sie für WebHook-:

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

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 IsNotNull-:

{
  operatorType: 'IsNotNull'
}

Verwenden Sie für IsNullOrUndefined:

{
  operatorType: 'IsNullOrUndefined'
}

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 NumberInRange-Folgendes:

{
  operatorType: 'NumberInRange'
  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 NumberNotInRange-Folgendes:

{
  operatorType: 'NumberNotInRange'
  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 StringNotBeginsWith:

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

Verwenden Sie für StringNotContains-:

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

Verwenden Sie für StringNotEndsWith:

{
  operatorType: 'StringNotEndsWith'
  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. Legen Sie für den Typ IsNotNullAdvancedFilterauf "IsNotNull" fest. Wird für den Typ IsNullOrUndefined auf "IsNullOrUndefinedAdvancedFilter"festgelegt. Set to 'NumberGreaterThan' for type NumberGreaterThanAdvancedFilter. Set to 'NumberGreaterThanOrEquals' for type NumberGreaterThanOrEqualsAdvancedFilter. Set to 'NumberIn' for type NumberInAdvancedFilter. Set to 'NumberInRange' for type NumberInRangeAdvancedFilter. Set to 'NumberLessThan' for type NumberLessThanAdvancedFilter. Set to 'NumberLessThanOrEquals' for type NumberLessThanOrEqualsAdvancedFilter. Legen Sie für den Typ NumberNotInAdvancedFilterauf "NumberNotIn" fest. Set to 'NumberNotInRange' for type NumberNotInRangeAdvancedFilter. 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 'StringNotBeginsWith' for type StringNotBeginsWithAdvancedFilter. Set to 'StringNotContains' for type StringNotContainsAdvancedFilter. Set to 'StringNotEndsWith' for type StringNotEndsWithAdvancedFilter. Set to 'StringNotIn' for type StringNotInAdvancedFilter.	"BoolEquals" 'IsNotNull' 'IsNullOrUndefined' "NumberGreaterThan" "NumberGreaterThanOrEquals" 'NumberIn' 'NumberInRange' "NumberLessThan" "NumberLessThanOrEquals" 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' '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
deliveryAttributeMappings	Details des Übermittlungsattributs.	DeliveryAttributeMapping[]
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)

DeadLetterWithResourceIdentity

Name	Beschreibung	Wert
deadLetterDestination	Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet das Setup der verwalteten Identität in der übergeordneten Ressource (nämlich Thema oder Domäne), um die Authentifizierungstoken zu erhalten, die während der Übermittlung/Inschrift verwendet werden.	DeadLetterDestination
Identität	Die Identität, die beim Dead Lettering-Ereignis verwendet werden soll.	EventSubscriptionIdentity-

DeliveryAttributeMapping

Name	Beschreibung	Wert
Name	Name des Übermittlungsattributs oder -headers.	Schnur
Art	Legen Sie für den Typ DynamicDeliveryAttributeMappingauf "Dynamic" fest. Legen Sie für den Typ StaticDeliveryAttributeMappingauf "Static" fest.	"Dynamisch" "Statisch" (erforderlich)

DeliveryWithResourceIdentity

Name	Beschreibung	Wert
Bestimmungsort	Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Inschrift verwendet werden.	EventSubscriptionDestination
Identität	Die Identität, die beim Bereitstellen von Ereignissen verwendet werden soll.	EventSubscriptionIdentity-

DynamicDeliveryAttributeMapping

Name	Beschreibung	Wert
Eigenschaften	Eigenschaften der dynamischen Übermittlungsattributzuordnung.	DynamicDeliveryAttributeMappingProperties
Art	Typ des Übermittlungsattributs oder des Headernamens.	"Dynamisch" (erforderlich)

DynamicDeliveryAttributeMappingProperties

Name	Beschreibung	Wert
sourceField	JSON-Pfad im Ereignis, das Attributwert enthält.	Schnur

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
deliveryAttributeMappings	Details des Übermittlungsattributs.	DeliveryAttributeMapping[]
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. Legen Sie für den Typ PartnerEventSubscriptionDestinationauf "PartnerDestination" fest. 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" 'PartnerDestination' 'ServiceBusQueue' 'ServiceBusTopic' "StorageQueue" 'WebHook' (erforderlich)

EventSubscriptionFilter

Name	Beschreibung	Wert
advancedFilters	Ein Array erweiterter Filter, die zum Filtern von Ereignisabonnements verwendet werden.	AdvancedFilter-[]
enableAdvancedFilteringOnArrays	Ermöglicht die Auswertung erweiterter Filter anhand eines Wertearrays, anstatt einen Singularwert zu erwarten.	Bool
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

EventSubscriptionIdentity

Name	Beschreibung	Wert
Art	Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten.	'SystemAssigned' "UserAssigned"
userAssignedIdentity	Die der Ressource zugeordnete Benutzeridentität.	Schnur

EventSubscriptionProperties

Name	Beschreibung	Wert
deadLetterDestination	Das Ziel des Ziels für einen inaktiven Buchstaben des Ereignisabonnements. Jedes Ereignis, das nicht an das Ziel des Absenders übermittelt werden kann, wird an das Ziel des Inschriftschreibens gesendet. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Inschrift verwendet werden.	DeadLetterDestination
deadLetterWithResourceIdentity	Das Ziel des Ziels für einen inaktiven Buchstaben des Ereignisabonnements. Jedes Ereignis, das nicht an das Ziel des Absenders übermittelt werden kann, wird an das Ziel des Inschriftschreibens gesendet. Verwendet das Setup der verwalteten Identität in der übergeordneten Ressource (nämlich Thema oder Domäne), um die Authentifizierungstoken zu erhalten, die während der Übermittlung/Inschrift verwendet werden.	DeadLetterWithResourceIdentity-
deliveryWithResourceIdentity	Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet das Setup der verwalteten Identität in der übergeordneten Ressource (nämlich Thema oder Domäne), um die Authentifizierungstoken zu erhalten, die während der Übermittlung/Inschrift verwendet werden.	DeliveryWithResourceIdentity-
Bestimmungsort	Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Inschrift verwendet werden.	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
deliveryAttributeMappings	Details des Übermittlungsattributs.	DeliveryAttributeMapping[]
resourceId	Die Azure-Ressourcen-ID einer Hybridverbindung, die das Ziel eines Ereignisabonnements ist.	Schnur

IsNotNullAdvancedFilter

Name	Beschreibung	Wert
operatorType	Der Zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere.	'IsNotNull' (erforderlich)

IsNullOrUndefinedAdvancedFilter

Name	Beschreibung	Wert
operatorType	Der Zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere.	'IsNullOrUndefined' (erforderlich)