backup_engines

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

Overview

Name	backup_engines
Type	Resource
Id	azure.recovery_services_backup.backup_engines

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.
azureBackupAgentVersion	string	Backup agent version.
backupEngineId	string	ID of the backup engine.
backupEngineState	string	Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}.
backupEngineType	string	Type of the backup engine. Required. Known values are: "Invalid", "DpmBackupEngine", and "AzureBackupServerEngine".
backupManagementType	string	Type of backup management for the backup engine. Known values are: "Invalid", "AzureIaasVM", "MAB", "DPM", "AzureBackupServer", "AzureSql", "AzureStorage", "AzureWorkload", and "DefaultBackup". (Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup)
canReRegister	boolean	Flag indicating if the backup engine be registered, once already registered.
dpmVersion	string	Backup engine version.
eTag	string	Optional ETag.
extendedInfo	object	Extended info of the backupengine.
friendlyName	string	Friendly name of the backup engine.
healthStatus	string	Backup status of the backup engine.
isAzureBackupAgentUpgradeAvailable	boolean	To check if backup agent upgrade available.
isDpmUpgradeAvailable	boolean	To check if backup engine upgrade available.
location	string	The geo-location where the resource lives.
registrationStatus	string	Registration status of the backup engine with the Recovery Services Vault.
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".

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.
azureBackupAgentVersion	string	Backup agent version.
backupEngineId	string	ID of the backup engine.
backupEngineState	string	Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}.
backupEngineType	string	Type of the backup engine. Required. Known values are: "Invalid", "DpmBackupEngine", and "AzureBackupServerEngine".
backupManagementType	string	Type of backup management for the backup engine. Known values are: "Invalid", "AzureIaasVM", "MAB", "DPM", "AzureBackupServer", "AzureSql", "AzureStorage", "AzureWorkload", and "DefaultBackup". (Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup)
canReRegister	boolean	Flag indicating if the backup engine be registered, once already registered.
dpmVersion	string	Backup engine version.
eTag	string	Optional ETag.
extendedInfo	object	Extended info of the backupengine.
friendlyName	string	Friendly name of the backup engine.
healthStatus	string	Backup status of the backup engine.
isAzureBackupAgentUpgradeAvailable	boolean	To check if backup agent upgrade available.
isDpmUpgradeAvailable	boolean	To check if backup engine upgrade available.
location	string	The geo-location where the resource lives.
registrationStatus	string	Registration status of the backup engine with the Recovery Services Vault.
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
get	select	vault_name, resource_group_name, backup_engine_name, subscription_id	$filter, $skipToken	Returns backup management server registered to Recovery Services Vault.
list	select	vault_name, resource_group_name, subscription_id	$filter, $skipToken	Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.

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
backup_engine_name	string	Name of the backup management server. 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

get

Returns backup management server registered to Recovery Services Vault.

SELECT
id,
name,
azureBackupAgentVersion,
backupEngineId,
backupEngineState,
backupEngineType,
backupManagementType,
canReRegister,
dpmVersion,
eTag,
extendedInfo,
friendlyName,
healthStatus,
isAzureBackupAgentUpgradeAvailable,
isDpmUpgradeAvailable,
location,
registrationStatus,
systemData,
tags,
type
FROM azure.recovery_services_backup.backup_engines
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND backup_engine_name = '{{ backup_engine_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $skipToken = '{{ $skipToken }}'
;

list

Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.

SELECT
id,
name,
azureBackupAgentVersion,
backupEngineId,
backupEngineState,
backupEngineType,
backupManagementType,
canReRegister,
dpmVersion,
eTag,
extendedInfo,
friendlyName,
healthStatus,
isAzureBackupAgentUpgradeAvailable,
isDpmUpgradeAvailable,
location,
registrationStatus,
systemData,
tags,
type
FROM azure.recovery_services_backup.backup_engines
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $skipToken = '{{ $skipToken }}'
;