Microsoft.EventGrid-Namespaces/topics/eventSubscriptions 2024-12-15-preview

Artikel
12/16/2024

Bicep-Ressourcendefinition

Der Ressourcentyp namespaces/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/namespaces/topics/eventSubscriptions-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2024-12-15-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    deliveryConfiguration: {
      deliveryMode: 'string'
      push: {
        deadLetterDestinationWithResourceIdentity: {
          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
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
      }
      queue: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            federatedIdentityCredentialInfo: {
              federatedClientId: 'string'
            }
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
        receiveLockDurationInSeconds: int
      }
    }
    eventDeliverySchema: 'string'
    expirationTimeUtc: 'string'
    filtersConfiguration: {
      filters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see Filter objects
        }
      ]
      includedEventTypes: [
        'string'
      ]
    }
    tags: {
      {customized property}: 'string'
    }
  }
}

DeadLetterDestination-Objekte

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

Verwenden Sie für StorageBlob-:

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

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

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

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

Verwenden Sie für NamespaceTopic-:

{
  endpointType: 'NamespaceTopic'
  properties: {
    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
  }
}

Filterobjekte

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

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

BoolEqualsFilter

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 abzurufen, die während der 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)

DeliveryConfiguration

Name	Beschreibung	Wert
deliveryMode	Übermittlungsmodus des Ereignisabonnements.	"Push" 'Warteschlange'
Drücken	Diese Eigenschaft sollte aufgefüllt werden, wenn deliveryMode pusht und Informationen zum Pushabonnement darstellt.	PushInfo-
Schlange	Diese Eigenschaft sollte aufgefüllt werden, wenn deliveryMode Warteschlange ist und Informationen zum Warteschlangenabonnement darstellt.	QueueInfo-

DeliveryWithResourceIdentity

Name	Beschreibung	Wert
Bestimmungsort	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 abzurufen, die während der Übermittlung 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. Set to 'MonitorAlert' for type MonitorAlertEventSubscriptionDestination. Legen Sie für den Typ NamespaceTopicEventSubscriptionDestinationauf "NamespaceTopic" fest. 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" "MonitorAlert" "NamespaceTopic" 'PartnerDestination' 'ServiceBusQueue' 'ServiceBusTopic' "StorageQueue" 'WebHook' (erforderlich)

EventSubscriptionIdentity

Name	Beschreibung	Wert
federatedIdentityCredentialInfo	Die Details der Federated Identity Credential (FIC), die mit der Ressourcenübermittlung verwendet werden.	FederatedIdentityCredentialInfo-
Art	Der Typ der verwendeten verwalteten Identität. Kann entweder "SystemAssigned" oder "UserAssigned" sein.	'SystemAssigned' "UserAssigned"
userAssignedIdentity	Die der Ressource zugeordnete Benutzeridentität.	Schnur

FederatedIdentityCredentialInfo

Name	Beschreibung	Wert
federatedClientId	Die Mehrinstanzen-AAD-Anwendung, der die Verbundidentitätsanmeldeinformationen (Federated Identity Credential, FIC) zugeordnet ist.	Schnur Zwänge: Min. Länge = 36 Maximale Länge = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (erforderlich)

Filter

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 BoolEqualsFilterauf "BoolEqualsFilter" fest. Legen Sie für den Typ IsNotNullFilter-auf 'IsNotNullFilter' fest. Wird für den Typ IsNullOrUndefinedFilterauf 'IsNullOrUndefinedFilter' festgelegt. Legen Sie für den Typ NumberGreaterThanFilterauf "NumberGreaterThanFilter" fest. Set to 'NumberGreaterThanOrEquals' for type NumberGreaterThanOrEqualsFilter. Set to 'NumberIn' for type NumberInFilter. Set to 'NumberInRange' for type NumberInRangeFilter. Set to 'NumberLessThan' for type NumberLessThanFilter. Set to 'NumberLessThanOrEquals' for type NumberLessThanOrEqualsFilter. Set to 'NumberNotIn' for type NumberNotInFilter. Set to 'NumberNotInRange' for type NumberNotInRangeFilter. Set to 'StringBeginsWith' for type StringBeginsWithFilter. Set to 'StringContains' for type StringContainsFilter. Set to 'StringEndsWith' for type StringEndsWithFilter. Set to 'StringIn' for type StringInFilter. Set to 'StringNotBeginsWith' for type StringNotBeginsWithFilter. Set to 'StringNotContains' for type StringNotContainsFilter. Set to 'StringNotEndsWith' for type StringNotEndsWithFilter. Set to 'StringNotIn' for type StringNotInFilter.	"BoolEquals" 'IsNotNull' 'IsNullOrUndefined' "NumberGreaterThan" "NumberGreaterThanOrEquals" 'NumberIn' 'NumberInRange' "NumberLessThan" "NumberLessThanOrEquals" 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (erforderlich)

FiltersConfiguration

Name	Beschreibung	Wert
Filter	Ein Array von Filtern, die zum Filtern von Ereignisabonnements verwendet werden.	Filter-[]
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[]

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

IsNotNullFilter

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

IsNullOrUndefinedFilter

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