protected_items

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

Overview

Name	protected_items
Type	Resource
Id	azure.recovery_services_backup.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
properties	object	ProtectedItemResource properties
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	vaultName, resourceGroupName, subscriptionId, fabricName, containerName, protectedItemName	api-version, $filter	Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
create_or_update	insert	vaultName, resourceGroupName, subscriptionId, fabricName, containerName, protectedItemName	api-version, x-ms-authorization-auxiliary	Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
delete	delete	vaultName, resourceGroupName, subscriptionId, fabricName, containerName, protectedItemName	api-version	Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.

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
containerName	string	Container name associated with the backed up item.
fabricName	string	Fabric name associated with the backed up item.
protectedItemName	string	Backed up item to be deleted.
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
subscriptionId	string	The subscription Id.
vaultName	string	The name of the recovery services vault.
$filter	string	OData filter options.
api-version	string	Client Api Version.
x-ms-authorization-auxiliary	string

SELECT examples

get

Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,
call the GetItemOperationResult API.

SELECT
id,
name,
properties,
type
FROM azure.recovery_services_backup.protected_items
WHERE vaultName = '{{ vaultName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND fabricName = '{{ fabricName }}' -- required
AND containerName = '{{ containerName }}' -- required
AND protectedItemName = '{{ protectedItemName }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an
asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

INSERT INTO azure.recovery_services_backup.protected_items (
data__properties,
vaultName,
resourceGroupName,
subscriptionId,
fabricName,
containerName,
protectedItemName,
api-version,
x-ms-authorization-auxiliary
)
SELECT 
'{{ properties }}',
'{{ vaultName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ fabricName }}',
'{{ containerName }}',
'{{ protectedItemName }}',
'{{ api-version }}',
'{{ x-ms-authorization-auxiliary }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: protected_items
  props:
    - name: vaultName
      value: string
      description: Required parameter for the protected_items resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the protected_items resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the protected_items resource.
    - name: fabricName
      value: string
      description: Required parameter for the protected_items resource.
    - name: containerName
      value: string
      description: Required parameter for the protected_items resource.
    - name: protectedItemName
      value: string
      description: Required parameter for the protected_items resource.
    - name: properties
      value: object
      description: |
        ProtectedItemResource properties
    - name: api-version
      value: string
      description: Client Api Version.
    - name: x-ms-authorization-auxiliary
      value: string

DELETE examples

delete

Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the
request, call the GetItemOperationResult API.

DELETE FROM azure.recovery_services_backup.protected_items
WHERE vaultName = '{{ vaultName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND fabricName = '{{ fabricName }}' --required
AND containerName = '{{ containerName }}' --required
AND protectedItemName = '{{ protectedItemName }}' --required
AND api-version = '{{ api-version }}'
;