Microsoft.EventGrid eventSubscriptions 2018-01-01
- última
- 2024-12-15-preview
- 2024-06-01-preview
- 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
Definição de recurso do Bicep
O tipo de recurso eventSubscriptions pode ser implantado com operações de destino:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o Bicep a seguir ao modelo.
resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2018-01-01' = {
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'
]
}
}
Objetos EventSubscriptionDestination
Defina a propriedade endpointType para especificar o tipo de objeto.
Para do EventHub, use:
{
endpointType: 'EventHub'
properties: {
resourceId: 'string'
}
}
Para webhook, use:
{
endpointType: 'WebHook'
properties: {
endpointUrl: 'string'
}
}
Valores de propriedade
EventHubEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura do evento | 'EventHub' (obrigatório) |
| Propriedades | Propriedades do Hub de Eventos do destino da assinatura de evento | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento. | corda |
EventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Defina como 'EventHub' para o tipo EventHubEventSubscriptionDestination. Defina como 'WebHook' para o tipo WebHookEventSubscriptionDestination. | 'EventHub' 'WebHook' (obrigatório) |
EventSubscriptionFilter
| Nome | Descrição | Valor |
|---|---|---|
| includedEventTypes | Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento, a cadeia de caracteres "todos" precisará ser especificada como um elemento nesta lista. |
string[] |
| isSubjectCaseSensitive | Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de maneira sensível a maiúsculas de minúsculas. |
Bool |
| subjectBeginsWith | Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato disso depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho. |
corda |
| subjectEndsWith | Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho. |
corda |
EventSubscriptionProperties
| Nome | Descrição | Valor |
|---|---|---|
| destino | Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. | eventSubscriptionDestination |
| filtro | Informações sobre o filtro da assinatura do evento. | EventSubscriptionFilter |
| Rótulos | Lista de rótulos definidos pelo usuário. | string[] |
Microsoft.EventGrid/eventSubscriptions
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | cadeia de caracteres (obrigatório) |
| Propriedades | Propriedades da assinatura do evento | EventSubscriptionProperties |
| âmbito | Use ao criar um recurso em um escopo diferente do escopo de implantação. | Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão . |
WebHookEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura do evento | 'WebHook' (obrigatório) |
| Propriedades | Propriedades do WebHook do destino da assinatura do evento | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| endpointUrl | A URL que representa o ponto de extremidade do destino de uma assinatura de evento. | corda |
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
| Arquivo Bicep | Descrição |
|---|---|
| criar o tópico personalizado da Grade de Eventos do Azure e a assinatura da fila | Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de fila do barramento de serviço. Modelo originalmente criado por Markus Meyer. |
| Criar tópico personalizado e de assinatura da Grade de Eventos do Azure | Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de webhook. Modelo originalmente criado por John Downs. |
Definição de recurso de modelo do ARM
O tipo de recurso eventSubscriptions pode ser implantado com operações de destino:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.EventGrid/eventSubscriptions",
"apiVersion": "2018-01-01",
"name": "string",
"properties": {
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"filter": {
"includedEventTypes": [ "string" ],
"isSubjectCaseSensitive": "bool",
"subjectBeginsWith": "string",
"subjectEndsWith": "string"
},
"labels": [ "string" ]
}
}
Objetos EventSubscriptionDestination
Defina a propriedade endpointType para especificar o tipo de objeto.
Para do EventHub, use:
{
"endpointType": "EventHub",
"properties": {
"resourceId": "string"
}
}
Para webhook, use:
{
"endpointType": "WebHook",
"properties": {
"endpointUrl": "string"
}
}
Valores de propriedade
EventHubEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura do evento | 'EventHub' (obrigatório) |
| Propriedades | Propriedades do Hub de Eventos do destino da assinatura de evento | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento. | corda |
EventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Defina como 'EventHub' para o tipo EventHubEventSubscriptionDestination. Defina como 'WebHook' para o tipo WebHookEventSubscriptionDestination. | 'EventHub' 'WebHook' (obrigatório) |
EventSubscriptionFilter
| Nome | Descrição | Valor |
|---|---|---|
| includedEventTypes | Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento, a cadeia de caracteres "todos" precisará ser especificada como um elemento nesta lista. |
string[] |
| isSubjectCaseSensitive | Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de maneira sensível a maiúsculas de minúsculas. |
Bool |
| subjectBeginsWith | Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato disso depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho. |
corda |
| subjectEndsWith | Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho. |
corda |
EventSubscriptionProperties
| Nome | Descrição | Valor |
|---|---|---|
| destino | Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. | eventSubscriptionDestination |
| filtro | Informações sobre o filtro da assinatura do evento. | EventSubscriptionFilter |
| Rótulos | Lista de rótulos definidos pelo usuário. | string[] |
Microsoft.EventGrid/eventSubscriptions
| Nome | Descrição | Valor |
|---|---|---|
| apiVersion | A versão da API | '2018-01-01' |
| nome | O nome do recurso | cadeia de caracteres (obrigatório) |
| Propriedades | Propriedades da assinatura do evento | EventSubscriptionProperties |
| tipo | O tipo de recurso | 'Microsoft.EventGrid/eventSubscriptions' |
WebHookEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura do evento | 'WebHook' (obrigatório) |
| Propriedades | Propriedades do WebHook do destino da assinatura do evento | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| endpointUrl | A URL que representa o ponto de extremidade do destino de uma assinatura de evento. | corda |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
criar o tópico personalizado da Grade de Eventos do Azure e a assinatura da fila
|
Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de fila do barramento de serviço. Modelo originalmente criado por Markus Meyer. |
|
Criar tópico personalizado e de assinatura da Grade de Eventos do Azure
|
Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de webhook. Modelo originalmente criado por John Downs. |
|
criar assinatura de tópico personalizado da Grade de Eventos do Azure
|
Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de tópico do barramento de serviço. Modelo originalmente criado por Markus Meyer. |
|
criar o tópico personalizado da Grade de Eventos e o manipulador do hub de eventos
|
Cria um tópico personalizado da Grade de Eventos do Azure e um hub de eventos para lidar com os eventos. |
|
criar assinatura da Grade de Eventos para eventos de recurso
|
Cria uma assinatura da Grade de Eventos para o grupo de recursos ou a assinatura do Azure. |
|
tópico/assinatura personalizado da Grade de Eventos do Azure com o CloudEvents
|
Cria um tópico personalizado da Grade de Eventos do Azure, uma assinatura de webhook com esquema CloudEvents e um Aplicativo Lógico como manipulador de eventos. Modelo originalmente criado por Justin Yoo. |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso eventSubscriptions pode ser implantado com operações de destino:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o Terraform a seguir ao seu modelo.
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
Defina a propriedade endpointType para especificar o tipo de objeto.
Para do EventHub, use:
{
endpointType = "EventHub"
properties = {
resourceId = "string"
}
}
Para webhook, use:
{
endpointType = "WebHook"
properties = {
endpointUrl = "string"
}
}
Valores de propriedade
EventHubEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura do evento | 'EventHub' (obrigatório) |
| Propriedades | Propriedades do Hub de Eventos do destino da assinatura de evento | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| resourceId | A ID de Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento. | corda |
EventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Defina como 'EventHub' para o tipo EventHubEventSubscriptionDestination. Defina como 'WebHook' para o tipo WebHookEventSubscriptionDestination. | 'EventHub' 'WebHook' (obrigatório) |
EventSubscriptionFilter
| Nome | Descrição | Valor |
|---|---|---|
| includedEventTypes | Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento, a cadeia de caracteres "todos" precisará ser especificada como um elemento nesta lista. |
string[] |
| isSubjectCaseSensitive | Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de maneira sensível a maiúsculas de minúsculas. |
Bool |
| subjectBeginsWith | Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato disso depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho. |
corda |
| subjectEndsWith | Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho. |
corda |
EventSubscriptionProperties
| Nome | Descrição | Valor |
|---|---|---|
| destino | Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. | eventSubscriptionDestination |
| filtro | Informações sobre o filtro da assinatura do evento. | EventSubscriptionFilter |
| Rótulos | Lista de rótulos definidos pelo usuário. | string[] |
Microsoft.EventGrid/eventSubscriptions
| Nome | Descrição | Valor |
|---|---|---|
| nome | O nome do recurso | cadeia de caracteres (obrigatório) |
| parent_id | A ID do recurso ao qual aplicar esse recurso de extensão. | cadeia de caracteres (obrigatório) |
| Propriedades | Propriedades da assinatura do evento | EventSubscriptionProperties |
| tipo | O tipo de recurso | "Microsoft.EventGrid/eventSubscriptions@2018-01-01" |
WebHookEventSubscriptionDestination
| Nome | Descrição | Valor |
|---|---|---|
| endpointType | Tipo do ponto de extremidade para o destino da assinatura do evento | 'WebHook' (obrigatório) |
| Propriedades | Propriedades do WebHook do destino da assinatura do evento | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Nome | Descrição | Valor |
|---|---|---|
| endpointUrl | A URL que representa o ponto de extremidade do destino de uma assinatura de evento. | corda |