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
properties	object	BackupEngineBaseResource properties
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
properties	object	BackupEngineBaseResource 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, backupEngineName	api-version, $filter, $skipToken	Returns backup management server registered to Recovery Services Vault.
list	select	vaultName, resourceGroupName, subscriptionId	api-version, $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
backupEngineName	string	Name of the backup management server.
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.
$skipToken	string	skipToken Filter.
api-version	string	Client Api Version.

SELECT examples

get

Returns backup management server registered to Recovery Services Vault.

SELECT
id,
name,
properties,
type
FROM azure.recovery_services_backup.backup_engines
WHERE vaultName = '{{ vaultName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND backupEngineName = '{{ backupEngineName }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
AND $skipToken = '{{ $skipToken }}'
;

list

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

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