backup_policies

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

Overview

Name	backup_policies
Type	Resource
Id	azure.recovery_services_backup.backup_policies

Fields

The following fields are returned by SELECT queries:

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.
backupManagementType	string	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. Required. Default value is None.
eTag	string	Optional ETag.
location	string	The geo-location where the resource lives.
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	array	ResourceGuard Operation Requests.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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
list	select	vault_name, resource_group_name, subscription_id	$filter	Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch scoped results.

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.
subscription_id	string
vault_name	string	The name of the VaultResource. Required.
$filter	string	OData filter options. Default value is None.

SELECT examples

list

Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch scoped results.

SELECT
id,
name,
backupManagementType,
eTag,
location,
protectedItemsCount,
resourceGuardOperationRequests,
systemData,
tags,
type
FROM azure.recovery_services_backup.backup_policies
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;