RecoveryServicesBackupExtensions.GetBackupProtectedItemsAsync Method

Definition

Namespace:

Azure.ResourceManager.RecoveryServicesBackup

Assembly:

Azure.ResourceManager.RecoveryServicesBackup.dll

Package:

Azure.ResourceManager.RecoveryServicesBackup v1.2.0

Source:

RecoveryServicesBackupExtensions.cs

Provides a pageable list of all items that are backed up within a vault.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems
• Operation Id: BackupProtectedItems_List

public static Azure.AsyncPageable<Azure.ResourceManager.RecoveryServicesBackup.BackupProtectedItemResource> GetBackupProtectedItemsAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string vaultName, string filter = default, string skipToken = default, System.Threading.CancellationToken cancellationToken = default);

static member GetBackupProtectedItemsAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.RecoveryServicesBackup.BackupProtectedItemResource>

<Extension()>
Public Function GetBackupProtectedItemsAsync (resourceGroupResource As ResourceGroupResource, vaultName As String, Optional filter As String = Nothing, Optional skipToken As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of BackupProtectedItemResource)

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

vaultName

String

The name of the recovery services vault.

filter

String

OData filter options.

skipToken

String

skipToken Filter.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

AsyncPageable<BackupProtectedItemResource>

An async collection of BackupProtectedItemResource that may take multiple service requests to iterate over.

Exceptions

ArgumentException

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

ArgumentNullException

resourceGroupResource or vaultName is null.