Событие Microsoft.EventGrid eventSubscriptions 2018-05-01-preview

Определение ресурса Bicep

Тип ресурса eventSubscriptions можно развернуть с помощью операций, предназначенных для следующих операций:

• Tenant — см. команды развертывания арендаторов Группы* управления — См. команды* развертывания группыуправления Подписка — См. команды* развертыванияподписки Группы ресурсов — См. команды развертывания группы ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Примеры использования

Примеры Bicep

Простой пример развертывания подписки на события EventGrid.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' = {
  name: resourceName
  location: location
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
  properties: {
    accessTier: 'Hot'
    allowBlobPublicAccess: true
    allowCrossTenantReplication: true
    allowSharedKeyAccess: true
    defaultToOAuthAuthentication: false
    encryption: {
      keySource: 'Microsoft.Storage'
      services: {
        queue: {
          keyType: 'Service'
        }
        table: {
          keyType: 'Service'
        }
      }
    }
    isHnsEnabled: false
    isNfsV3Enabled: false
    isSftpEnabled: false
    minimumTlsVersion: 'TLS1_2'
    networkAcls: {
      defaultAction: 'Allow'
    }
    publicNetworkAccess: 'Enabled'
    supportsHttpsTrafficOnly: true
  }
}

resource eventSubscription 'Microsoft.EventGrid/eventSubscriptions@2021-12-01' = {
  name: resourceName
  scope: storageAccount
  properties: {
    destination: {
      endpointType: 'EventHub'
      properties: {
        resourceId: eventhub.id
      }
    }
    eventDeliverySchema: 'EventGridSchema'
    filter: {
      includedEventTypes: [
        'Microsoft.Storage.BlobCreated'
        'Microsoft.Storage.BlobRenamed'
      ]
    }
    labels: []
    retryPolicy: {
      eventTimeToLiveInMinutes: 144
      maxDeliveryAttempts: 10
    }
  }
}

resource namespace 'Microsoft.EventHub/namespaces@2022-01-01-preview' = {
  name: resourceName
  location: location
  sku: {
    capacity: 1
    name: 'Standard'
    tier: 'Standard'
  }
  properties: {
    disableLocalAuth: false
    isAutoInflateEnabled: false
    publicNetworkAccess: 'Enabled'
    zoneRedundant: false
  }
}

resource eventhub 'Microsoft.EventHub/namespaces/eventhubs@2021-11-01' = {
  name: resourceName
  parent: namespace
  properties: {
    messageRetentionInDays: 1
    partitionCount: 1
    status: 'Active'
  }
}

Примеры быстрого запуска Azure

Следующие шаблоны Azure Quickstart содержат Bicep образцов для развертывания этого типа ресурсов.

Формат ресурса

Чтобы создать ресурс Microsoft.EventGrid/eventSubscriptions, добавьте следующий Bicep в ваш шаблон.

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
    }
  }
}

Объекты EventSubscriptionDestination

Задайте свойство endpointType , чтобы указать тип объекта.

Для EventHub используйте:

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

Для HybridConnection используйте:

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

Для StorageQueue используйте:

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

Для WebHook используйте:

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

Объекты DeadLetterDestination

Задайте свойство endpointType , чтобы указать тип объекта.

Для StorageBlob используйте:

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

Значения свойств

Microsoft.EventGrid/eventSubscriptions

DeadLetterDestination

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

EventSubscriptionDestination

EventSubscriptionFilter

EventSubscriptionProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperties

RetryPolicy

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

Определение ресурса шаблона ARM

Тип ресурса eventSubscriptions можно развернуть с помощью операций, предназначенных для следующих операций:

• Tenant — см. команды развертывания tenant группы* управления — см. команды * Подписка — см. команды* развертыванияподписки Группы ресурсов — См. команды развертывания группы ресурсов Список изменённых свойств в каждой версии API см. журнал изменений.

Примеры использования

Шаблоны быстрого запуска Azure

Следующие Azure шаблоны быстрого запуска развёртают этот тип ресурса.

Template	Description
Создать Сетка событий Azure пользовательскую подписку на тему и очередь	Создаёт пользовательскую тему Сетка событий Azure и подписку на очередь сервисной шины. Шаблон первоначально создан Маркусом Мейером.
Создать Сетка событий Azure пользовательскую тему и подписку	Создаёт пользовательскую тему Сетка событий Azure и подписку webhook. Шаблон первоначально создан Джоном Дауном.
создание настраиваемой подписки сетки событий Azure	Создает пользовательскую тему Сетка событий Azure и подписку на тему сервисной шины. Шаблон первоначально создан Маркусом Мейером.
Create Event Grid — пользовательский обработчик тем и хаб событий	Создаёт пользовательский тематический и event hub Сетка событий Azure для обработки событий.
Create Event Grid подписка для событий ресурсов	Создаёт подписку Event Grid либо на группу ресурсов, либо на подписку Azure.
Пользовательская тема/подписка Сетка событий Azure с CloudEvents	Создаёт пользовательскую тему Сетка событий Azure, подписку webhook со схемой CloudEvents и логическое приложение в качестве обработчика событий. Шаблон первоначально создан ДжастинОм Yoo.

Формат ресурса

Чтобы создать ресурс Microsoft.EventGrid/eventSubscriptions, добавьте следующий код JSON в шаблон.

{
  "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"
    }
  }
}

Объекты EventSubscriptionDestination

Задайте свойство endpointType , чтобы указать тип объекта.

Для EventHub используйте:

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

Для HybridConnection используйте:

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

Для StorageQueue используйте:

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

Для WebHook используйте:

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

Объекты DeadLetterDestination

Задайте свойство endpointType , чтобы указать тип объекта.

Для StorageBlob используйте:

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

Значения свойств

Microsoft.EventGrid/eventSubscriptions

DeadLetterDestination

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

EventSubscriptionDestination

EventSubscriptionFilter

EventSubscriptionProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperties

RetryPolicy

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса eventSubscriptions можно развернуть с помощью операций, предназначенных для следующих операций:

• Арендатор* Управленческие группы* Подписка* Группы ресурсов Список изменённых свойств в каждой версии API см. журнал изменений.

Примеры использования

Примеры Terraform

Простой пример развертывания подписки на события EventGrid.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "namespace" {
  type      = "Microsoft.EventHub/namespaces@2022-01-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      disableLocalAuth     = false
      isAutoInflateEnabled = false
      publicNetworkAccess  = "Enabled"
      zoneRedundant        = false
    }
    sku = {
      capacity = 1
      name     = "Standard"
      tier     = "Standard"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
      accessTier                   = "Hot"
      allowBlobPublicAccess        = true
      allowCrossTenantReplication  = true
      allowSharedKeyAccess         = true
      defaultToOAuthAuthentication = false
      encryption = {
        keySource = "Microsoft.Storage"
        services = {
          queue = {
            keyType = "Service"
          }
          table = {
            keyType = "Service"
          }
        }
      }
      isHnsEnabled      = false
      isNfsV3Enabled    = false
      isSftpEnabled     = false
      minimumTlsVersion = "TLS1_2"
      networkAcls = {
        defaultAction = "Allow"
      }
      publicNetworkAccess      = "Enabled"
      supportsHttpsTrafficOnly = true
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "eventhub" {
  type      = "Microsoft.EventHub/namespaces/eventhubs@2021-11-01"
  parent_id = azapi_resource.namespace.id
  name      = var.resource_name
  body = {
    properties = {
      messageRetentionInDays = 1
      partitionCount         = 1
      status                 = "Active"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "eventSubscription" {
  type      = "Microsoft.EventGrid/eventSubscriptions@2021-12-01"
  parent_id = azapi_resource.storageAccount.id
  name      = var.resource_name
  body = {
    properties = {
      deadLetterDestination = null
      destination = {
        endpointType = "EventHub"
        properties = {
          deliveryAttributeMappings = null
          resourceId                = azapi_resource.eventhub.id
        }
      }
      eventDeliverySchema = "EventGridSchema"
      filter = {
        includedEventTypes = [
          "Microsoft.Storage.BlobCreated",
          "Microsoft.Storage.BlobRenamed",
        ]
      }
      labels = [
      ]
      retryPolicy = {
        eventTimeToLiveInMinutes = 144
        maxDeliveryAttempts      = 10
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Формат ресурса

Чтобы создать ресурс Microsoft.EventGrid/eventSubscriptions, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2018-05-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    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
      }
    }
  }
}

Объекты EventSubscriptionDestination

Задайте свойство endpointType , чтобы указать тип объекта.

Для EventHub используйте:

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

Для HybridConnection используйте:

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

Для StorageQueue используйте:

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

Для WebHook используйте:

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

Объекты DeadLetterDestination

Задайте свойство endpointType , чтобы указать тип объекта.

Для StorageBlob используйте:

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

Значения свойств

Microsoft.EventGrid/eventSubscriptions

DeadLetterDestination

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

EventSubscriptionDestination

EventSubscriptionFilter

EventSubscriptionProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperties

RetryPolicy

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties