Microsoft.EventGrid eventSubscriptions 2018-01-01
- Más reciente
- 2023-12-15-preview
- 2023-06-01-preview
- 2022-06-15
- 2021-12-01
- 2021-10-15-preview
- 2021-06-01-preview
- 2020-10-15-preview
- 2020-06-01
- 2020-04-01-preview
- 2020-01-01-preview
- 2019-06-01
- 2019-02-01-preview
- 2019-01-01
- 2018-09-15-preview
- 2018-05-01-preview
- 2018-01-01
- 2017-09-15-preview
- 2017-06-15-preview
Definición de recursos de Bicep
El tipo de recurso eventSubscriptions es un recurso de extensión, lo que significa que puede aplicarlo a otro recurso.
Use la scope propiedad de este recurso para establecer el ámbito de este recurso. Consulte Establecimiento del ámbito en los recursos de extensión en Bicep.
El tipo de recurso eventSubscriptions se puede implementar con operaciones que tienen como destino:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
- Suscripciones: consulte los comandos de implementación de suscripciones.
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.EventGrid/eventSubscriptions, agregue el siguiente bicep a la plantilla.
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'
]
}
}
Objetos EventSubscriptionDestination
Establezca la propiedad endpointType para especificar el tipo de objeto.
Para EventHub, use:
endpointType: 'EventHub'
properties: {
resourceId: 'string'
}
Para WebHook, use:
endpointType: 'WebHook'
properties: {
endpointUrl: 'string'
}
Valores de propiedad
eventSubscriptions
| Nombre | Descripción | Value |
|---|---|---|
| name | El nombre del recurso | string (obligatorio) Límite de caracteres: 3-64 Caracteres válidos: Caracteres alfanuméricos y guiones. |
| scope | Use al crear un recurso de extensión en un ámbito diferente al ámbito de implementación. | Recurso de destino Para Bicep, establezca esta propiedad en el nombre simbólico del recurso para aplicar el recurso de extensión. |
| properties | Propiedades de la suscripción de eventos | EventSubscriptionProperties |
EventSubscriptionProperties
| Nombre | Descripción | Valor |
|---|---|---|
| destination | Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos. | EventSubscriptionDestination |
| filter | Información sobre el filtro de la suscripción de eventos. | EventSubscriptionFilter |
| labels | Lista de etiquetas definidas por el usuario. | string[] |
EventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Establecimiento del tipo de objeto | EventHub WebHook (obligatorio) |
EventHubEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Tipo del punto de conexión para el destino de la suscripción de eventos | 'EventHub' (obligatorio) |
| properties | Propiedades del centro de eventos del destino de la suscripción de eventos | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nombre | Descripción | Value |
|---|---|---|
| resourceId | Identificador de recurso de Azure que representa el punto de conexión de un destino del centro de eventos de una suscripción de eventos. | string |
WebHookEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Tipo del punto de conexión para el destino de la suscripción de eventos | 'WebHook' (obligatorio) |
| properties | Propiedades de webHook del destino de la suscripción de eventos | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nombre | Descripción | Valor |
|---|---|---|
| endpointUrl | Dirección URL que representa el punto de conexión del destino de una suscripción de eventos. | string |
EventSubscriptionFilter
| Nombre | Descripción | Valor |
|---|---|---|
| includedEventTypes | Lista de tipos de eventos aplicables que deben formar parte de la suscripción de eventos. Si desea suscribirse a todos los tipos de eventos, la cadena "all" debe especificarse como un elemento de esta lista. |
string[] |
| isSubjectCaseSensitive | Especifica si las propiedades SubjectBeginsWith y SubjectEndsWith del filtro debe compararse de una manera sensible a mayúsculas y minúsculas. |
bool |
| subjectBeginsWith | Cadena opcional para filtrar eventos de una suscripción de eventos en función de un prefijo de ruta de acceso de recurso. El formato de esto depende del publicador de los eventos. Los caracteres comodín no se admiten en esta ruta de acceso. |
string |
| subjectEndsWith | Cadena opcional para filtrar eventos de una suscripción de eventos en función de un sufijo de ruta de acceso de recurso. Los caracteres comodín no se admiten en esta ruta de acceso. |
string |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
| Plantilla | Descripción |
|---|---|
Crear Azure Event Grid tema personalizado y suscripción |
Crea un tema personalizado Azure Event Grid y una suscripción de webhook. Plantilla originalmente creadas por John Downs. |
| Tema o suscripción personalizados Azure Event Grid con CloudEvents |
Crea un tema de Azure Event Grid personalizado, una suscripción de webhook que tiene el esquema CloudEvents y una aplicación lógica como controlador de eventos. Plantilla originalmente creadas por Justin Yoo. |
| Creación de un tema personalizado de Event Grid y un controlador de centro de eventos |
Crea un Azure Event Grid tema personalizado y centro de eventos para controlar los eventos. |
| Creación de una suscripción de Event Grid para eventos de recursos |
Crea una suscripción de Event Grid a un grupo de recursos o a una suscripción de Azure. |
| Creación de Azure Event Grid tema personalizado y suscripción de cola |
Crea un tema personalizado Azure Event Grid y una suscripción de cola de Service Bus. Plantilla originalmente creadas por Markus Meyer. |
| Crear Azure Event Grid suscripción a temas personalizados |
Crea un Azure Event Grid tema personalizado y una suscripción de tema de Service Bus. Plantilla originalmente creadas por Markus Meyer. |
Definición de recursos de plantilla de ARM
El tipo de recurso eventSubscriptions es un recurso de extensión, lo que significa que puede aplicarlo a otro recurso.
Use la scope propiedad de este recurso para establecer el ámbito de este recurso. Consulte Establecimiento del ámbito en los recursos de extensión en plantillas de ARM.
El tipo de recurso eventSubscriptions se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
- Suscripciones: consulte los comandos de implementación de suscripciones.
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.EventGrid/eventSubscriptions, agregue el siguiente JSON a la plantilla.
{
"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" ]
}
}
Objetos EventSubscriptionDestination
Establezca la propiedad endpointType para especificar el tipo de objeto.
Para EventHub, use:
"endpointType": "EventHub",
"properties": {
"resourceId": "string"
}
Para WebHook, use:
"endpointType": "WebHook",
"properties": {
"endpointUrl": "string"
}
Valores de propiedad
eventSubscriptions
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | 'Microsoft.EventGrid/eventSubscriptions' |
| apiVersion | La versión de la API de recursos | '2018-01-01' |
| name | El nombre del recurso | string (obligatorio) Límite de caracteres: 3-64 Caracteres válidos: Caracteres alfanuméricos y guiones. |
| scope | Use al crear un recurso de extensión en un ámbito diferente del ámbito de implementación. | Recurso de destino En JSON, establezca el valor en el nombre completo del recurso al que se va a aplicar el recurso de extensión . |
| properties | Propiedades de la suscripción de eventos | EventSubscriptionProperties |
EventSubscriptionProperties
| Nombre | Descripción | Valor |
|---|---|---|
| destination | Información sobre el destino en el que se deben entregar los eventos para la suscripción de eventos. | EventSubscriptionDestination |
| filter | Información sobre el filtro de la suscripción de eventos. | EventSubscriptionFilter |
| labels | Lista de etiquetas definidas por el usuario. | string[] |
EventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Establecimiento del tipo de objeto | EventHub WebHook (obligatorio) |
EventHubEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Tipo del punto de conexión para el destino de la suscripción de eventos | 'EventHub' (obligatorio) |
| properties | Propiedades del centro de eventos del destino de la suscripción de eventos | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nombre | Descripción | Value |
|---|---|---|
| resourceId | Identificador de recurso de Azure que representa el punto de conexión de un destino del centro de eventos de una suscripción de eventos. | string |
WebHookEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Tipo del punto de conexión para el destino de la suscripción de eventos | 'WebHook' (obligatorio) |
| properties | Propiedades de webHook del destino de la suscripción de eventos | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nombre | Descripción | Valor |
|---|---|---|
| endpointUrl | Dirección URL que representa el punto de conexión del destino de una suscripción de eventos. | string |
EventSubscriptionFilter
| Nombre | Descripción | Valor |
|---|---|---|
| includedEventTypes | Lista de tipos de eventos aplicables que deben formar parte de la suscripción de eventos. Si se desea suscribirse a todos los tipos de eventos, la cadena "all" debe especificarse como un elemento de esta lista. |
string[] |
| isSubjectCaseSensitive | Especifica si las propiedades SubjectBeginsWith y SubjectEndsWith del filtro debe compararse de una manera que distingue mayúsculas de minúsculas. |
bool |
| subjectBeginsWith | Cadena opcional para filtrar los eventos de una suscripción de eventos en función de un prefijo de ruta de acceso de recurso. El formato de esto depende del publicador de los eventos. No se admiten caracteres comodín en esta ruta de acceso. |
string |
| subjectEndsWith | Cadena opcional para filtrar los eventos de una suscripción de eventos en función de un sufijo de ruta de acceso de recurso. No se admiten caracteres comodín en esta ruta de acceso. |
string |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
| Plantilla | Descripción |
|---|---|
| Crear Azure Event Grid tema personalizado y suscripción |
Crea un Azure Event Grid tema personalizado y una suscripción de webhook. Plantilla originalmente creadas por John Downs. |
| Tema o suscripción de Azure Event Grid personalizados con CloudEvents |
Crea un tema de Azure Event Grid personalizado, una suscripción de webhook que tiene el esquema CloudEvents y una aplicación lógica como controlador de eventos. Plantilla originalmente creadas por Justin Yoo. |
| Creación de un tema personalizado de Event Grid y un controlador del centro de eventos |
Crea un Azure Event Grid tema personalizado y centro de eventos para controlar los eventos. |
| Creación de una suscripción de Event Grid para eventos de recursos |
Crea una suscripción de Event Grid a un grupo de recursos o a una suscripción de Azure. |
| Crear Azure Event Grid tema personalizado y suscripción de cola |
Crea un Azure Event Grid tema personalizado y una suscripción de cola de Service Bus. Plantilla originalmente creadas por Markus Meyer. |
| Crear Azure Event Grid suscripción a temas personalizados |
Crea un Azure Event Grid tema personalizado y una suscripción de tema de Service Bus. Plantilla originalmente creadas por Markus Meyer. |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso eventSubscriptions es un recurso de extensión, lo que significa que puede aplicarlo a otro recurso.
Use la parent_id propiedad de este recurso para establecer el ámbito de este recurso.
El tipo de recurso eventSubscriptions se puede implementar con operaciones destinadas a:
- Grupos de recursos
- Suscripciones
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.EventGrid/eventSubscriptions, agregue el siguiente terraform a la plantilla.
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"
]
}
})
}
Objetos EventSubscriptionDestination
Establezca la propiedad endpointType para especificar el tipo de objeto.
Para EventHub, use:
endpointType = "EventHub"
properties = {
resourceId = "string"
}
Para WebHook, use:
endpointType = "WebHook"
properties = {
endpointUrl = "string"
}
Valores de propiedad
eventSubscriptions
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.EventGrid/eventSubscriptions@2018-01-01" |
| name | El nombre del recurso | string (obligatorio) Límite de caracteres: 3-64 Caracteres válidos: Caracteres alfanuméricos y guiones. |
| parent_id | Identificador del recurso al que se va a aplicar este recurso de extensión. | string (obligatorio) |
| properties | Propiedades de la suscripción de eventos | EventSubscriptionProperties |
EventSubscriptionProperties
| Nombre | Descripción | Valor |
|---|---|---|
| destination | Información sobre el destino donde se deben entregar los eventos para la suscripción de eventos. | EventSubscriptionDestination |
| filter | Información sobre el filtro de la suscripción de eventos. | EventSubscriptionFilter |
| labels | Lista de etiquetas definidas por el usuario. | string[] |
EventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Establecimiento del tipo de objeto | EventHub WebHook (obligatorio) |
EventHubEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Tipo del punto de conexión para el destino de la suscripción de eventos | "EventHub" (obligatorio) |
| properties | Propiedades del centro de eventos del destino de la suscripción de eventos | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nombre | Descripción | Value |
|---|---|---|
| resourceId | Identificador de recurso de Azure que representa el punto de conexión de un destino del centro de eventos de una suscripción de eventos. | string |
WebHookEventSubscriptionDestination
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | Tipo del punto de conexión para el destino de la suscripción de eventos | "WebHook" (obligatorio) |
| properties | Propiedades de webHook del destino de la suscripción de eventos | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nombre | Descripción | Valor |
|---|---|---|
| endpointUrl | Dirección URL que representa el punto de conexión del destino de una suscripción de eventos. | string |
EventSubscriptionFilter
| Nombre | Descripción | Valor |
|---|---|---|
| includedEventTypes | Lista de tipos de eventos aplicables que deben formar parte de la suscripción de eventos. Si desea suscribirse a todos los tipos de eventos, la cadena "all" debe especificarse como un elemento de esta lista. |
string[] |
| isSubjectCaseSensitive | Especifica si las propiedades SubjectBeginsWith y SubjectEndsWith del filtro debe compararse de una manera sensible a mayúsculas y minúsculas. |
bool |
| subjectBeginsWith | Cadena opcional para filtrar eventos de una suscripción de eventos en función de un prefijo de ruta de acceso de recurso. El formato de esto depende del publicador de los eventos. Los caracteres comodín no se admiten en esta ruta de acceso. |
string |
| subjectEndsWith | Cadena opcional para filtrar eventos de una suscripción de eventos en función de un sufijo de ruta de acceso de recurso. Los caracteres comodín no se admiten en esta ruta de acceso. |
string |