Microsoft.EventGrid eventSubscriptions

Artikel
12/16/2024

Bicep-resourcedefinitie

Het resourcetype eventSubscriptions kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.EventGrid/eventSubscriptions wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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

Stel de eigenschap endpointType in om het type object op te geven.

Gebruik voor StorageBlob-:

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

DeliveryAttributeMapping-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor Dynamische:

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

Gebruik voor Statische:

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

AdvancedFilter-objecten

Stel de eigenschap operatorType in om het type object op te geven.

Gebruik voor BoolEquals:

{
  operatorType: 'BoolEquals'
  value: bool
}

Gebruik voor IsNotNull-:

{
  operatorType: 'IsNotNull'
}

Gebruik voor IsNullOrUndefined:

{
  operatorType: 'IsNullOrUndefined'
}

Gebruik voor NumberGreaterThan:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

Gebruik voor NumberGreaterThanOrEquals:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

Gebruik voor NumberIn:

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

Gebruik voor NumberInRange:

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

Gebruik voor NumberLessThan:

{
  operatorType: 'NumberLessThan'
  value: int
}

Gebruik voor NumberLessThanOrEquals:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

Gebruik voor NumberNotIn:

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

Gebruik voor NumberNotInRange:

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

Gebruik voor StringBeginsWith:

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

Gebruik voor StringContains:

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

Gebruik voor StringEndsWith:

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

Gebruik voor StringIn:

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

Gebruik voor StringNotBeginsWith:

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

Gebruik voor StringNotContains:

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

Gebruik voor StringNotEndsWith:

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

Gebruik voor StringNotIn:

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

EventSubscriptionDestination-objecten

Stel de eigenschap endpointType in om het type object op te geven.

Gebruik voor AzureFunction:

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

Gebruik voor EventHub-:

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

Gebruik voor HybridConnection:

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

Gebruik voor MonitorAlert-:

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

Gebruik voor NamespaceTopic-:

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

Gebruik voor PartnerDestination:

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

Gebruik voor ServiceBusQueue:

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

Gebruik voor ServiceBusTopic-:

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

Gebruik voor StorageQueue:

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

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

Eigenschapswaarden

AdvancedFilter

Naam	Beschrijving	Waarde
sleutel	Het veld/de eigenschap in de gebeurtenis op basis waarvan u wilt filteren.	snaar
operatorType	Ingesteld op 'BoolEquals' voor het type BoolEqualsAdvancedFilter. Ingesteld op 'IsNotNull' voor het type IsNotNullAdvancedFilter. Ingesteld op 'IsNullOrUndefined' voor het type IsNullOrUndefinedAdvancedFilter. Ingesteld op NumberGreaterThan voor het type NumberGreaterThanAdvancedFilter. Ingesteld op NumberGreaterThanOrEquals voor het type NumberGreaterThanOrEqualsAdvancedFilter. Ingesteld op NumberIn voor het type NumberInAdvancedFilter. Ingesteld op NumberInRange voor het type NumberInRangeAdvancedFilter. Ingesteld op NumberLessThan voor het type NumberLessThanAdvancedFilter. Ingesteld op NumberLessThanOrEquals voor het type NumberLessThanOrEqualsAdvancedFilter. Ingesteld op NumberNotIn voor het type NumberNotInAdvancedFilter. Ingesteld op NumberNotInRange voor het type NumberNotInRangeAdvancedFilter. Ingesteld op 'StringBeginsWith' voor het type StringBeginsWithAdvancedFilter. Ingesteld op 'StringContains' voor het type StringContainsAdvancedFilter. Ingesteld op 'StringEndsWith' voor het type StringEndsWithAdvancedFilter. Ingesteld op 'StringIn' voor het type StringInAdvancedFilter. Ingesteld op 'StringNotBeginsWith' voor het type StringNotBeginsWithAdvancedFilter. Ingesteld op 'StringNotContains' voor het type StringNotContainsAdvancedFilter. Ingesteld op 'StringNotEndsWith' voor het type StringNotEndsWithAdvancedFilter. Ingesteld op 'StringNotIn' voor het type StringNotInAdvancedFilter.	'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' NumberInRange 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (vereist)

AzureFunctionEventSubscriptionDestination

Naam	Beschrijving	Waarde
endpointType	Type van het eindpunt voor het doel van het gebeurtenisabonnement.	'AzureFunction' (vereist)
Eigenschappen	Eigenschappen van De Azure-functie van de bestemming van het gebeurtenisabonnement.	AzureFunctionEventSubscriptionDestinationProperties-

AzureFunctionEventSubscriptionDestinationProperties

Naam	Beschrijving	Waarde
deliveryAttributeMappings	Details van het leveringskenmerk.	DeliveryAttributeMapping[]
maxEventsPerBatch	Maximum aantal gebeurtenissen per batch.	Int
preferredBatchSizeInKilobytes	Voorkeursbatchgrootte in Kilobytes.	Int
resourceId	De Azure-resource-id die het eindpunt van de Azure Function-bestemming van een gebeurtenisabonnement vertegenwoordigt.	snaar

BoolEqualsAdvancedFilter

Naam	Beschrijving	Waarde
operatorType	Het operatortype dat wordt gebruikt voor filteren, bijvoorbeeld NumberIn, StringContains, BoolEquals en andere.	'BoolEquals' (vereist)
waarde	De booleaanse filterwaarde.	Bool

DeadLetterDestination

Naam	Beschrijving	Waarde
endpointType	Ingesteld op 'StorageBlob' voor het type StorageBlobDeadLetterDestination.	'StorageBlob' (vereist)

DeadLetterWithResourceIdentity

Naam	Beschrijving	Waarde
deadLetterDestination	Informatie over de bestemming waar gebeurtenissen moeten worden afgeleverd voor het gebeurtenisabonnement. Maakt gebruik van de installatie van de beheerde identiteit op de bovenliggende resource (namelijk onderwerp of domein) om de verificatietokens te verkrijgen die worden gebruikt tijdens het schrijven van lege letters.	DeadLetterDestination
identiteit	De identiteit die moet worden gebruikt bij gebeurtenissen met dode letters.	EventSubscriptionIdentity-

DeliveryAttributeMapping

Naam	Beschrijving	Waarde
naam	Naam van het leveringskenmerk of de koptekst.	snaar
type	Ingesteld op Dynamisch voor het type DynamicDeliveryAttributeMapping. Ingesteld op 'Statisch' voor het type StaticDeliveryAttributeMapping.	'Dynamisch' 'Statisch' (vereist)

DeliveryWithResourceIdentity

Naam	Beschrijving	Waarde
bestemming	Informatie over de bestemming waar gebeurtenissen moeten worden afgeleverd voor het gebeurtenisabonnement. Maakt gebruik van de installatie van de beheerde identiteit op de bovenliggende resource (namelijk onderwerp of domein) om de verificatietokens te verkrijgen die tijdens de levering worden gebruikt.	EventSubscriptionDestination-
identiteit	De identiteit die moet worden gebruikt bij het leveren van gebeurtenissen.	EventSubscriptionIdentity-

DynamicDeliveryAttributeMapping

Naam	Beschrijving	Waarde
Eigenschappen	Eigenschappen van de toewijzing van dynamische leveringskenmerken.	DynamicDeliveryAttributeMappingProperties-
type	Type van het leveringskenmerk of de naam van de header.	Dynamisch (vereist)

DynamicDeliveryAttributeMappingProperties

Naam	Beschrijving	Waarde
sourceField	JSON-pad in de gebeurtenis die kenmerkwaarde bevat.	snaar

EventHubEventSubscriptionDestination

Naam	Beschrijving	Waarde
endpointType	Type van het eindpunt voor het doel van het gebeurtenisabonnement.	EventHub (vereist)
Eigenschappen	Event Hub-eigenschappen van de bestemming van het gebeurtenisabonnement.	EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Naam	Beschrijving	Waarde
deliveryAttributeMappings	Details van het leveringskenmerk.	DeliveryAttributeMapping[]
resourceId	De Azure-resource-id die het eindpunt van een Event Hub-bestemming van een gebeurtenisabonnement vertegenwoordigt.	snaar

EventSubscriptionDestination

Naam	Beschrijving	Waarde
endpointType	Ingesteld op 'AzureFunction' voor het type AzureFunctionEventSubscriptionDestination. Ingesteld op 'EventHub' voor het type EventHubEventSubscriptionDestination. Ingesteld op HybridConnection voor het type HybridConnectionEventSubscriptionDestination. Ingesteld op 'MonitorAlert' voor het type MonitorAlertEventSubscriptionDestination. Ingesteld op 'NamespaceTopic' voor het type NamespaceTopicEventSubscriptionDestination. Ingesteld op PartnerDestination voor het type PartnerEventSubscriptionDestination. Ingesteld op 'ServiceBusQueue' voor het type ServiceBusQueueEventSubscriptionDestination. Ingesteld op ServiceBusTopic voor het type ServiceBusTopicEventSubscriptionDestination. Ingesteld op StorageQueue voor het type StorageQueueEventSubscriptionDestination. Ingesteld op 'WebHook' voor het type WebHookEventSubscriptionDestination.	'AzureFunction' 'EventHub' 'HybridConnection' 'MonitorAlert' 'NamespaceTopic' 'PartnerDestination' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' (vereist)

EventSubscriptionFilter

Naam	Beschrijving	Waarde
advancedFilters	Een matrix met geavanceerde filters die worden gebruikt voor het filteren van gebeurtenisabonnementen.	AdvancedFilter[]
enableAdvancedFilteringOnArrays	Hiermee kunnen geavanceerde filters worden geëvalueerd op basis van een matrix met waarden in plaats van een enkelvoudige waarde te verwachten.	Bool
includedEventTypes	Een lijst met toepasselijke gebeurtenistypen die deel moeten uitmaken van het gebeurtenisabonnement. Als u zich wilt abonneren op alle standaardgebeurtenistypen, stelt u de IncludedEventTypes in op null.	tekenreeks[]
isSubjectCaseSensitive	Hiermee geeft u op of de eigenschappen SubjectBeginsWith en SubjectEndsWith van het filter moet op een hoofdlettergevoelige manier worden vergeleken.	Bool
subjectBeginsWith	Een optionele tekenreeks voor het filteren van gebeurtenissen voor een gebeurtenisabonnement op basis van een resourcepadvoorvoegsel. De indeling hiervan is afhankelijk van de uitgever van de gebeurtenissen. Jokertekens worden niet ondersteund in dit pad.	snaar
subjectEndsWith	Een optionele tekenreeks voor het filteren van gebeurtenissen voor een gebeurtenisabonnement op basis van een achtervoegsel voor een resourcepad. Jokertekens worden niet ondersteund in dit pad.	snaar

EventSubscriptionIdentity

Naam	Beschrijving	Waarde
federatedIdentityCredentialInfo	De details van de federatieve identiteitsreferenties (FIC) die worden gebruikt bij de levering van resources.	FederatedIdentityCredentialInfo
type	Het type beheerde identiteit dat wordt gebruikt. Kan 'SystemAssigned' of 'UserAssigned' zijn.	'SystemAssigned' UserAssigned
userAssignedIdentity	De gebruikersidentiteit die is gekoppeld aan de resource.	snaar

EventSubscriptionProperties

Naam	Beschrijving	Waarde
deadLetterDestination	De bestemming van de dode letter van het gebeurtenisabonnement. Elke gebeurtenis die niet naar zijn bestemming kan worden geleverd, wordt verzonden naar de bestemming van de dode brief. Maakt gebruik van de identiteit van Azure Event Grid om de verificatietokens te verkrijgen die worden gebruikt tijdens levering/dode brieven.	DeadLetterDestination
deadLetterWithResourceIdentity	De bestemming van de dode letter van het gebeurtenisabonnement. Elke gebeurtenis die niet naar zijn bestemming kan worden geleverd, wordt verzonden naar de bestemming van de dode brief. Maakt gebruik van de installatie van de beheerde identiteit op de bovenliggende resource (namelijk onderwerp of domein) om de verificatietokens te verkrijgen die worden gebruikt tijdens het afleveren/onbestelbare brieven.	DeadLetterWithResourceIdentity-
deliveryWithResourceIdentity	Informatie over de bestemming waar gebeurtenissen moeten worden afgeleverd voor het gebeurtenisabonnement. Maakt gebruik van de installatie van de beheerde identiteit op de bovenliggende resource (namelijk onderwerp of domein) om de verificatietokens te verkrijgen die worden gebruikt tijdens het afleveren/onbestelbare brieven.	DeliveryWithResourceIdentity-
bestemming	Informatie over de bestemming waar gebeurtenissen moeten worden afgeleverd voor het gebeurtenisabonnement. Maakt gebruik van de identiteit van Azure Event Grid om de verificatietokens te verkrijgen die worden gebruikt tijdens levering/dode brieven.	EventSubscriptionDestination-
eventDeliverySchema	Het gebeurtenisleveringsschema voor het gebeurtenisabonnement.	'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema'
expirationTimeUtc	Verlooptijd van het gebeurtenisabonnement.	snaar
filter	Informatie over het filter voor het gebeurtenisabonnement.	EventSubscriptionFilter
labels	Lijst met door de gebruiker gedefinieerde labels.	tekenreeks[]
retryPolicy	Het beleid voor opnieuw proberen voor gebeurtenissen. Dit kan worden gebruikt om het maximum aantal leveringspogingen en time to live te configureren voor gebeurtenissen.	RetryPolicy-

FederatedIdentityCredentialInfo

Naam	Beschrijving	Waarde
federatedClientId	De AAD-toepassing met meerdere tenants waaraan fic (Federated Identity Credential) is gekoppeld.	snaar Beperkingen: Minimale lengte = 36 Maximale lengte = 36 Patroon = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (vereist)

HybridConnectionEventSubscriptionDestination

Naam	Beschrijving	Waarde
endpointType	Type van het eindpunt voor het doel van het gebeurtenisabonnement.	HybridConnection (vereist)
Eigenschappen	Eigenschappen van hybride verbindingen van de bestemming van het gebeurtenisabonnement.	HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Naam	Beschrijving	Waarde
deliveryAttributeMappings	Details van het leveringskenmerk.	DeliveryAttributeMapping[]
resourceId	De Azure-resource-id van een hybride verbinding die het doel is van een gebeurtenisabonnement.	snaar

IsNotNullAdvancedFilter

Naam	Beschrijving	Waarde
operatorType	Het operatortype dat wordt gebruikt voor filteren, bijvoorbeeld NumberIn, StringContains, BoolEquals en andere.	'IsNotNull' (vereist)

IsNullOrUndefinedAdvancedFilter

Naam	Beschrijving	Waarde
operatorType	Het operatortype dat wordt gebruikt voor filteren, bijvoorbeeld NumberIn, StringContains, BoolEquals en andere.	'IsNullOrUndefined' (vereist)