Dela via


Microsoft.EventGrid eventSubscriptions 2018-05-01-preview

Bicep-resursdefinition

Resurstypen eventSubscriptions kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.EventGrid/eventSubscriptions-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2018-05-01-preview' = {
  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'
    filter: {
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
    retryPolicy: {
      eventTimeToLiveInMinutes: int
      maxDeliveryAttempts: int
    }
  }
}

DeadLetterDestination-objekt

Ange egenskapen endpointType för att ange typ av objekt.

För StorageBlobanvänder du:

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

EventSubscriptionDestination-objekt

Ange egenskapen endpointType för att ange typ av objekt.

För EventHubanvänder du:

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

För HybridConnectionanvänder du:

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

För StorageQueueanvänder du:

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

För WebHookanvänder du:

{
  endpointType: 'WebHook'
  properties: {
    endpointUrl: 'string'
  }
}

Egenskapsvärden

DeadLetterDestination

Namn Beskrivning Värde
endpointType Ange till "StorageBlob" för typen StorageBlobDeadLetterDestination. "StorageBlob" (krävs)

EventHubEventSubscriptionDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för händelseprenumerationsmålet "EventHub" (krävs)
Egenskaper Event Hub-egenskaper för händelseprenumerationsmålet EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Namn Beskrivning Värde
resourceId Det Azure-resurs-ID som representerar slutpunkten för ett Event Hub-mål för en händelseprenumeration. sträng

EventSubscriptionDestination

Namn Beskrivning Värde
endpointType Ange till EventHub för typen EventHubEventSubscriptionDestination. Ange till "HybridConnection" för typen HybridConnectionEventSubscriptionDestination. Ange till "StorageQueue" för typen StorageQueueEventSubscriptionDestination. Ange till WebHook för typen WebHookEventSubscriptionDestination. "EventHub"
"HybridConnection"
"StorageQueue"
"WebHook" (krävs)

EventSubscriptionFilter

Namn Beskrivning Värde
includedEventTypes En lista över tillämpliga händelsetyper som måste ingå i händelseprenumerationen.
Om du vill prenumerera på alla händelsetyper måste strängen "alla" anges som ett element i den här listan.
string[]
isSubjectCaseSensitive Anger om egenskaperna SubjectBeginsWith och SubjectEndsWith för filtret
bör jämföras på ett skiftlägeskänsligt sätt.
Bool
subjectBeginsWith En valfri sträng för att filtrera händelser för en händelseprenumeration baserat på ett resurssökvägsprefix.
Formatet för detta beror på utgivaren av händelserna.
Jokertecken stöds inte i den här sökvägen.
sträng
subjectEndsWith En valfri sträng för att filtrera händelser för en händelseprenumeration baserat på ett suffix för resurssökväg.
Jokertecken stöds inte i den här sökvägen.
sträng

EventSubscriptionProperties

Namn Beskrivning Värde
deadLetterDestination DeadLetter-målet för händelseprenumerationen. DeadLetterDestination
destination Information om målet där händelser måste levereras för händelseprenumerationen. EventSubscriptionDestination
eventDeliverySchema Händelseleveransschemat för händelseprenumerationen. "CloudEventV01Schema"
"EventGridSchema"
"InputEventSchema"
filter Information om filtret för händelseprenumerationen. EventSubscriptionFilter
Etiketter Lista över användardefinierade etiketter. string[]
retryPolicy Återförsöksprincipen för händelser. Detta kan användas för att konfigurera maximalt antal leveransförsök och tid att leva för händelser. RetryPolicy

HybridConnectionEventSubscriptionDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för händelseprenumerationsmålet "HybridConnection" (krävs)
Egenskaper Hybridanslutningsegenskaper för händelseprenumerationsmålet HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Namn Beskrivning Värde
resourceId Azure-resurs-ID för en hybridanslutning som är målet för en händelseprenumeration. sträng

Microsoft.EventGrid/eventSubscriptions

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för händelseprenumerationen EventSubscriptionProperties
omfattning Använd när du skapar en resurs i ett annat omfång än distributionsomfånget. Ange den här egenskapen till det symboliska namnet på en resurs för att tillämpa -tilläggsresursen.

RetryPolicy

Namn Beskrivning Värde
eventTimeToLiveInMinutes Time To Live (i minuter) för händelser. Int
maxDeliveryAttempts Maximalt antal återförsök av leveransförsök för händelser. Int

StorageBlobDeadLetterDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för mål med obeställbara bokstäver "StorageBlob" (krävs)
Egenskaper Egenskaperna för det Lagringsblobbaserade deadletter-målet StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Namn Beskrivning Värde
blobContainerName Namnet på lagringsblobcontainern som är målet för deadletter-händelserna sträng
resourceId Azure-resurs-ID:t för lagringskontot som är målet för deadletter-händelserna sträng

StorageQueueEventSubscriptionDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för händelseprenumerationsmålet "StorageQueue" (krävs)
Egenskaper Lagringsköegenskaper för händelseprenumerationsmålet StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Namn Beskrivning Värde
queueName Namnet på lagringskö under ett lagringskonto som är målet för en händelseprenumeration. sträng
resourceId Azure-resurs-ID för lagringskontot som innehåller kön som är målet för en händelseprenumeration. sträng

WebHookEventSubscriptionDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för händelseprenumerationsmålet "WebHook" (krävs)
Egenskaper WebHook-egenskaper för händelseprenumerationsmålet WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Namn Beskrivning Värde
endpointUrl DEN URL som representerar slutpunkten för målet för en händelseprenumeration. sträng

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil Beskrivning
Skapa anpassad Azure Event Grid-ämne och köprenumeration Skapar ett anpassat Azure Event Grid-ämne och en service bus-köprenumeration. Mall ursprungligen författad av Markus Meyer.
Skapa anpassat ämne och prenumerationsavsnitt för Azure Event Grid Skapar ett anpassat Azure Event Grid-ämne och en webhook-prenumeration. Mall som ursprungligen skapades av John Downs.

Resursdefinition för ARM-mall

Resurstypen eventSubscriptions kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.EventGrid/eventSubscriptions-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2018-05-01-preview",
  "name": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "eventDeliverySchema": "string",
    "filter": {
      "includedEventTypes": [ "string" ],
      "isSubjectCaseSensitive": "bool",
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string"
    },
    "labels": [ "string" ],
    "retryPolicy": {
      "eventTimeToLiveInMinutes": "int",
      "maxDeliveryAttempts": "int"
    }
  }
}

DeadLetterDestination-objekt

Ange egenskapen endpointType för att ange typ av objekt.

För StorageBlobanvänder du:

{
  "endpointType": "StorageBlob",
  "properties": {
    "blobContainerName": "string",
    "resourceId": "string"
  }
}

EventSubscriptionDestination-objekt

Ange egenskapen endpointType för att ange typ av objekt.

För EventHubanvänder du:

{
  "endpointType": "EventHub",
  "properties": {
    "resourceId": "string"
  }
}

För HybridConnectionanvänder du:

{
  "endpointType": "HybridConnection",
  "properties": {
    "resourceId": "string"
  }
}

För StorageQueueanvänder du:

{
  "endpointType": "StorageQueue",
  "properties": {
    "queueName": "string",
    "resourceId": "string"
  }
}

För WebHookanvänder du:

{
  "endpointType": "WebHook",
  "properties": {
    "endpointUrl": "string"
  }
}

Egenskapsvärden

DeadLetterDestination

Namn Beskrivning Värde
endpointType Ange till "StorageBlob" för typen StorageBlobDeadLetterDestination. "StorageBlob" (krävs)

EventHubEventSubscriptionDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för händelseprenumerationsmålet "EventHub" (krävs)
Egenskaper Event Hub-egenskaper för händelseprenumerationsmålet EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Namn Beskrivning Värde
resourceId Det Azure-resurs-ID som representerar slutpunkten för ett Event Hub-mål för en händelseprenumeration. sträng

EventSubscriptionDestination

Namn Beskrivning Värde
endpointType Ange till EventHub för typen EventHubEventSubscriptionDestination. Ange till "HybridConnection" för typen HybridConnectionEventSubscriptionDestination. Ange till "StorageQueue" för typen StorageQueueEventSubscriptionDestination. Ange till WebHook för typen WebHookEventSubscriptionDestination. "EventHub"
"HybridConnection"
"StorageQueue"
"WebHook" (krävs)

EventSubscriptionFilter

Namn Beskrivning Värde
includedEventTypes En lista över tillämpliga händelsetyper som måste ingå i händelseprenumerationen.
Om du vill prenumerera på alla händelsetyper måste strängen "alla" anges som ett element i den här listan.
string[]
isSubjectCaseSensitive Anger om egenskaperna SubjectBeginsWith och SubjectEndsWith för filtret
bör jämföras på ett skiftlägeskänsligt sätt.
Bool
subjectBeginsWith En valfri sträng för att filtrera händelser för en händelseprenumeration baserat på ett resurssökvägsprefix.
Formatet för detta beror på utgivaren av händelserna.
Jokertecken stöds inte i den här sökvägen.
sträng
subjectEndsWith En valfri sträng för att filtrera händelser för en händelseprenumeration baserat på ett suffix för resurssökväg.
Jokertecken stöds inte i den här sökvägen.
sträng

EventSubscriptionProperties

Namn Beskrivning Värde
deadLetterDestination DeadLetter-målet för händelseprenumerationen. DeadLetterDestination
destination Information om målet där händelser måste levereras för händelseprenumerationen. EventSubscriptionDestination
eventDeliverySchema Händelseleveransschemat för händelseprenumerationen. "CloudEventV01Schema"
"EventGridSchema"
"InputEventSchema"
filter Information om filtret för händelseprenumerationen. EventSubscriptionFilter
Etiketter Lista över användardefinierade etiketter. string[]
retryPolicy Återförsöksprincipen för händelser. Detta kan användas för att konfigurera maximalt antal leveransförsök och tid att leva för händelser. RetryPolicy

HybridConnectionEventSubscriptionDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för händelseprenumerationsmålet "HybridConnection" (krävs)
Egenskaper Hybridanslutningsegenskaper för händelseprenumerationsmålet HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Namn Beskrivning Värde
resourceId Azure-resurs-ID för en hybridanslutning som är målet för en händelseprenumeration. sträng

Microsoft.EventGrid/eventSubscriptions

Namn Beskrivning Värde
apiVersion API-versionen "2018-05-01-preview"
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för händelseprenumerationen EventSubscriptionProperties
typ Resurstypen "Microsoft.EventGrid/eventSubscriptions"

RetryPolicy

Namn Beskrivning Värde
eventTimeToLiveInMinutes Time To Live (i minuter) för händelser. Int
maxDeliveryAttempts Maximalt antal återförsök av leveransförsök för händelser. Int

StorageBlobDeadLetterDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för mål med obeställbara bokstäver "StorageBlob" (krävs)
Egenskaper Egenskaperna för det Lagringsblobbaserade deadletter-målet StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Namn Beskrivning Värde
blobContainerName Namnet på lagringsblobcontainern som är målet för deadletter-händelserna sträng
resourceId Azure-resurs-ID:t för lagringskontot som är målet för deadletter-händelserna sträng

StorageQueueEventSubscriptionDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för händelseprenumerationsmålet "StorageQueue" (krävs)
Egenskaper Lagringsköegenskaper för händelseprenumerationsmålet StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Namn Beskrivning Värde
queueName Namnet på lagringskö under ett lagringskonto som är målet för en händelseprenumeration. sträng
resourceId Azure-resurs-ID för lagringskontot som innehåller kön som är målet för en händelseprenumeration. sträng

WebHookEventSubscriptionDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för händelseprenumerationsmålet "WebHook" (krävs)
Egenskaper WebHook-egenskaper för händelseprenumerationsmålet WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Namn Beskrivning Värde
endpointUrl DEN URL som representerar slutpunkten för målet för en händelseprenumeration. sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
Skapa anpassad Azure Event Grid-ämne och köprenumeration

Distribuera till Azure
Skapar ett anpassat Azure Event Grid-ämne och en service bus-köprenumeration. Mall ursprungligen författad av Markus Meyer.
Skapa anpassat ämne och prenumerationsavsnitt för Azure Event Grid

Distribuera till Azure
Skapar ett anpassat Azure Event Grid-ämne och en webhook-prenumeration. Mall som ursprungligen skapades av John Downs.
Skapa en anpassad prenumeration på Azure Event Grid

Distribuera till Azure
Skapar ett anpassat Azure Event Grid-ämne och en service bus-ämnesprenumeration. Mall ursprungligen författad av Markus Meyer.
Skapa anpassat Event Grid-ämne och händelsehubbhanterare

Distribuera till Azure
Skapar ett anpassat Azure Event Grid-ämne och en händelsehubb för att hantera händelserna.
Skapa Event Grid-prenumeration för resurshändelser

Distribuera till Azure
Skapar En Event Grid-prenumeration till antingen resursgrupp eller Azure-prenumeration.
Anpassat Azure Event Grid-ämne/prenumeration med CloudEvents

Distribuera till Azure
Skapar ett anpassat Azure Event Grid-ämne, en webhook-prenumeration med CloudEvents-schema och en logikapp som händelsehanterare. Mall ursprungligen författad av Justin Yoo.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen eventSubscriptions kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.EventGrid/eventSubscriptions-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2018-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      destination = {
        endpointType = "string"
        // For remaining properties, see EventSubscriptionDestination objects
      }
      eventDeliverySchema = "string"
      filter = {
        includedEventTypes = [
          "string"
        ]
        isSubjectCaseSensitive = bool
        subjectBeginsWith = "string"
        subjectEndsWith = "string"
      }
      labels = [
        "string"
      ]
      retryPolicy = {
        eventTimeToLiveInMinutes = int
        maxDeliveryAttempts = int
      }
    }
  })
}

DeadLetterDestination-objekt

Ange egenskapen endpointType för att ange typ av objekt.

För StorageBlobanvänder du:

{
  endpointType = "StorageBlob"
  properties = {
    blobContainerName = "string"
    resourceId = "string"
  }
}

EventSubscriptionDestination-objekt

Ange egenskapen endpointType för att ange typ av objekt.

För EventHubanvänder du:

{
  endpointType = "EventHub"
  properties = {
    resourceId = "string"
  }
}

För HybridConnectionanvänder du:

{
  endpointType = "HybridConnection"
  properties = {
    resourceId = "string"
  }
}

För StorageQueueanvänder du:

{
  endpointType = "StorageQueue"
  properties = {
    queueName = "string"
    resourceId = "string"
  }
}

För WebHookanvänder du:

{
  endpointType = "WebHook"
  properties = {
    endpointUrl = "string"
  }
}

Egenskapsvärden

DeadLetterDestination

Namn Beskrivning Värde
endpointType Ange till "StorageBlob" för typen StorageBlobDeadLetterDestination. "StorageBlob" (krävs)

EventHubEventSubscriptionDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för händelseprenumerationsmålet "EventHub" (krävs)
Egenskaper Event Hub-egenskaper för händelseprenumerationsmålet EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Namn Beskrivning Värde
resourceId Det Azure-resurs-ID som representerar slutpunkten för ett Event Hub-mål för en händelseprenumeration. sträng

EventSubscriptionDestination

Namn Beskrivning Värde
endpointType Ange till EventHub för typen EventHubEventSubscriptionDestination. Ange till "HybridConnection" för typen HybridConnectionEventSubscriptionDestination. Ange till "StorageQueue" för typen StorageQueueEventSubscriptionDestination. Ange till WebHook för typen WebHookEventSubscriptionDestination. "EventHub"
"HybridConnection"
"StorageQueue"
"WebHook" (krävs)

EventSubscriptionFilter

Namn Beskrivning Värde
includedEventTypes En lista över tillämpliga händelsetyper som måste ingå i händelseprenumerationen.
Om du vill prenumerera på alla händelsetyper måste strängen "alla" anges som ett element i den här listan.
string[]
isSubjectCaseSensitive Anger om egenskaperna SubjectBeginsWith och SubjectEndsWith för filtret
bör jämföras på ett skiftlägeskänsligt sätt.
Bool
subjectBeginsWith En valfri sträng för att filtrera händelser för en händelseprenumeration baserat på ett resurssökvägsprefix.
Formatet för detta beror på utgivaren av händelserna.
Jokertecken stöds inte i den här sökvägen.
sträng
subjectEndsWith En valfri sträng för att filtrera händelser för en händelseprenumeration baserat på ett suffix för resurssökväg.
Jokertecken stöds inte i den här sökvägen.
sträng

EventSubscriptionProperties

Namn Beskrivning Värde
deadLetterDestination DeadLetter-målet för händelseprenumerationen. DeadLetterDestination
destination Information om målet där händelser måste levereras för händelseprenumerationen. EventSubscriptionDestination
eventDeliverySchema Händelseleveransschemat för händelseprenumerationen. "CloudEventV01Schema"
"EventGridSchema"
"InputEventSchema"
filter Information om filtret för händelseprenumerationen. EventSubscriptionFilter
Etiketter Lista över användardefinierade etiketter. string[]
retryPolicy Återförsöksprincipen för händelser. Detta kan användas för att konfigurera maximalt antal leveransförsök och tid att leva för händelser. RetryPolicy

HybridConnectionEventSubscriptionDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för händelseprenumerationsmålet "HybridConnection" (krävs)
Egenskaper Hybridanslutningsegenskaper för händelseprenumerationsmålet HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Namn Beskrivning Värde
resourceId Azure-resurs-ID för en hybridanslutning som är målet för en händelseprenumeration. sträng

Microsoft.EventGrid/eventSubscriptions

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
parent_id ID:t för resursen som den här tilläggsresursen ska tillämpas på. sträng (krävs)
Egenskaper Egenskaper för händelseprenumerationen EventSubscriptionProperties
typ Resurstypen "Microsoft.EventGrid/eventSubscriptions@2018-05-01-preview"

RetryPolicy

Namn Beskrivning Värde
eventTimeToLiveInMinutes Time To Live (i minuter) för händelser. Int
maxDeliveryAttempts Maximalt antal återförsök av leveransförsök för händelser. Int

StorageBlobDeadLetterDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för mål med obeställbara bokstäver "StorageBlob" (krävs)
Egenskaper Egenskaperna för det Lagringsblobbaserade deadletter-målet StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Namn Beskrivning Värde
blobContainerName Namnet på lagringsblobcontainern som är målet för deadletter-händelserna sträng
resourceId Azure-resurs-ID:t för lagringskontot som är målet för deadletter-händelserna sträng

StorageQueueEventSubscriptionDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för händelseprenumerationsmålet "StorageQueue" (krävs)
Egenskaper Lagringsköegenskaper för händelseprenumerationsmålet StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Namn Beskrivning Värde
queueName Namnet på lagringskö under ett lagringskonto som är målet för en händelseprenumeration. sträng
resourceId Azure-resurs-ID för lagringskontot som innehåller kön som är målet för en händelseprenumeration. sträng

WebHookEventSubscriptionDestination

Namn Beskrivning Värde
endpointType Typ av slutpunkt för händelseprenumerationsmålet "WebHook" (krävs)
Egenskaper WebHook-egenskaper för händelseprenumerationsmålet WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Namn Beskrivning Värde
endpointUrl DEN URL som representerar slutpunkten för målet för en händelseprenumeration. sträng