Microsoft.EventGrid eventSubscriptions 2018-05-01-preview

Definice prostředku Bicep

Typ prostředku eventSubscriptions je prostředek rozšíření, což znamená, že ho můžete použít na jiný prostředek.

scope Pomocí vlastnosti tohoto prostředku nastavte obor tohoto prostředku. Viz Nastavení oboru pro prostředky rozšíření v Bicep.

Typ prostředku eventSubscriptions je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.EventGrid/eventSubscriptions, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2018-05-01-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  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
    }
  }
}

Objekty DeadLetterDestination

Nastavením vlastnosti endpointType zadejte typ objektu.

Pro StorageBlob použijte:

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

Objekty EventSubscriptionDestination

Nastavením vlastnosti endpointType zadejte typ objektu.

Pro EventHub použijte:

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

Pro HybridConnection použijte:

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

Pro StorageQueue použijte:

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

Pro webhook použijte:

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

Hodnoty vlastností

předplatná událostí

Název Description Hodnota
name Název prostředku string (povinné)

Omezení počtu znaků: 3–64

Platné znaky:
Alfanumerické znaky a pomlčky.
scope Použijte při vytváření prostředku rozšíření v oboru, který se liší od oboru nasazení. Cílový prostředek

Pro Bicep nastavte tuto vlastnost na symbolický název prostředku, aby se použil prostředek rozšíření.
properties Vlastnosti odběru událostí Vlastnosti odběru událostí

Vlastnosti odběru událostí

Název Description Hodnota
deadLetterDestination Cíl DeadLetter odběru události. DeadLetterDestination
destination Informace o cíli, kam se mají doručovat události pro odběr událostí. EventSubscriptionDestination
eventDeliverySchema Schéma doručování událostí pro odběr události. CloudEventV01Schema
EventGridSchema
'InputEventSchema'
filter Informace o filtru odběru událostí. Filtr odběru událostí
Popisky Seznam popisků definovaných uživatelem string[]
retryPolicy Zásady opakování pro události. To se dá použít ke konfiguraci maximálního počtu pokusů o doručení a doby trvání událostí. RetryPolicy

DeadLetterDestination

Název Description Hodnota
typ koncového bodu Nastavení typu objektu StorageBlob (povinné)

StorageBlobDeadLetterDestination

Název Description Hodnota
typ koncového bodu Typ koncového bodu pro cíl nedoručených dopisů StorageBlob (povinné)
properties Vlastnosti cíle deadletteru založeného na objektech blob služby Storage StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Název Description Hodnota
blobContainerName Název kontejneru objektů blob služby Storage, který je cílem událostí deadletter řetězec
resourceId ID prostředku Azure účtu úložiště, který je cílem událostí deadletter řetězec

EventSubscriptionDestination

Název Description Hodnota
endpointType Nastavení typu objektu EventHub
HybridConnection
StorageQueue
WebHook (povinné)

EventHubEventSubscriptionDestination

Název Description Hodnota
endpointType Typ koncového bodu pro cíl odběru událostí EventHub (povinné)
properties Vlastnosti centra událostí cíle odběru událostí EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Název Description Hodnota
resourceId ID prostředku Azure, které představuje koncový bod cíle centra událostí odběru událostí. řetězec

HybridConnectionEventSubscriptionDestination

Název Description Hodnota
endpointType Typ koncového bodu pro cíl odběru událostí HybridConnection (povinné)
properties Vlastnosti hybridního připojení cíle odběru událostí HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

Název Description Hodnota
resourceId ID prostředku Azure hybridního připojení, které je cílem odběru událostí. řetězec

StorageQueueEventSubscriptionDestination

Název Description Hodnota
endpointType Typ koncového bodu pro cíl odběru událostí StorageQueue (povinné)
properties Vlastnosti fronty úložiště cíle odběru událostí StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Název Description Hodnota
queueName Název fronty úložiště v účtu úložiště, který je cílem odběru událostí. řetězec
resourceId ID prostředku Azure účtu úložiště, který obsahuje frontu, která je cílem odběru událostí. řetězec

WebHookEventSubscriptionDestination

Název Description Hodnota
endpointType Typ koncového bodu pro cíl odběru událostí WebHook (povinné)
properties WebHook – vlastnosti cíle odběru událostí WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Název Description Hodnota
endpointUrl Adresa URL, která představuje koncový bod cíle odběru událostí. řetězec

EventSubscriptionFilter

Název Description Hodnota
includedEventTypes Seznam příslušných typů událostí, které musí být součástí odběru událostí.
Pokud je žádoucí přihlásit se k odběru všech typů událostí, řetězec "all" musí být zadán jako prvek v tomto seznamu.
string[]
isSubjectCaseSensitive Určuje, jestli jsou vlastnosti filtru SubjectBeginsWith a SubjectEndsWith.
by měly být porovnány způsobem, který rozlišuje velká a malá písmena.
bool
subjectBeginsWith Volitelný řetězec pro filtrování událostí odběru událostí na základě předpony cesty k prostředku.
Formát závisí na vydavateli událostí.
Tato cesta nepodporuje zástupné znaky.
řetězec
subjectEndsWith Volitelný řetězec pro filtrování událostí odběru událostí na základě přípony cesty k prostředku.
Tato cesta nepodporuje zástupné znaky.
řetězec

RetryPolicy

Název Description Hodnota
eventTimeToLiveInMinutes Funkce TTL (v minutách) pro události int
maxDeliveryAttempts Maximální počet opakovaných pokusů o doručení událostí int

Šablony pro rychlý start

Následující šablony pro rychlý start nasadí tento typ prostředku.

Template (Šablona) Description
Vytvoření vlastního tématu a odběru Azure Event Grid

Nasazení do Azure
Vytvoří Azure Event Grid vlastní téma a odběr webhooku. Šablonu původně vytvořil John Downs.
Vlastní téma Azure Event Grid nebo předplatné s CloudEvents

Nasazení do Azure
Vytvoří vlastní Azure Event Grid tématu, odběr webhooku se schématem CloudEvents a aplikaci logiky jako obslužnou rutinu události. Šablona původně byla autorem Justin Yoo.
Vytvoření vlastního tématu Event Gridu a obslužné rutiny centra událostí

Nasazení do Azure
Vytvoří Azure Event Grid vlastní téma a centrum událostí pro zpracování událostí.
Vytvoření odběru Event Gridu pro události prostředků

Nasazení do Azure
Vytvoří odběr Event Gridu pro skupinu prostředků nebo předplatné Azure.
Vytvoření vlastního tématu a odběru fronty Azure Event Grid

Nasazení do Azure
Vytvoří Azure Event Grid vlastní téma a odběr fronty služby Service Bus. Šablona původně byla autorem Markus Meyer.
Vytvoření odběru vlastního tématu Azure Event Grid

Nasazení do Azure
Vytvoří Azure Event Grid vlastního tématu a odběr tématu služby Service Bus. Šablona původně byla autorem Markus Meyer.

Definice prostředku šablony ARM

Typ prostředku eventSubscriptions je prostředek rozšíření, což znamená, že ho můžete použít na jiný prostředek.

scope Pomocí vlastnosti tohoto prostředku nastavte obor tohoto prostředku. Viz Nastavení oboru pro prostředky rozšíření v šablonách ARM.

Typ prostředku eventSubscriptions je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.EventGrid/eventSubscriptions, přidejte do šablony následující kód JSON.

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2018-05-01-preview",
  "name": "string",
  "scope": "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"
    }
  }
}

Objekty DeadLetterDestination

Nastavením vlastnosti endpointType zadejte typ objektu.

Pro StorageBlob použijte:

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

Objekty EventSubscriptionDestination

Nastavením vlastnosti endpointType zadejte typ objektu.

Pro EventHub použijte:

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

Pro HybridConnection použijte:

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

Pro StorageQueue použijte:

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

Pro webhook použijte:

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

Hodnoty vlastností

předplatná událostí

Název Description Hodnota
typ Typ prostředku Microsoft.EventGrid/eventSubscriptions
apiVersion Verze rozhraní API prostředku 2018-05-01-preview
name Název prostředku string (povinné)

Omezení počtu znaků: 3–64

Platné znaky:
Alfanumerické znaky a pomlčky.
scope Použijte při vytváření prostředku rozšíření v oboru, který se liší od oboru nasazení. Cílový prostředek

Pro JSON nastavte hodnotu na úplný název prostředku, na který se má prostředek rozšíření použít.
properties Vlastnosti odběru událostí Vlastnosti odběru událostí

Vlastnosti odběru událostí

Název Description Hodnota
deadLetterDestination Cíl DeadLetter odběru události. DeadLetterDestination
destination Informace o cíli, kam se mají doručovat události pro odběr událostí. EventSubscriptionDestination
eventDeliverySchema Schéma doručování událostí pro odběr události. CloudEventV01Schema
EventGridSchema
'InputEventSchema'
filter Informace o filtru odběru událostí. Filtr odběru událostí
Popisky Seznam popisků definovaných uživatelem string[]
retryPolicy Zásady opakování pro události. To se dá použít ke konfiguraci maximálního počtu pokusů o doručení a doby trvání událostí. RetryPolicy

DeadLetterDestination

Název Description Hodnota
typ koncového bodu Nastavení typu objektu StorageBlob (povinné)

StorageBlobDeadLetterDestination

Název Description Hodnota
typ koncového bodu Typ koncového bodu pro cíl nedoručených dopisů StorageBlob (povinné)
properties Vlastnosti cíle nedoručení založeného na objektech blob služby Storage StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Název Description Hodnota
blobContainerName Název kontejneru objektů blob služby Storage, který je cílem událostí deadletter řetězec
resourceId ID prostředku Azure účtu úložiště, který je cílem událostí deadletter řetězec

EventSubscriptionDestination

Název Description Hodnota
typ koncového bodu Nastavení typu objektu EventHub
HybridConnection
StorageQueue
Webhook (povinné)

EventHubEventSubscriptionDestination

Název Description Hodnota
typ koncového bodu Typ koncového bodu pro cíl odběru událostí EventHub (povinné)
properties Vlastnosti centra událostí cíle odběru událostí EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Název Description Hodnota
resourceId ID prostředku Azure, které představuje koncový bod cíle centra událostí odběru událostí. řetězec

HybridConnectionEventSubscriptionDestination

Název Description Hodnota
typ koncového bodu Typ koncového bodu pro cíl odběru událostí HybridConnection (povinné)
properties Vlastnosti hybridního připojení cíle odběru událostí HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

Název Description Hodnota
resourceId ID prostředku Azure hybridního připojení, které je cílem odběru událostí. řetězec

StorageQueueEventSubscriptionDestination

Název Description Hodnota
typ koncového bodu Typ koncového bodu pro cíl odběru událostí StorageQueue (povinné)
properties Vlastnosti fronty úložiště cíle odběru událostí StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Název Description Hodnota
queueName Název fronty úložiště v účtu úložiště, který je cílem odběru událostí. řetězec
resourceId ID prostředku Azure účtu úložiště, který obsahuje frontu, která je cílem odběru událostí. řetězec

WebHookEventSubscriptionDestination

Název Description Hodnota
endpointType Typ koncového bodu pro cíl odběru událostí WebHook (povinné)
properties WebHook – vlastnosti cíle odběru událostí WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Název Description Hodnota
endpointUrl Adresa URL, která představuje koncový bod cíle odběru událostí. řetězec

EventSubscriptionFilter

Název Description Hodnota
includedEventTypes Seznam příslušných typů událostí, které musí být součástí odběru událostí.
Pokud je žádoucí přihlásit se k odběru všech typů událostí, řetězec "all" musí být zadán jako prvek v tomto seznamu.
string[]
isSubjectCaseSensitive Určuje, jestli vlastnosti filtru SubjectBeginsWith a SubjectEndsWith
by měly být porovnány způsobem, který rozlišuje velká a malá písmena.
bool
subjectBeginsWith Volitelný řetězec pro filtrování událostí odběru událostí na základě předpony cesty k prostředku.
Formát závisí na vydavateli událostí.
Tato cesta nepodporuje zástupné znaky.
řetězec
subjectEndsWith Volitelný řetězec pro filtrování událostí odběru událostí na základě přípony cesty k prostředku.
Tato cesta nepodporuje zástupné znaky.
řetězec

RetryPolicy

Název Description Hodnota
eventTimeToLiveInMinutes Funkce Time To Live (v minutách) pro události. int
maxDeliveryAttempts Maximální počet opakovaných pokusů o doručení událostí int

Šablony pro rychlý start

Následující šablony rychlého startu nasadí tento typ prostředku.

Template (Šablona) Description
Vytvoření vlastního tématu a předplatného Azure Event Grid

Nasazení do Azure
Vytvoří Azure Event Grid vlastní téma a předplatné webhooku. Šablonu původně vytvořil John Downs.
Vlastní téma Azure Event Grid nebo předplatné s CloudEvents

Nasazení do Azure
Vytvoří vlastní téma Azure Event Grid, odběr webhooku se schématem CloudEvents a aplikaci logiky jako obslužnou rutinu události. Šablonu původně vytvořil Justin Yoo.
Vytvoření vlastního tématu Event Gridu a obslužné rutiny centra událostí

Nasazení do Azure
Vytvoří Azure Event Grid vlastní téma a centrum událostí pro zpracování událostí.
Vytvoření odběru Event Gridu pro události prostředků

Nasazení do Azure
Vytvoří odběr Event Gridu pro skupinu prostředků nebo předplatné Azure.
Vytvoření vlastního tématu a odběru fronty Azure Event Grid

Nasazení do Azure
Vytvoří Azure Event Grid vlastní téma a předplatné fronty služby Service Bus. Původně autorem šablony je Markus Meyer.
Vytvoření předplatného vlastního tématu Azure Event Grid

Nasazení do Azure
Vytvoří Azure Event Grid vlastní téma a předplatné tématu služby Service Bus. Původně autorem šablony je Markus Meyer.

Definice prostředku Terraformu (zprostředkovatele AzAPI)

Typ prostředku eventSubscriptions je prostředek rozšíření, což znamená, že ho můžete použít na jiný prostředek.

parent_id Pomocí vlastnosti tohoto prostředku nastavte obor tohoto prostředku.

Typ prostředku eventSubscriptions je možné nasadit s operacemi, které cílí na:

  • Skupiny prostředků
  • Předplatná

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.EventGrid/eventSubscriptions, přidejte do šablony následující Terraform.

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 – objekty

Nastavte vlastnost endpointType a určete typ objektu.

Pro StorageBlob použijte:

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

EventSubscriptionDestination – objekty

Nastavte vlastnost endpointType a určete typ objektu.

Pro EventHub použijte:

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

Pro HybridConnection použijte:

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

Pro StorageQueue použijte:

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

Pro WebHook použijte:

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

Hodnoty vlastností

eventSubscriptions

Název Description Hodnota
typ Typ prostředku Microsoft.EventGrid/eventSubscriptions@2018-05-01-preview
name Název prostředku string (povinné)

Limit počtu znaků: 3–64

Platné znaky:
Alfanumerické znaky a spojovníky.
parent_id ID prostředku, na který se má tento prostředek rozšíření použít. string (povinné)
properties Vlastnosti odběru událostí EventSubscriptionProperties

EventSubscriptionProperties

Název Description Hodnota
deadLetterDestination Cíl DeadLetter odběru události. DeadLetterDestination
destination Informace o cíli, kam se mají doručovat události pro odběr události. EventSubscriptionDestination
eventDeliverySchema Schéma doručování událostí pro odběr události. "CloudEventV01Schema"
"EventGridSchema"
"InputEventSchema"
filter Informace o filtru odběru událostí. EventSubscriptionFilter
Popisky Seznam popisků definovaných uživatelem string[]
retryPolicy Zásady opakování pro události. Můžete ho použít ke konfiguraci maximálního počtu pokusů o doručení a doby trvání událostí. RetryPolicy

DeadLetterDestination

Název Description Hodnota
endpointType Nastavení typu objektu StorageBlob (povinné)

StorageBlobDeadLetterDestination

Název Description Hodnota
endpointType Typ koncového bodu pro cíl nedoručených dopisů "StorageBlob" (povinné)
properties Vlastnosti cíle deadletteru založeného na objektech blob služby Storage StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Název Description Hodnota
blobContainerName Název kontejneru objektů blob služby Storage, který je cílem událostí deadletter řetězec
resourceId ID prostředku Azure účtu úložiště, který je cílem událostí deadletter řetězec

EventSubscriptionDestination

Název Description Hodnota
endpointType Nastavení typu objektu EventHub
HybridConnection
StorageQueue
WebHook (povinné)

EventHubEventSubscriptionDestination

Název Description Hodnota
endpointType Typ koncového bodu pro cíl odběru událostí "EventHub" (povinné)
properties Vlastnosti centra událostí cíle odběru událostí EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Název Description Hodnota
resourceId ID prostředku Azure, které představuje koncový bod cíle centra událostí odběru událostí. řetězec

HybridConnectionEventSubscriptionDestination

Název Description Hodnota
typ koncového bodu Typ koncového bodu pro cíl odběru událostí HybridConnection (povinné)
properties Vlastnosti hybridního připojení cíle odběru událostí HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

Název Description Hodnota
resourceId ID prostředku Azure hybridního připojení, které je cílem odběru událostí. řetězec

StorageQueueEventSubscriptionDestination

Název Description Hodnota
typ koncového bodu Typ koncového bodu pro cíl odběru událostí "StorageQueue" (povinné)
properties Vlastnosti fronty úložiště cíle odběru událostí StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Název Description Hodnota
název_fronty Název fronty úložiště v rámci účtu úložiště, který je cílem odběru událostí. řetězec
resourceId ID prostředku Azure účtu úložiště, který obsahuje frontu, která je cílem odběru událostí. řetězec

WebHookEventSubscriptionDestination

Název Description Hodnota
typ koncového bodu Typ koncového bodu pro cíl odběru událostí Webhook (povinné)
properties Vlastnosti webhooku cíle odběru událostí WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Název Description Hodnota
adresa URL koncového bodu Adresa URL, která představuje koncový bod cíle odběru událostí. řetězec

Filtr odběru událostí

Název Description Hodnota
includedEventTypes Seznam použitelných typů událostí, které musí být součástí odběru událostí.
Pokud se chcete přihlásit k odběru všech typů událostí, musí být řetězec "all" zadán jako prvek v tomto seznamu.
string[]
isSubjectCaseSensitive Určuje, jestli jsou vlastnosti filtru SubjectBeginsWith a SubjectEndsWith.
by měly být porovnány způsobem, který rozlišuje velká a malá písmena.
bool
subjectBeginsWith Volitelný řetězec pro filtrování událostí odběru událostí na základě předpony cesty k prostředku.
Formát závisí na vydavateli událostí.
Tato cesta nepodporuje zástupné znaky.
řetězec
subjectEndsWith Volitelný řetězec pro filtrování událostí odběru událostí na základě přípony cesty k prostředku.
Tato cesta nepodporuje zástupné znaky.
řetězec

RetryPolicy

Název Description Hodnota
eventTimeToLiveInMinutes Funkce TTL (v minutách) pro události int
maxDeliveryAttempts Maximální počet opakovaných pokusů o doručení událostí int