RecoveryServicesBackupExtensions.GetBackupEngine Method

Definition

Namespace:

Azure.ResourceManager.RecoveryServicesBackup

Assembly:

Azure.ResourceManager.RecoveryServicesBackup.dll

Package:

Azure.ResourceManager.RecoveryServicesBackup v1.2.0

Source:

RecoveryServicesBackupExtensions.cs

Returns backup management server registered to Recovery Services Vault.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines/{backupEngineName}
• Operation Id: BackupEngines_Get

public static Azure.Response<Azure.ResourceManager.RecoveryServicesBackup.BackupEngineResource> GetBackupEngine (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string vaultName, string backupEngineName, string filter = default, string skipToken = default, System.Threading.CancellationToken cancellationToken = default);

static member GetBackupEngine : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.RecoveryServicesBackup.BackupEngineResource>

<Extension()>
Public Function GetBackupEngine (resourceGroupResource As ResourceGroupResource, vaultName As String, backupEngineName As String, Optional filter As String = Nothing, Optional skipToken As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BackupEngineResource)

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

vaultName

String

The name of the recovery services vault.

backupEngineName

String

Name of the backup management server.

filter

String

OData filter options.

skipToken

String

skipToken Filter.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<BackupEngineResource>

Exceptions

ArgumentNullException

resourceGroupResource, vaultName or backupEngineName is null.

ArgumentException

vaultName or backupEngineName is an empty string, and was expected to be non-empty.