replication_vault_health

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

Overview

Name	replication_vault_health
Type	Resource
Id	azure.recovery_services_site_recovery.replication_vault_health

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.
containersHealth	object	The list of the health detail of the containers in the vault.
fabricsHealth	object	The list of the health detail of the fabrics in the vault.
location	string	Resource Location.
protectedItemsHealth	object	The list of the health detail of the protected items in the vault.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vaultErrors	array	The list of errors on the vault.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, subscription_id		Gets the health summary for the vault. Gets the health details of the vault.
refresh	exec	resource_group_name, resource_name, subscription_id		Refreshes health summary of the vault. Refreshes health summary of 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the recovery services vault. Required.
subscription_id	string

SELECT examples

get

Gets the health summary for the vault. Gets the health details of the vault.

SELECT
id,
name,
containersHealth,
fabricsHealth,
location,
protectedItemsHealth,
systemData,
type,
vaultErrors
FROM azure.recovery_services_site_recovery.replication_vault_health
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

refresh

Refreshes health summary of the vault. Refreshes health summary of the vault.

EXEC azure.recovery_services_site_recovery.replication_vault_health.refresh 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;