Microsoft.EventGrid eventSubscriptions 2018-01-01

Definicja zasobu Bicep

Typ zasobu eventSubscriptions to zasób rozszerzenia, co oznacza, że można zastosować go do innego zasobu.

scope Użyj właściwości w tym zasobie, aby ustawić zakres dla tego zasobu. Zobacz Ustawianie zakresu dla zasobów rozszerzeń w aplikacji Bicep.

Typ zasobu eventSubscriptions można wdrożyć z operacjami docelowymi:

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

Format zasobu

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2018-01-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    filter: {
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
  }
}

EventSubscriptionDestination, obiekty

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

W przypadku usługi EventHub użyj:

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

W przypadku elementu WebHook użyj:

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

Wartości właściwości

eventSubscriptions

Nazwa Opis Wartość
name Nazwa zasobu ciąg (wymagany)

Limit znaków: 3–64

Prawidłowe znaki:
Alfanumeryczne i łączniki.
scope Użyj polecenia podczas tworzenia zasobu rozszerzenia w zakresie innym niż zakres wdrożenia. Zasób docelowy

Dla Bicep ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia.
properties Właściwości subskrypcji zdarzeń EventSubscriptionProperties

EventSubscriptionProperties

Nazwa Opis Wartość
destination Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. EventSubscriptionDestination
filter Informacje o filtrze subskrypcji zdarzeń. EventSubscriptionFilter
Etykiety Lista etykiet zdefiniowanych przez użytkownika. ciąg[]

EventSubscriptionDestination

Nazwa Opis Wartość
Endpointtype Ustawianie typu obiektu EventHub
Element webhook (wymagany)

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Nazwa Opis Wartość
resourceId Identyfikator zasobu platformy Azure reprezentujący punkt końcowy miejsca docelowego centrum zdarzeń subskrypcji zdarzeń. ciąg

WebHookEventSubscriptionDestination

Nazwa Opis Wartość
Endpointtype Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń "Element webhook" (wymagany)
properties Właściwości elementu webhook miejsca docelowego subskrypcji zdarzeń WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Nazwa Opis Wartość
endpointUrl Adres URL reprezentujący punkt końcowy docelowej subskrypcji zdarzeń. ciąg

EventSubscriptionFilter

Nazwa Opis Wartość
includedEventTypes Lista odpowiednich typów zdarzeń, które muszą być częścią subskrypcji zdarzeń.
Jeśli chcesz zasubskrybować wszystkie typy zdarzeń, ciąg "wszystkie" musi zostać określony jako element na tej liście.
ciąg[]
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ń.
Znaki wieloznaczne nie są obsługiwane w tej ścieżce.
ciąg
subjectEndsWith Opcjonalny ciąg do filtrowania zdarzeń dla subskrypcji zdarzeń na podstawie sufiksu ścieżki zasobu.
Znaki wieloznaczne nie są obsługiwane w tej ścieżce.
ciąg

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Template Opis
Tworzenie Azure Event Grid tematu niestandardowego i subskrypcji

Wdróż na platformie Azure
Tworzy Azure Event Grid temat niestandardowy i subskrypcję elementu webhook. Szablon pierwotnie autorstwa Johna Downsa.
Temat/subskrypcja niestandardowego Azure Event Grid w usłudze CloudEvents

Wdróż na platformie Azure
Tworzy niestandardowy temat Azure Event Grid, subskrypcję elementu webhook ze schematem CloudEvents i aplikację logiki jako procedurę obsługi zdarzeń. Szablon pierwotnie autorstwa Justina Yoo.
Tworzenie niestandardowego tematu usługi Event Grid i procedury obsługi centrum zdarzeń

Wdróż na platformie Azure
Tworzy Azure Event Grid temat niestandardowy i centrum zdarzeń do obsługi zdarzeń.
Tworzenie subskrypcji usługi Event Grid dla zdarzeń zasobów

Wdróż na platformie Azure
Tworzy subskrypcję usługi Event Grid w grupie zasobów lub subskrypcji platformy Azure.
Tworzenie Azure Event Grid tematu niestandardowego i subskrypcji kolejki

Wdróż na platformie Azure
Tworzy Azure Event Grid temat niestandardowy i subskrypcję kolejki usługi Service Bus. Szablon pierwotnie autorstwa Markusa Meyera.
Tworzenie subskrypcji tematu niestandardowego Azure Event Grid

Wdróż na platformie Azure
Tworzy Azure Event Grid temat niestandardowy i subskrypcję tematu usługi Service Bus. Szablon pierwotnie autorstwa Markusa Meyera.

Definicja zasobu szablonu usługi ARM

Typ zasobu eventSubscriptions to zasób rozszerzenia, co oznacza, że można zastosować go do innego zasobu.

scope Użyj właściwości w tym zasobie, aby ustawić zakres dla tego zasobu. Zobacz Ustawianie zakresu dla zasobów rozszerzeń w szablonach usługi ARM.

Typ zasobu eventSubscriptions można wdrożyć z operacjami docelowymi:

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

Format zasobu

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2018-01-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "filter": {
      "includedEventTypes": [ "string" ],
      "isSubjectCaseSensitive": "bool",
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string"
    },
    "labels": [ "string" ]
  }
}

EventSubscriptionDestination, obiekty

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

W przypadku usługi EventHub użyj:

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

W przypadku elementu WebHook użyj:

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

Wartości właściwości

eventSubscriptions

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.EventGrid/eventSubscriptions"
apiVersion Wersja interfejsu API zasobów '2018-01-01'
name Nazwa zasobu ciąg (wymagany)

Limit znaków: 3–64

Prawidłowe znaki:
Alfanumeryczne i łączniki.
scope Użyj polecenia podczas tworzenia zasobu rozszerzenia w zakresie innym niż zakres wdrożenia. Zasób docelowy

W przypadku formatu JSON ustaw wartość na pełną nazwę zasobu, aby zastosować zasób rozszerzenia do.
properties Właściwości subskrypcji zdarzeń EventSubscriptionProperties

EventSubscriptionProperties

Nazwa Opis Wartość
destination Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. EventSubscriptionDestination
filter Informacje o filtrze subskrypcji zdarzeń. EventSubscriptionFilter
Etykiety Lista etykiet zdefiniowanych przez użytkownika. ciąg[]

EventSubscriptionDestination

Nazwa Opis Wartość
Endpointtype Ustawianie typu obiektu EventHub
Element webhook (wymagany)

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Nazwa Opis Wartość
resourceId Identyfikator zasobu platformy Azure reprezentujący punkt końcowy miejsca docelowego centrum zdarzeń subskrypcji zdarzeń. ciąg

WebHookEventSubscriptionDestination

Nazwa Opis Wartość
Endpointtype Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń "Element webhook" (wymagany)
properties Właściwości elementu webhook miejsca docelowego subskrypcji zdarzeń WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Nazwa Opis Wartość
endpointUrl Adres URL reprezentujący punkt końcowy docelowej subskrypcji zdarzeń. ciąg

EventSubscriptionFilter

Nazwa Opis Wartość
includedEventTypes Lista odpowiednich typów zdarzeń, które muszą być częścią subskrypcji zdarzeń.
Jeśli chcesz zasubskrybować wszystkie typy zdarzeń, ciąg "wszystkie" musi zostać określony jako element na tej liście.
ciąg[]
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ń.
Znaki wieloznaczne nie są obsługiwane w tej ścieżce.
ciąg
subjectEndsWith Opcjonalny ciąg do filtrowania zdarzeń dla subskrypcji zdarzeń na podstawie sufiksu ścieżki zasobu.
Znaki wieloznaczne nie są obsługiwane w tej ścieżce.
ciąg

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Template Opis
Tworzenie Azure Event Grid tematu niestandardowego i subskrypcji

Wdróż na platformie Azure
Tworzy Azure Event Grid temat niestandardowy i subskrypcję elementu webhook. Szablon pierwotnie autorstwa Johna Downsa.
Temat/subskrypcja niestandardowego Azure Event Grid w usłudze CloudEvents

Wdróż na platformie Azure
Tworzy niestandardowy temat Azure Event Grid, subskrypcję elementu webhook ze schematem CloudEvents i aplikację logiki jako procedurę obsługi zdarzeń. Szablon pierwotnie autorstwa Justina Yoo.
Tworzenie niestandardowego tematu usługi Event Grid i procedury obsługi centrum zdarzeń

Wdróż na platformie Azure
Tworzy Azure Event Grid temat niestandardowy i centrum zdarzeń do obsługi zdarzeń.
Tworzenie subskrypcji usługi Event Grid dla zdarzeń zasobów

Wdróż na platformie Azure
Tworzy subskrypcję usługi Event Grid w grupie zasobów lub subskrypcji platformy Azure.
Tworzenie Azure Event Grid tematu niestandardowego i subskrypcji kolejki

Wdróż na platformie Azure
Tworzy Azure Event Grid temat niestandardowy i subskrypcję kolejki usługi Service Bus. Szablon pierwotnie autorstwa Markusa Meyera.
Tworzenie subskrypcji tematu niestandardowego Azure Event Grid

Wdróż na platformie Azure
Tworzy Azure Event Grid temat niestandardowy i subskrypcję tematu usługi Service Bus. Szablon pierwotnie autorstwa Markusa Meyera.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu eventSubscriptions to zasób rozszerzenia, co oznacza, że można zastosować go do innego zasobu.

parent_id Użyj właściwości w tym zasobie, aby ustawić zakres dla tego zasobu.

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

  • Grupy zasobów
  • Subskrypcje

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

Format zasobu

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

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

Obiekty EventSubscriptionDestination

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

W przypadku usługi EventHub użyj:

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

W przypadku elementu WebHook użyj:

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

Wartości właściwości

eventSubscriptions

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.EventGrid/eventSubscriptions@2018-01-01"
name Nazwa zasobu ciąg (wymagany)

Limit znaków: 3–64

Prawidłowe znaki:
Alfanumeryczne i łączniki.
parent_id Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. ciąg (wymagany)
properties Właściwości subskrypcji zdarzeń EventSubscriptionProperties

EventSubscriptionProperties

Nazwa Opis Wartość
destination Informacje o miejscu docelowym, w którym zdarzenia muszą być dostarczane dla subskrypcji zdarzeń. EventSubscriptionDestination
filter Informacje o filtrze subskrypcji zdarzeń. EventSubscriptionFilter
Etykiety Lista etykiet zdefiniowanych przez użytkownika. ciąg[]

EventSubscriptionDestination

Nazwa Opis Wartość
Endpointtype Ustawianie typu obiektu EventHub
Element webhook (wymagany)

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Nazwa Opis Wartość
resourceId Identyfikator zasobu platformy Azure reprezentujący punkt końcowy miejsca docelowego centrum zdarzeń subskrypcji zdarzeń. ciąg

WebHookEventSubscriptionDestination

Nazwa Opis Wartość
Endpointtype Typ punktu końcowego dla miejsca docelowego subskrypcji zdarzeń "Element webhook" (wymagany)
properties Właściwości elementu webhook docelowej subskrypcji zdarzeń WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Nazwa Opis Wartość
endpointUrl Adres URL reprezentujący punkt końcowy docelowej subskrypcji zdarzeń. ciąg

EventSubscriptionFilter

Nazwa Opis Wartość
includedEventTypes Lista odpowiednich typów zdarzeń, które muszą być częścią subskrypcji zdarzeń.
Jeśli chcesz zasubskrybować wszystkie typy zdarzeń, ciąg "wszystkie" musi zostać określony jako element na tej liście.
ciąg[]
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 elementu zależy od wydawcy zdarzeń.
Symbole wieloznaczne nie są obsługiwane w tej ścieżce.
ciąg
subjectEndsWith Opcjonalny ciąg filtrowania zdarzeń dla subskrypcji zdarzeń na podstawie sufiksu ścieżki zasobu.
Symbole wieloznaczne nie są obsługiwane w tej ścieżce.
ciąg