Udostępnij za pośrednictwem

Microsoft.EventGrid eventSubscriptions 2017-09-15-preview

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@2017-09-15-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    filter: {
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
  }
}

EventSubscriptionDestination obiektów

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

W przypadku usługi EventHubużyj:

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

W przypadkuwebhook użyj:

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

Wartości właściwości

Microsoft.EventGrid/eventSubscriptions

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości subskrypcji zdarzeń EventSubscriptionProperties
zakres Użyj polecenia podczas tworzenia zasobu w zakresie innym niż zakres wdrożenia. Ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia .

EventHubEventSubscriptionDestination

Nazwa Opis Wartość
endpointType (typ punktu końcowego) 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ść
identyfikator zasobu Identyfikator zasobu platformy Azure reprezentujący punkt końcowy miejsca docelowego centrum zdarzeń subskrypcji zdarzeń. struna

EventSubscriptionDestination

Nazwa Opis Wartość
endpointType (typ punktu końcowego) Ustaw wartość "EventHub" dla typu EventHubEventSubscriptionDestination. Ustaw wartość "WebHook" dla typu WebHookEventSubscriptionDestination. "EventHub"
"Element webhook" (wymagany)

Filtr zdarzeńSubscriptionFilter

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 znakowy[]
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
subjectZaczyna się od 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

EventSubscriptionProperties

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

WebHookEventSubscriptionDestination (miejsce docelowe)

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

WebHookEventSubscriptionDestinationProperties

Nazwa Opis Wartość
adres URL punktu końcowego Adres URL reprezentujący punkt końcowy docelowej subskrypcji zdarzeń. struna

Przykłady użycia

Przykłady szybkiego startu platformy Azure

Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.

Plik Bicep Opis
tworzenie niestandardowego tematu i subskrypcji kolejki usługi Azure Event Grid Tworzy niestandardowy temat usługi Azure Event Grid i subskrypcję kolejki usługi Service Bus. Szablon pierwotnie autorstwa Markusa Meyera.
tworzenie tematu niestandardowego i subskrypcji usługi Azure Event Grid Tworzy temat niestandardowy usługi Azure Event Grid i subskrypcję elementu webhook. Szablon pierwotnie autorstwa Johna Downsa.

Definicja zasobu szablonu usługi ARM

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 JSON do szablonu.

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

EventSubscriptionDestination obiektów

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

W przypadku usługi EventHubużyj:

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

W przypadkuwebhook użyj:

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

Wartości właściwości

Microsoft.EventGrid/eventSubscriptions

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API "2017-09-15-preview"
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości subskrypcji zdarzeń EventSubscriptionProperties
typ Typ zasobu "Microsoft.EventGrid/eventSubscriptions"

EventHubEventSubscriptionDestination

Nazwa Opis Wartość
endpointType (typ punktu końcowego) 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ść
identyfikator zasobu Identyfikator zasobu platformy Azure reprezentujący punkt końcowy miejsca docelowego centrum zdarzeń subskrypcji zdarzeń. struna

EventSubscriptionDestination

Nazwa Opis Wartość
endpointType (typ punktu końcowego) Ustaw wartość "EventHub" dla typu EventHubEventSubscriptionDestination. Ustaw wartość "WebHook" dla typu WebHookEventSubscriptionDestination. "EventHub"
"Element webhook" (wymagany)

Filtr zdarzeńSubscriptionFilter

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 znakowy[]
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
subjectZaczyna się od 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

EventSubscriptionProperties

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

WebHookEventSubscriptionDestination (miejsce docelowe)

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

WebHookEventSubscriptionDestinationProperties

Nazwa Opis Wartość
adres URL punktu końcowego Adres URL reprezentujący punkt końcowy docelowej subskrypcji zdarzeń. struna

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon Opis
tworzenie niestandardowego tematu i subskrypcji kolejki usługi Azure Event Grid

wdrażanie w usłudze Azure		 Tworzy niestandardowy temat usługi Azure Event Grid i subskrypcję kolejki usługi Service Bus. Szablon pierwotnie autorstwa Markusa Meyera.
tworzenie tematu niestandardowego i subskrypcji usługi Azure Event Grid

wdrażanie w usłudze Azure		 Tworzy temat niestandardowy usługi Azure Event Grid i subskrypcję elementu webhook. Szablon pierwotnie autorstwa Johna Downsa.
tworzenie subskrypcji tematu niestandardowego usługi Azure Event Grid

wdrażanie w usłudze Azure		 Tworzy niestandardowy temat usługi Azure Event Grid i subskrypcję tematu usługi Service Bus. Szablon pierwotnie autorstwa Markusa Meyera.
tworzenie niestandardowego tematu usługi Event Grid i programu obsługi centrum zdarzeń

wdrażanie w usłudze Azure		 Tworzy niestandardowy temat usługi Azure Event Grid i centrum zdarzeń do obsługi zdarzeń.
Tworzenie subskrypcji usługi Event Grid dla zdarzeń zasobów

wdrażanie w usłudze Azure		 Tworzy subskrypcję usługi Event Grid w grupie zasobów lub subskrypcji platformy Azure.
temat/subskrypcja usługi Azure Event Grid z usługą CloudEvents

wdrażanie w usłudze Azure		 Tworzy niestandardowy temat usługi Azure Event Grid, subskrypcję elementu webhook ze schematem CloudEvents i aplikację logiki jako procedurę obsługi zdarzeń. Szablon pierwotnie autorstwa Justina Yoo.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

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 program Terraform do szablonu.

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

EventSubscriptionDestination obiektów

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

W przypadku usługi EventHubużyj:

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

W przypadkuwebhook użyj:

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

Wartości właściwości

Microsoft.EventGrid/eventSubscriptions

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
parent_id (identyfikator rodzica) Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. ciąg (wymagany)
Właściwości Właściwości subskrypcji zdarzeń EventSubscriptionProperties
typ Typ zasobu "Microsoft.EventGrid/eventSubscriptions@2017-09-15-preview"

EventHubEventSubscriptionDestination

Nazwa Opis Wartość
endpointType (typ punktu końcowego) 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ść
identyfikator zasobu Identyfikator zasobu platformy Azure reprezentujący punkt końcowy miejsca docelowego centrum zdarzeń subskrypcji zdarzeń. struna

EventSubscriptionDestination

Nazwa Opis Wartość
endpointType (typ punktu końcowego) Ustaw wartość "EventHub" dla typu EventHubEventSubscriptionDestination. Ustaw wartość "WebHook" dla typu WebHookEventSubscriptionDestination. "EventHub"
"Element webhook" (wymagany)

Filtr zdarzeńSubscriptionFilter

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 znakowy[]
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
subjectZaczyna się od 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

EventSubscriptionProperties

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

WebHookEventSubscriptionDestination (miejsce docelowe)

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

WebHookEventSubscriptionDestinationProperties

Nazwa Opis Wartość
adres URL punktu końcowego Adres URL reprezentujący punkt końcowy docelowej subskrypcji zdarzeń. struna