Muokkaa

Jaa

Azure Cache for Redis as an Event Grid source

  • Artikkeli

This article provides the properties and schema for Azure Cache for Redis events. For an introduction to event schemas, see Azure Event Grid event schema.

Available event types

These events are triggered when a client exports, imports, or scales by calling Azure Cache for Redis REST APIs. Patching event is triggered by Redis update.

Event name Description
Microsoft.Cache.ExportRDBCompleted Triggered when cache data is exported.
Microsoft.Cache.ImportRDBCompleted Triggered when cache data is imported.
Microsoft.Cache.PatchingCompleted Triggered when patching is completed.
Microsoft.Cache.ScalingCompleted Triggered when scaling is completed.

Example event

When an event is triggered, the Event Grid service sends data about that event to subscribing endpoint. This section contains an example of what that data would look like for each Azure Cache for Redis event.

Microsoft.Cache.PatchingCompleted event

[{
	"id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b",
	"type": "Microsoft.Cache.PatchingCompleted",
	"source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Cache/Redis/{cache_name}",
	"data": {
		"name": "PatchingCompleted",
		"timestamp": "2020-12-09T21:50:19.9995668+00:00",
		"status": "Succeeded"
	},
	"subject": "PatchingCompleted",
	"time": "2020-12-09T21:50:19.9995668+00:00",
    "specversion": "1.0"
}]

Microsoft.Cache.ImportRDBCompleted event

[{
	"id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b",
	"type": "Microsoft.Cache.ImportRDBCompleted",
	"source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Cache/Redis/{cache_name}",
	"data": {
		"name": "ImportRDBCompleted",
		"timestamp": "2020-12-09T21:50:19.9995668+00:00",
		"status": "Succeeded"
	},
	"subject": "ImportRDBCompleted",
	"eventTime": "2020-12-09T21:50:19.9995668+00:00",
	"specversion": "1.0"
}]

Microsoft.Cache.ExportRDBCompleted event

[{
	"id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b",
	"type": "Microsoft.Cache.ExportRDBCompleted",
	"source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Cache/Redis/{cache_name}",
	"data": {
		"name": "ExportRDBCompleted",
		"timestamp": "2020-12-09T21:50:19.9995668+00:00",
		"status": "Succeeded"
	},
	"subject": "ExportRDBCompleted",
	"time": "2020-12-09T21:50:19.9995668+00:00",
	"specversion": "1.0"
}]

Microsoft.Cache.ScalingCompleted

[{
	"id": "9b87886d-21a5-4af5-8e3e-10c4b8dac73b",
	"type": "Microsoft.Cache.ScalingCompleted",
	"source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Cache/Redis/{cache_name}",
	"data": {
		"name": "ScalingCompleted",
		"timestamp": "2020-12-09T21:50:19.9995668+00:00",
		"status": "Succeeded"
	},
	"subject": "ScalingCompleted",
	"time": "2020-12-09T21:50:19.9995668+00:00",
	"specversion": "1.0"
}]

Event properties

An event has the following top-level data:

Property Type Description
source string Full resource path to the event source. This field isn't writeable. Event Grid provides this value.
subject string Publisher-defined path to the event subject.
type string One of the registered event types for this event source.
time string The time the event is generated based on the provider's UTC time.
id string Unique identifier for the event.
data object Azure Cache for Redis event data.
specversion string CloudEvents schema specification version.

The data object has the following properties:

Property Type Description
timestamp string The time when the event occurred.
name string The name of the event.
status string The status of the event. Failed or succeeded.

Quickstarts

If you want to try Azure Cache for Redis events, see any of these quickstart articles:

If you want to use this tool: See this article:
Azure portal Quickstart: Route Azure Cache for Redis events to web endpoint with the Azure portal
PowerShell Quickstart: Route Azure Cache for Redis events to web endpoint with PowerShell
Azure CLI Quickstart: Route Azure Cache for Redis events to web endpoint with Azure CLI

Next steps