backup_workload_items

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

Overview

Name	backup_workload_items
Type	Resource
Id	azure.recovery_services_backup.backup_workload_items

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	Type of backup management to backup an item.
eTag	string	Optional ETag.
friendlyName	string	Friendly name of the backup item.
location	string	Resource location.
protectionState	string	State of the back up item. Known values are: "Invalid", "NotProtected", "Protecting", "Protected", and "ProtectionFailed". (Invalid, NotProtected, Protecting, Protected, ProtectionFailed)
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".
workloadItemType	string	Type of the backup item. Required. Default value is None.
workloadType	string	Type of workload for the backup management.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	vault_name, resource_group_name, fabric_name, container_name, subscription_id	$filter, $skipToken	Provides a pageable list of workload item of a specific container according to the query filter and the pagination parameters.

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
container_name	string	Name of the container whose details need to be fetched. Required.
fabric_name	string	The name of the BackupFabricResource. Required.
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.
$skipToken	string	skipToken Filter. Default value is None.

SELECT examples

list

Provides a pageable list of workload item of a specific container according to the query filter and the pagination parameters.

SELECT
id,
name,
backupManagementType,
eTag,
friendlyName,
location,
protectionState,
systemData,
tags,
type,
workloadItemType,
workloadType
FROM azure.recovery_services_backup.backup_workload_items
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND container_name = '{{ container_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $skipToken = '{{ $skipToken }}'
;