RecoveryServicesBackupExtensions.GetBackupEngineAsync Method

Definition

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 System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.RecoveryServicesBackup.BackupEngineResource>> GetBackupEngineAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string vaultName, string backupEngineName, string filter = default, string skipToken = default, System.Threading.CancellationToken cancellationToken = default);
static member GetBackupEngineAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.RecoveryServicesBackup.BackupEngineResource>>
<Extension()>
Public Function GetBackupEngineAsync (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 Task(Of 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

Exceptions

resourceGroupResource, vaultName or backupEngineName is null.

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

Applies to