replication_events

Creates, updates, deletes, gets or lists a replication_events resource.

Overview

Name	replication_events
Type	Resource
Id	azure.recovery_services_site_recovery.replication_events

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.
affectedObjectCorrelationId	string	The affected object correlationId for the event.
affectedObjectFriendlyName	string	The friendly name of the source of the event on which it is raised (for example, VM, VMM etc).
description	string	The event name.
eventCode	string	The Id of the monitoring event.
eventSpecificDetails	object	The event specific settings.
eventType	string	The type of the event. for example: VM Health, Server Health, Job Failure etc.
fabricId	string	The ARM ID of the fabric.
healthErrors	array	The list of errors / warnings capturing details associated with the issue(s).
location	string	Resource Location.
providerSpecificDetails	object	The provider specific settings.
severity	string	The severity of the event.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeOfOccurrence	string (date-time)	The time of occurrence of the event.
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.
affectedObjectCorrelationId	string	The affected object correlationId for the event.
affectedObjectFriendlyName	string	The friendly name of the source of the event on which it is raised (for example, VM, VMM etc).
description	string	The event name.
eventCode	string	The Id of the monitoring event.
eventSpecificDetails	object	The event specific settings.
eventType	string	The type of the event. for example: VM Health, Server Health, Job Failure etc.
fabricId	string	The ARM ID of the fabric.
healthErrors	array	The list of errors / warnings capturing details associated with the issue(s).
location	string	Resource Location.
providerSpecificDetails	object	The provider specific settings.
severity	string	The severity of the event.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeOfOccurrence	string (date-time)	The time of occurrence of the event.
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, resource_name, event_name, subscription_id		Get the details of an Azure Site recovery event. The operation to get the details of an Azure Site recovery event.
list	select	resource_group_name, resource_name, subscription_id	$filter	Gets the list of Azure Site Recovery events. Gets the list of Azure Site Recovery events for the 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 name of the Azure Site Recovery event. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the Vault. Required.
subscription_id	string
$filter	string	OData filter options. Default value is None.

SELECT examples

get

Get the details of an Azure Site recovery event. The operation to get the details of an Azure Site recovery event.

SELECT
id,
name,
affectedObjectCorrelationId,
affectedObjectFriendlyName,
description,
eventCode,
eventSpecificDetails,
eventType,
fabricId,
healthErrors,
location,
providerSpecificDetails,
severity,
systemData,
timeOfOccurrence,
type
FROM azure.recovery_services_site_recovery.replication_events
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND event_name = '{{ event_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of Azure Site Recovery events. Gets the list of Azure Site Recovery events for the vault.

SELECT
id,
name,
affectedObjectCorrelationId,
affectedObjectFriendlyName,
description,
eventCode,
eventSpecificDetails,
eventType,
fabricId,
healthErrors,
location,
providerSpecificDetails,
severity,
systemData,
timeOfOccurrence,
type
FROM azure.recovery_services_site_recovery.replication_events
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;