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	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The vault health related data.
type	string	Resource Type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceName, resourceGroupName, subscriptionId	api-version	Gets the health details of the vault.
refresh	exec	resourceName, resourceGroupName, subscriptionId	api-version

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
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
resourceName	string	The name of the recovery services vault.
subscriptionId	string	The subscription Id.
api-version	string	Client Api Version.

SELECT examples

get

Gets the health details of the vault.

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_vault_health
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

refresh

OK

EXEC azure.recovery_services_site_recovery.replication_vault_health.refresh 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@api-version='{{ api-version }}'
;