Configuração de Aplicativos do Azure como uma origem da Grade de Eventos

  • Artigo

Este artigo fornece as propriedades e o esquema para eventos da Configuração de Aplicativos do Azure. Para obter uma introdução a esquemas de evento, consulte esquema de grade de eventos do Azure. Ele também fornece uma lista de inícios rápidos e de tutoriais para usar a Configuração de Aplicativos do Azure como uma origem de evento.

Tipos de evento disponíveis

A Grade de eventos usa assinaturas de evento para rotear mensagens de evento para os assinantes. A Configuração de Aplicativos do Azure emite os tipos de evento a seguir:

Tipo de evento Descrição
Microsoft.AppConfiguration.KeyValueModified Gerado quando um valor-chave é criado ou substituído.
Microsoft.AppConfiguration.KeyValueDeleted Gerado quando um valor-chave é excluído.
Microsoft.AppConfiguration.SnapshotCreated Gerado quando um instantâneo é criado.
Microsoft.AppConfiguration.SnapshotModified Gerado quando um instantâneo é modificado.

Esquema do evento

Um evento tem os seguintes dados de nível superior:

Propriedade Type Descrição
source string Caminho de recurso completo para a origem do evento. Este campo não é gravável. A Grade de Eventos fornece esse valor.
subject string Caminho definido pelo publicador para o assunto do evento.
type string Um dos tipos de evento registrados para a origem do evento.
time string A hora em que o evento é gerado com base na hora UTC do provedor.
id string Identificador exclusivo do evento.
data objeto Dados de evento da Configuração de Aplicativos.
specversion string Versão de especificação do esquema CloudEvents.

O objeto de dados tem as seguintes propriedades:

Evento chave-valor

Propriedade Type Descrição
key string A chave do valor-chave que foi modificado ou excluído.
label string A etiqueta, se houver, do valor-chave que foi modificado ou excluído.
etag string Para KeyValueModified, a etag do novo valor-chave. Para KeyValueDeleted a etag do valor-chave que foi excluído.
syncToken string O token de sincronização que representa o estado do servidor após o evento chave-valor.

Evento de instantâneo

Propriedade Type Descrição
name string O nome do instantâneo que foi criado ou modificado.
etag string Para SnapshotCreated, a etag do novo instantâneo. Para SnapshotModified, a etag do instantâneo que foi modificado.
syncToken string O token de sincronização que representa o estado do servidor após o evento de instantâneo.

Exemplo de evento

O exemplo a seguir mostra o esquema de um evento de modificação de valor-chave:

[{
  "id": "84e17ea4-66db-4b54-8050-df8f7763f87b",
  "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso",
  "subject": "https://contoso.azconfig.io/kv/Foo?label=FizzBuzz",
  "data": {
    "key": "Foo",
    "label": "FizzBuzz",
    "etag": "FnUExLaj2moIi4tJX9AXn9sakm0"
  },
  "type": "Microsoft.AppConfiguration.KeyValueModified",
  "time": "2019-05-31T20:05:03Z",
  "specversion": "1.0"
}]

O exemplo a seguir mostra o esquema de um evento de exclusão de valor-chave:

[{
  "id": "84e17ea4-66db-4b54-8050-df8f7763f87b",
  "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso",
  "subject": "https://contoso.azconfig.io/kv/Foo?label=FizzBuzz",
  "data": {
    "key": "Foo",
    "label": "FizzBuzz",
    "etag": "FnUExLaj2moIi4tJX9AXn9sakm0"
  },
  "type": "Microsoft.AppConfiguration.KeyValueDeleted",
  "time": "2019-05-31T20:05:03Z",
  "specversion": "1.0"
}]

Veja no exemplo a seguir o esquema de um evento de criação de instantâneo:

[{
  "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso",
  "subject": "https://contoso.azconfig.io/kvsnapshots/Foo",
  "type": "Microsoft.AppConfiguration.SnapshotCreated",
  "time": "2023-09-02T20:05:03.0000000Z",
  "id": "84e17ea4-66db-4b54-8050-df8f7763f87b",
  "data": {
    "name": "Foo",
    "etag": "FnUExLaj2moIi4tJX9AXn9sakm0",
    "syncToken": "zAJw6V16=Njo1IzUxNjQ2NzM=;sn=5164673"
  },
  "specversion": "1.0"
}]

O exemplo a seguir mostra o esquema de um evento de modificação de instantâneo:

[{
  "source": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/microsoft.appconfiguration/configurationstores/contoso",
  "subject": "https://contoso.azconfig.io/snapshots/Foo",
  "type": "Microsoft.AppConfiguration.SnapshotModified",
  "time": "2023-09-03T20:05:03.0000000Z",
  "id": "84e17ea4-66db-4b54-8050-df8f7763f87b",
  "data": {
    "name": "Foo",
    "etag": "FnUExLaj2moIi4tJX9AXn9sakm0",
    "syncToken": "zAJw6V16=Njo1IzUxNjQ2NzM=;sn=5164673"
  },
  "specversion": "1.0"
}]

Tutoriais e guias de instruções

Título Descrição
Reagir a eventos da Configuração de Aplicativos do Azure usando a Grade de Eventos Visão geral da integração da Configuração de Aplicativos do Azure com a Grade de Eventos.
Usar a Grade de Eventos para notificações de alteração de dados Saiba como usar assinaturas de eventos da Configuração de Aplicativos do Azure para enviar eventos de modificação de chave-valor para um ponto de extremidade da Web.

Próximas etapas