event

Creates, updates, deletes, gets or lists an event resource.

Overview

Name	event
Type	Resource
Id	azure.recovery_services_data_replication.event

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
correlationId	string	Gets or sets the event correlation Id.
customProperties	object	Event model custom properties. Required.
description	string	Gets or sets the event description.
eventName	string	Gets or sets the event name.
eventType	string	Gets or sets the event type.
healthErrors	array	Gets or sets the errors associated with this event.
provisioningState	string	Gets or sets the provisioning state of the event. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
resourceName	string	Gets or sets the resource name.
resourceType	string	Gets or sets the resource type.
severity	string	Gets or sets the event severity.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeOfOccurrence	string (date-time)	Gets or sets the time at which the event occurred at source.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
correlationId	string	Gets or sets the event correlation Id.
customProperties	object	Event model custom properties. Required.
description	string	Gets or sets the event description.
eventName	string	Gets or sets the event name.
eventType	string	Gets or sets the event type.
healthErrors	array	Gets or sets the errors associated with this event.
provisioningState	string	Gets or sets the provisioning state of the event. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
resourceName	string	Gets or sets the resource name.
resourceType	string	Gets or sets the resource type.
severity	string	Gets or sets the event severity.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeOfOccurrence	string (date-time)	Gets or sets the time at which the event occurred at source.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vault_name, event_name, subscription_id		Gets the details of the event.
list	select	resource_group_name, vault_name, subscription_id	odataOptions, continuationToken, pageSize	Gets the list of events in the given vault.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
event_name	string	The event name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The vault name. Required.
continuationToken	string	Continuation token. Default value is None.
odataOptions	string	OData options. Default value is None.
pageSize	integer	Page size. Default value is None.

SELECT examples

get

Gets the details of the event.

SELECT
id,
name,
correlationId,
customProperties,
description,
eventName,
eventType,
healthErrors,
provisioningState,
resourceName,
resourceType,
severity,
systemData,
timeOfOccurrence,
type
FROM azure.recovery_services_data_replication.event
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND event_name = '{{ event_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of events in the given vault.

SELECT
id,
name,
correlationId,
customProperties,
description,
eventName,
eventType,
healthErrors,
provisioningState,
resourceName,
resourceType,
severity,
systemData,
timeOfOccurrence,
type
FROM azure.recovery_services_data_replication.event
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND odataOptions = '{{ odataOptions }}'
AND continuationToken = '{{ continuationToken }}'
AND pageSize = '{{ pageSize }}'
;