Microsoft.EventGrid eventSubscriptions 2022-06-15

Artykuł
12/16/2024

Definicja zasobu Bicep

Typ zasobu eventSubscriptions można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.EventGrid/eventSubscriptions, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2022-06-15' = {
  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: {
        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
    }
  }
}

EventSubscriptionDestination obiektów

Ustaw właściwość endpointType, aby określić typ obiektu.

W przypadku azureFunctionużyj:

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

W przypadku usługi EventHubużyj:

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

W przypadku HybridConnectionużyj:

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

W przypadku ServiceBusQueueużyj:

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

W przypadku ServiceBusTopicużyj:

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

W przypadkuStorageQueue użyj:

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

W przypadkuwebhook użyj:

{
  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl: 'string'
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
  }
}

Obiekty DeadLetterDestination

Ustaw właściwość endpointType, aby określić typ obiektu.

W przypadku StorageBlobużyj:

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

Obiekty AdvancedFilter

Ustaw właściwość operatorType, aby określić typ obiektu.

W przypadku boolEqualsużyj:

{
  operatorType: 'BoolEquals'
  value: bool
}

W przypadku IsNotNullużyj:

{
  operatorType: 'IsNotNull'
}

W przypadku IsNullOrUndefinedużyj:

{
  operatorType: 'IsNullOrUndefined'
}

W przypadku NumberGreaterThanużyj:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

W przypadku NumberGreaterThanOrEqualsużyj:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

W przypadku NumberInużyj:

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

W przypadku NumberInRangeużyj:

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

W przypadku NumberLessThanużyj:

{
  operatorType: 'NumberLessThan'
  value: int
}

W przypadku NumberLessThanOrEqualsużyj:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

W przypadku NumberNotInużyj:

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

W przypadku NumberNotInRangeużyj:

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

W przypadku StringBeginsWithużyj:

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

W przypadku StringContainsużyj:

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

W przypadku StringEndsWithużyj:

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

W przypadku StringInużyj:

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

W przypadku StringNotBeginsWithużyj polecenia:

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

W przypadku StringNotContainsużyj:

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

W przypadku StringNotEndsWithużyj:

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

W przypadku StringNotInużyj:

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

DeliveryAttributeMapping , obiekty

Ustaw właściwość , aby określić typ obiektu.

W przypadku dynamicznejużyj:

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

W przypadku staticużyj:

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

Wartości właściwości

Filtr zaawansowany

Nazwa	Opis	Wartość
klucz	Pole/właściwość w zdarzeniu, na podstawie którego chcesz filtrować.	struna
operatorType	Ustaw wartość "BoolEquals" dla typu BoolEqualsAdvancedFilter. Ustaw wartość "IsNotNull" dla typu IsNotNullAdvancedFilter. Ustaw wartość "IsNullOrUndefined" dla typu IsNullOrUndefinedAdvancedFilter. Ustaw wartość "NumberGreaterThan" dla typu NumberGreaterThanAdvancedFilter. Ustaw wartość "NumberGreaterThanOrEquals" dla typu NumberGreaterThanOrEqualsAdvancedFilter. Ustaw wartość "NumberIn" dla typu NumberInAdvancedFilter. Ustaw wartość "NumberInRange" dla typu NumberInRangeAdvancedFilter. Ustaw wartość "NumberLessThan" dla typu NumberLessThanAdvancedFilter. Ustaw wartość "NumberLessThanOrEquals" dla typu NumberLessThanOrEqualsAdvancedFilter. Ustaw wartość "NumberNotIn" dla typu NumberNotInAdvancedFilter. Ustaw wartość "NumberNotInRange" dla typu NumberNotInRangeAdvancedFilter. Ustaw wartość "StringBeginsWith" dla typu StringBeginsWithAdvancedFilter. Ustaw wartość "StringContains" dla typu StringContainsAdvancedFilter. Ustaw wartość "StringEndsWith" dla typu StringEndsWithAdvancedFilter. Ustaw wartość "StringIn" dla typu StringInAdvancedFilter. Ustaw wartość "StringNotBeginsWith" dla typu StringNotBeginsWithAdvancedFilter. Ustaw wartość "StringNotContains" dla typu StringNotContainsAdvancedFilter. Ustaw wartość "StringNotEndsWith" dla typu StringNotEndsWithAdvancedFilter. Ustaw wartość "StringNotIn" dla typu StringNotInAdvancedFilter.	"BoolEquals" "IsNotNull" "IsNullOrUndefined" "NumberGreaterThan" "NumberGreaterThanOrEquals" "NumberIn" "NumberInRange" "NumberLessThan" "NumberLessThanOrEquals" "NumberNotIn" "NumberNotInRange" "StringBeginsWith" "CiągContains" "StringEndsWith" "StringIn" "StringNotBeginsWith" "StringNotContains" "StringNotEndsWith" "StringNotIn" (wymagane)

AzureFunctionEventSubscriptionDestination

Nazwa	Opis	Wartość
endpointType	Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń.	"AzureFunction" (wymagane)
Właściwości	Właściwości funkcji platformy Azure miejsca docelowego subskrypcji zdarzeń.	AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Nazwa	Opis	Wartość
deliveryAttributeMappings	Szczegóły atrybutu dostarczania.	DeliveryAttributeMapping[]
maxEventsPerBatch	Maksymalna liczba zdarzeń na partię.	Int
preferredBatchSizeInKilobytes	Preferowany rozmiar partii w kilobajtach.	Int
resourceId	Identyfikator zasobu platformy Azure reprezentujący punkt końcowy docelowej funkcji platformy Azure subskrypcji zdarzeń.	struna

BoolEqualsAdvancedFilter

Nazwa	Opis	Wartość
operatorType	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.	"BoolEquals" (wymagane)
wartość	Wartość filtru logicznego.	Bool

DeadLetterDestination

Nazwa	Opis	Wartość
endpointType	Ustaw wartość "StorageBlob" dla typu StorageBlobDeadLetterDestination.	"StorageBlob" (wymagane)

DeadLetterWithResourceIdentity

Nazwa	Opis	Wartość
deadLetterDestination	Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. Używa konfiguracji tożsamości zarządzanej w zasobie nadrzędnym (tj. temacie lub domenie), aby uzyskać tokeny uwierzytelniania używane podczas dostarczania/zakleszczenia.	DeadLetterDestination
tożsamość	Tożsamość, która ma być używana w przypadku zdarzeń utraconych.	EventSubscriptionIdentity

DeliveryAttributeMapping

Nazwa	Opis	Wartość
nazwa	Nazwa atrybutu dostarczania lub nagłówka.	struna
typ	Ustaw wartość "Dynamic" dla typu DynamicDeliveryAttributeMapping. Ustaw wartość "Static" dla typu StaticDeliveryAttributeMapping.	"Dynamiczny" "Static" (wymagane)

DeliveryWithResourceIdentity

Nazwa	Opis	Wartość
cel	Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. Używa tożsamości usługi Azure Event Grid do uzyskiwania tokenów uwierzytelniania używanych podczas dostarczania/zakleszczenia.	EventSubscriptionDestination
tożsamość	Tożsamość do użycia podczas dostarczania zdarzeń.	EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Nazwa	Opis	Wartość
Właściwości	Właściwości dynamicznego mapowania atrybutów dostarczania.	DynamicDeliveryAttributeMappingProperties
typ	Typ atrybutu dostarczania lub nazwy nagłówka.	"Dynamiczny" (wymagany)

DynamicDeliveryAttributeMappingProperties

Nazwa	Opis	Wartość
sourceField	Ścieżka JSON w zdarzeniu, które zawiera wartość atrybutu.	struna

EventHubEventSubscriptionDestination

Nazwa	Opis	Wartość
endpointType	Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń.	"EventHub" (wymagane)
Właściwości	Właściwości centrum zdarzeń miejsca docelowego subskrypcji zdarzeń.	EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Nazwa	Opis	Wartość
deliveryAttributeMappings	Szczegóły atrybutu dostarczania.	DeliveryAttributeMapping[]
resourceId	Identyfikator zasobu platformy Azure reprezentujący punkt końcowy miejsca docelowego centrum zdarzeń subskrypcji zdarzeń.	struna

EventSubscriptionDestination

Nazwa	Opis	Wartość
endpointType	Ustaw wartość "AzureFunction" dla typu AzureFunctionEventSubscriptionDestination. Ustaw wartość "EventHub" dla typu EventHubEventSubscriptionDestination. Ustaw wartość "HybridConnection" dla typu HybridConnectionEventSubscriptionDestination. Ustaw wartość "ServiceBusQueue" dla typu ServiceBusQueueEventSubscriptionDestination. Ustaw wartość "ServiceBusTopic" dla typu ServiceBusTopicEventSubscriptionDestination. Ustaw wartość "StorageQueue" dla typu StorageQueueEventSubscriptionDestination. Ustaw wartość "WebHook" dla typu WebHookEventSubscriptionDestination.	"AzureFunction" "EventHub" "Połączenie hybrydowe" "ServiceBusQueue" "ServiceBusTopic" "StorageQueue" "Element webhook" (wymagany)

EventSubscriptionFilter

Nazwa	Opis	Wartość
advancedFilters	Tablica zaawansowanych filtrów używanych do filtrowania subskrypcji zdarzeń.	AdvancedFilter[]
enableAdvancedFilteringOnArrays	Umożliwia ocenianie filtrów zaawansowanych względem tablicy wartości zamiast oczekiwać pojedynczej wartości.	Bool
includedEventTypes	Lista odpowiednich typów zdarzeń, które muszą być częścią subskrypcji zdarzeń. Jeśli chcesz zasubskrybować wszystkie domyślne typy zdarzeń, ustaw parametr IncludedEventTypes na wartość null.	string[]
isSubjectCaseSensitive	Określa, czy właściwości SubjectBeginsWith i SubjectEndsWith filtru należy porównać w sposób uwzględniający wielkość liter.	Bool
subjectBeginsWith	Opcjonalny ciąg filtrowania zdarzeń dla subskrypcji zdarzeń na podstawie prefiksu ścieżki zasobu. Format tego ustawienia zależy od wydawcy zdarzeń. Symbole wieloznaczne nie są obsługiwane w tej ścieżce.	struna
subjectEndsWith	Opcjonalny ciąg do filtrowania zdarzeń dla subskrypcji zdarzeń na podstawie sufiksu ścieżki zasobu. Symbole wieloznaczne nie są obsługiwane w tej ścieżce.	struna

EventSubscriptionIdentity

Nazwa	Opis	Wartość
typ	Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" usunie dowolną tożsamość.	"SystemAssigned" "UserAssigned"
userAssignedIdentity	Tożsamość użytkownika skojarzona z zasobem.	struna

EventSubscriptionProperties

Nazwa	Opis	Wartość
deadLetterDestination	Miejsce docelowe utraconych wiadomości subskrypcji zdarzeń. Każde zdarzenie, którego nie można dostarczyć do miejsca docelowego, jest wysyłane do miejsca docelowego utraconych wiadomości. Używa tożsamości usługi Azure Event Grid do uzyskiwania tokenów uwierzytelniania używanych podczas dostarczania/zakleszczenia.	DeadLetterDestination
deadLetterWithResourceIdentity	Miejsce docelowe utraconych wiadomości subskrypcji zdarzeń. Każde zdarzenie, którego nie można dostarczyć do miejsca docelowego, jest wysyłane do miejsca docelowego utraconych wiadomości. Używa konfiguracji tożsamości zarządzanej w zasobie nadrzędnym (tj. temacie lub domenie), aby uzyskać tokeny uwierzytelniania używane podczas dostarczania/zakleszczenia.	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. Używa konfiguracji tożsamości zarządzanej w zasobie nadrzędnym (tj. temacie lub domenie), aby uzyskać tokeny uwierzytelniania używane podczas dostarczania/zakleszczenia.	DeliveryWithResourceIdentity
cel	Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. Używa tożsamości usługi Azure Event Grid do uzyskiwania tokenów uwierzytelniania używanych podczas dostarczania/zakleszczenia.	EventSubscriptionDestination
eventDeliverySchema	Schemat dostarczania zdarzeń dla subskrypcji zdarzeń.	"CloudEventSchemaV1_0" "CustomInputSchema" "EventGridSchema"
expirationTimeUtc	Czas wygaśnięcia subskrypcji zdarzeń.	struna
filtr	Informacje o filtrze subskrypcji zdarzeń.	EventSubscriptionFilter
Etykiety	Lista etykiet zdefiniowanych przez użytkownika.	string[]
retryPolicy	Zasady ponawiania dla zdarzeń. Może to służyć do konfigurowania maksymalnej liczby prób dostarczenia i czasu wygaśnięcia dla zdarzeń.	RetryPolicy

HybridConnectionEventSubscriptionDestination

Nazwa	Opis	Wartość
endpointType	Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń.	"HybridConnection" (wymagane)
Właściwości	Właściwości połączenia hybrydowego miejsca docelowego subskrypcji zdarzeń.	HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Nazwa	Opis	Wartość
deliveryAttributeMappings	Szczegóły atrybutu dostarczania.	DeliveryAttributeMapping[]
resourceId	Identyfikator zasobu platformy Azure połączenia hybrydowego, który jest miejscem docelowym subskrypcji zdarzeń.	struna

IsNotNullAdvancedFilter

Nazwa	Opis	Wartość
operatorType	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.	"IsNotNull" (wymagane)

IsNullOrUndefinedAdvancedFilter

Nazwa	Opis	Wartość
operatorType	Typ operatora używany do filtrowania, np. NumberIn, StringContains, BoolEquals i inne.	"IsNullOrUndefined" (wymagane)