protected_items

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

Overview

Name	protected_items
Type	Resource
Id	azure_isv.commvaultcontentstore.protected_items

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.
lastBackUpTime	integer	The Commvault Protected Item backup time. Required.
location	string	The location of the protected item. Required.
resourceGroup	string	The resource group of the protected item. Required.
resourceName	string	The Name of the commvault protected item. Required.
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".
vmGuid	string	The GUID of VM. Required.

list_by_protection_group

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.
lastBackUpTime	integer	The Commvault Protected Item backup time. Required.
location	string	The location of the protected item. Required.
resourceGroup	string	The resource group of the protected item. Required.
resourceName	string	The Name of the commvault protected item. Required.
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".
vmGuid	string	The GUID of VM. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cloud_account_name, protection_group_name, protected_item_name, subscription_id		Get a ProtectedItem.
list_by_protection_group	select	resource_group_name, cloud_account_name, protection_group_name, subscription_id		List ProtectedItem resources by ProtectionGroup.
get_restore_points	exec	resource_group_name, cloud_account_name, protection_group_name, protected_item_name, subscription_id		Limits used for creation of resources.
restore	exec	resource_group_name, cloud_account_name, protection_group_name, protected_item_name, subscription_id, inPlaceRestore, vmDestinationInfo		Restore resource for a protected item.

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
cloud_account_name	string	Name of the Cloud Account resource. Required.
protected_item_name	string	The protectedItem Id, name of 2 protected items can be same under a PG if they belong to different resource group or even different data source types VM/DB/AKS, etc; and name is mandatory in Azure Typespec, hence using name parameter for id in Commvault In case of Vm it will be vmGuid. Required.
protection_group_name	string	Name of the ProtectionGroup resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a ProtectedItem.

SELECT
id,
name,
lastBackUpTime,
location,
resourceGroup,
resourceName,
systemData,
type,
vmGuid
FROM azure_isv.commvaultcontentstore.protected_items
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_account_name = '{{ cloud_account_name }}' -- required
AND protection_group_name = '{{ protection_group_name }}' -- required
AND protected_item_name = '{{ protected_item_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_protection_group

List ProtectedItem resources by ProtectionGroup.

SELECT
id,
name,
lastBackUpTime,
location,
resourceGroup,
resourceName,
systemData,
type,
vmGuid
FROM azure_isv.commvaultcontentstore.protected_items
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_account_name = '{{ cloud_account_name }}' -- required
AND protection_group_name = '{{ protection_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

get_restore_points

Limits used for creation of resources.

EXEC azure_isv.commvaultcontentstore.protected_items.get_restore_points 
@resource_group_name='{{ resource_group_name }}' --required, 
@cloud_account_name='{{ cloud_account_name }}' --required, 
@protection_group_name='{{ protection_group_name }}' --required, 
@protected_item_name='{{ protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

restore

Restore resource for a protected item.

EXEC azure_isv.commvaultcontentstore.protected_items.restore 
@resource_group_name='{{ resource_group_name }}' --required, 
@cloud_account_name='{{ cloud_account_name }}' --required, 
@protection_group_name='{{ protection_group_name }}' --required, 
@protected_item_name='{{ protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"inPlaceRestore": {{ inPlaceRestore }}, 
"restoreType": "{{ restoreType }}", 
"toTime": "{{ toTime }}", 
"vmDestinationInfo": "{{ vmDestinationInfo }}"
}'
;