AppConfiguration.json

{
  "swagger": "2.0",
  "info": {
    "version": "2018-01-01",
    "title": "Schema of Azure App Configuration events published to Azure Event Grid",
    "description": "Describes the schema of the Azure App Configuration events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent."
  },
  "paths": {},
  "definitions": {
    "AppConfigurationKeyValueModifiedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueModified event.",
      "type": "object",
      "properties": {
        "key": {
          "description": "The key used to identify the key-value that was modified.",
          "type": "string"
        },
        "label": {
          "description": "The label, if any, used to identify the key-value that was modified.",
          "type": "string"
        },
        "etag": {
          "description": "The etag representing the new state of the key-value.",
          "type": "string"
        },
        "syncToken": {
          "description": "The sync token representing the server state after the event.",
          "type": "string"
        }
      }
    },
    "AppConfigurationKeyValueDeletedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueDeleted event.",
      "type": "object",
      "properties": {
        "key": {
          "description": "The key used to identify the key-value that was deleted.",
          "type": "string"
        },
        "label": {
          "description": "The label, if any, used to identify the key-value that was deleted.",
          "type": "string"
        },
        "etag": {
          "description": "The etag representing the key-value that was deleted.",
          "type": "string"
        },
        "syncToken": {
          "description": "The sync token representing the server state after the event.",
          "type": "string"
        }
      }
    },
    "AppConfigurationSnapshotEventData": {
      "description": "Schema of common properties of snapshot events",
      "type": "object",
      "properties": {
        "name": {
          "description": "The name of the snapshot.",
          "type": "string"
        },
        "etag": {
          "description": "The etag representing the new state of the snapshot.",
          "type": "string"
        },
        "syncToken": {
          "description": "The sync token representing the server state after the event.",
          "type": "string"
        }
      }
    },
    "AppConfigurationSnapshotCreatedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotCreated event.",
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/AppConfigurationSnapshotEventData"
        }
      ],
      "x-ms-examples": {
        "snapshotCreatedCloudEventsSchema": {
          "$ref": "./examples/cloud-events-schema/snapshot_created.json"
        },
        "snapshotCreatedEventGridSchema": {
          "$ref": "./examples/event-grid-schema/snapshot_created.json"
        }
      }
    },
    "AppConfigurationSnapshotModifiedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotModified event.",
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/AppConfigurationSnapshotEventData"
        }
      ],
      "x-ms-examples": {
        "snapshotModifiedCloudEventsSchema": {
          "$ref": "./examples/cloud-events-schema/snapshot_modified.json"
        },
        "snapshotModifiedEventGridSchema": {
          "$ref": "./examples/event-grid-schema/snapshot_modified.json"
        }
      }
    }
  }
}