@azure/arm-dataprotection package

Classes

DataProtectionClient

Interfaces

AbsoluteDeleteOption

Delete option with duration

AdHocBackupRuleOptions

Adhoc backup rules

AdhocBackupTriggerOption

Adhoc backup trigger option

AdhocBasedTaggingCriteria

Adhoc backup tagging criteria

AdhocBasedTriggerContext

Adhoc trigger context

AuthCredentials

Base class for different types of authentication credentials.

AzureBackupDiscreteRecoveryPoint

Azure backup discrete RecoveryPoint

AzureBackupFindRestorableTimeRangesRequest

List Restore Ranges Request

AzureBackupFindRestorableTimeRangesRequestResource

List Restore Ranges Request

AzureBackupFindRestorableTimeRangesResponse

List Restore Ranges Response

AzureBackupFindRestorableTimeRangesResponseResource

List Restore Ranges Response

AzureBackupJob

AzureBackup Job Class

AzureBackupJobResource

AzureBackup Job Resource Class

AzureBackupJobResourceList

List of AzureBackup Job resources

AzureBackupParams

Azure backup parameters

AzureBackupRecoveryPoint

Azure backup recoveryPoint

AzureBackupRecoveryPointBasedRestoreRequest

Azure backup recoveryPoint based restore request

AzureBackupRecoveryPointResource

Azure backup recoveryPoint resource

AzureBackupRecoveryPointResourceList

Azure backup recoveryPoint resource list

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackup RecoveryPointTime Based Restore Request

AzureBackupRehydrationRequest

Azure Backup Rehydrate Request

AzureBackupRestoreRequest

Azure backup restore request

AzureBackupRestoreWithRehydrationRequest

AzureBackup Restore with Rehydration Request

AzureBackupRule

Azure backup rule

AzureMonitorAlertSettings

Settings for Azure Monitor based alerts

AzureOperationalStoreParameters

Parameters for Operational-Tier DataStore

AzureRetentionRule

Azure retention rule

BackupCriteria

BackupCriteria base class

BackupDatasourceParameters

Parameters for Backup Datasource

BackupInstance

Backup Instance

BackupInstanceResource

BackupInstance Resource

BackupInstanceResourceList

BackupInstance Resource list response

BackupInstances

Interface representing a BackupInstances.

BackupInstancesAdhocBackupHeaders

Defines headers for BackupInstances_adhocBackup operation.

BackupInstancesAdhocBackupOptionalParams

Optional parameters.

BackupInstancesCreateOrUpdateHeaders

Defines headers for BackupInstances_createOrUpdate operation.

BackupInstancesCreateOrUpdateOptionalParams

Optional parameters.

BackupInstancesDeleteHeaders

Defines headers for BackupInstances_delete operation.

BackupInstancesDeleteOptionalParams

Optional parameters.

BackupInstancesExtensionRouting

Interface representing a BackupInstancesExtensionRouting.

BackupInstancesExtensionRoutingListNextOptionalParams

Optional parameters.

BackupInstancesExtensionRoutingListOptionalParams

Optional parameters.

BackupInstancesGetBackupInstanceOperationResultOptionalParams

Optional parameters.

BackupInstancesGetOptionalParams

Optional parameters.

BackupInstancesListNextOptionalParams

Optional parameters.

BackupInstancesListOptionalParams

Optional parameters.

BackupInstancesResumeBackupsHeaders

Defines headers for BackupInstances_resumeBackups operation.

BackupInstancesResumeBackupsOptionalParams

Optional parameters.

BackupInstancesResumeProtectionHeaders

Defines headers for BackupInstances_resumeProtection operation.

BackupInstancesResumeProtectionOptionalParams

Optional parameters.

BackupInstancesStopProtectionHeaders

Defines headers for BackupInstances_stopProtection operation.

BackupInstancesStopProtectionOptionalParams

Optional parameters.

BackupInstancesSuspendBackupsHeaders

Defines headers for BackupInstances_suspendBackups operation.

BackupInstancesSuspendBackupsOptionalParams

Optional parameters.

BackupInstancesSyncBackupInstanceHeaders

Defines headers for BackupInstances_syncBackupInstance operation.

BackupInstancesSyncBackupInstanceOptionalParams

Optional parameters.

BackupInstancesTriggerCrossRegionRestoreHeaders

Defines headers for BackupInstances_triggerCrossRegionRestore operation.

BackupInstancesTriggerCrossRegionRestoreOptionalParams

Optional parameters.

BackupInstancesTriggerRehydrateHeaders

Defines headers for BackupInstances_triggerRehydrate operation.

BackupInstancesTriggerRehydrateOptionalParams

Optional parameters.

BackupInstancesTriggerRestoreHeaders

Defines headers for BackupInstances_triggerRestore operation.

BackupInstancesTriggerRestoreOptionalParams

Optional parameters.

BackupInstancesValidateCrossRegionRestoreHeaders

Defines headers for BackupInstances_validateCrossRegionRestore operation.

BackupInstancesValidateCrossRegionRestoreOptionalParams

Optional parameters.

BackupInstancesValidateForBackupHeaders

Defines headers for BackupInstances_validateForBackup operation.

BackupInstancesValidateForBackupOptionalParams

Optional parameters.

BackupInstancesValidateForRestoreHeaders

Defines headers for BackupInstances_validateForRestore operation.

BackupInstancesValidateForRestoreOptionalParams

Optional parameters.

BackupParameters

BackupParameters base

BackupPolicies

Interface representing a BackupPolicies.

BackupPoliciesCreateOrUpdateOptionalParams

Optional parameters.

BackupPoliciesDeleteOptionalParams

Optional parameters.

BackupPoliciesGetOptionalParams

Optional parameters.

BackupPoliciesListNextOptionalParams

Optional parameters.

BackupPoliciesListOptionalParams

Optional parameters.

BackupPolicy

Rule based backup policy

BackupSchedule

Schedule for backup

BackupVault

Backup Vault

BackupVaultOperationResults

Interface representing a BackupVaultOperationResults.

BackupVaultOperationResultsGetHeaders

Defines headers for BackupVaultOperationResults_get operation.

BackupVaultOperationResultsGetOptionalParams

Optional parameters.

BackupVaultResource

Backup Vault Resource

BackupVaultResourceList

List of BackupVault resources

BackupVaults

Interface representing a BackupVaults.

BackupVaultsCheckNameAvailabilityOptionalParams

Optional parameters.

BackupVaultsCreateOrUpdateOptionalParams

Optional parameters.

BackupVaultsDeleteOptionalParams

Optional parameters.

BackupVaultsGetInResourceGroupNextOptionalParams

Optional parameters.

BackupVaultsGetInResourceGroupOptionalParams

Optional parameters.

BackupVaultsGetInSubscriptionNextOptionalParams

Optional parameters.

BackupVaultsGetInSubscriptionOptionalParams

Optional parameters.

BackupVaultsGetOptionalParams

Optional parameters.

BackupVaultsUpdateOptionalParams

Optional parameters.

BaseBackupPolicy

BackupPolicy base

BaseBackupPolicyResource

BaseBackupPolicy resource

BaseBackupPolicyResourceList

List of BaseBackupPolicy resources

BasePolicyRule

BasePolicy Rule

BaseResourceProperties

Properties which are specific to datasource/datasourceSets

BlobBackupDatasourceParameters

Parameters to be used during configuration of backup of blobs

CheckNameAvailabilityRequest

CheckNameAvailability Request

CheckNameAvailabilityResult

CheckNameAvailability Result

ClientDiscoveryDisplay

Localized display information of an operation.

ClientDiscoveryForLogSpecification

Class to represent shoebox log specification in json client discovery.

ClientDiscoveryForProperties

Class to represent shoebox properties in json client discovery.

ClientDiscoveryForServiceSpecification

Class to represent shoebox service specification in json client discovery.

ClientDiscoveryResponse

Operations List response which contains list of available APIs.

ClientDiscoveryValueForSingleApi

Available operation details.

CloudError

An error response from Azure Backup.

CmkKekIdentity

The details of the managed identity used for CMK

CmkKeyVaultProperties

The properties of the Key Vault which hosts CMK

CopyOnExpiryOption

Copy on Expiry Option

CopyOption

Options to copy

CrossRegionRestoreDetails

Cross Region Restore details

CrossRegionRestoreJobRequest

Details of CRR Job to be fetched

CrossRegionRestoreJobsRequest

Details of Backup Vault for which CRR Jobs are to be fetched

CrossRegionRestoreRequestObject

Cross Region Restore Request Object

CrossRegionRestoreSettings
CrossSubscriptionRestoreSettings

CrossSubscriptionRestore Settings

CustomCopyOption

Duration based custom options to copy

DataProtection

Interface representing a DataProtection.

DataProtectionCheckFeatureSupportOptionalParams

Optional parameters.

DataProtectionClientOptionalParams

Optional parameters.

DataProtectionOperations

Interface representing a DataProtectionOperations.

DataProtectionOperationsListNextOptionalParams

Optional parameters.

DataProtectionOperationsListOptionalParams

Optional parameters.

DataStoreInfoBase

DataStoreInfo base

DataStoreParameters

Parameters for DataStore

Datasource

Datasource to be backed up

DatasourceSet

DatasourceSet details of datasource to be backed up

Day

Day of the week

DefaultResourceProperties

Default source properties

DeleteOption

Delete Option

DeletedBackupInstance

Deleted Backup Instance

DeletedBackupInstanceResource

Deleted Backup Instance

DeletedBackupInstanceResourceList

List of DeletedBackupInstance resources

DeletedBackupInstances

Interface representing a DeletedBackupInstances.

DeletedBackupInstancesGetOptionalParams

Optional parameters.

DeletedBackupInstancesListNextOptionalParams

Optional parameters.

DeletedBackupInstancesListOptionalParams

Optional parameters.

DeletedBackupInstancesUndeleteOptionalParams

Optional parameters.

DeletionInfo

Deletion Info

DppBaseResource

Base resource under Microsoft.DataProtection provider namespace

DppBaseResourceList

Base for all lists of V2 resources.

DppBaseTrackedResource
DppIdentityDetails

Identity details

DppProxyResource
DppResource

Resource class

DppResourceGuardProxy

Interface representing a DppResourceGuardProxy.

DppResourceGuardProxyCreateOrUpdateOptionalParams

Optional parameters.

DppResourceGuardProxyDeleteOptionalParams

Optional parameters.

DppResourceGuardProxyGetOptionalParams

Optional parameters.

DppResourceGuardProxyListNextOptionalParams

Optional parameters.

DppResourceGuardProxyListOptionalParams

Optional parameters.

DppResourceGuardProxyUnlockDeleteOptionalParams

Optional parameters.

DppResourceList

ListResource

DppTrackedResource
DppTrackedResourceList
DppWorkerRequest
EncryptionSettings

Customer Managed Key details of the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorModel

The resource management error response.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

ExportJobs

Interface representing a ExportJobs.

ExportJobsOperationResult

Interface representing a ExportJobsOperationResult.

ExportJobsOperationResultGetOptionalParams

Optional parameters.

ExportJobsResult

The result for export jobs containing blob details.

ExportJobsTriggerHeaders

Defines headers for ExportJobs_trigger operation.

ExportJobsTriggerOptionalParams

Optional parameters.

FeatureSettings

Class containing feature settings of vault

FeatureValidationRequest

Base class for feature object

FeatureValidationRequestBase

Base class for Backup Feature support

FeatureValidationResponse

Feature Validation Response

FeatureValidationResponseBase

Base class for Backup Feature support

FetchCrossRegionRestoreJob

Interface representing a FetchCrossRegionRestoreJob.

FetchCrossRegionRestoreJobGetOptionalParams

Optional parameters.

FetchCrossRegionRestoreJobs

Interface representing a FetchCrossRegionRestoreJobs.

FetchCrossRegionRestoreJobsListNextOptionalParams

Optional parameters.

FetchCrossRegionRestoreJobsListOptionalParams

Optional parameters.

FetchSecondaryRPsRequestParameters

Information about BI whose secondary RecoveryPoints are requested Source region and BI ARM path

FetchSecondaryRecoveryPoints

Interface representing a FetchSecondaryRecoveryPoints.

FetchSecondaryRecoveryPointsListNextOptionalParams

Optional parameters.

FetchSecondaryRecoveryPointsListOptionalParams

Optional parameters.

IdentityDetails
ImmediateCopyOption

Immediate copy Option

ImmutabilitySettings

Immutability Settings at vault level

InnerError

Inner Error

ItemLevelRestoreCriteria

Class to contain criteria for item level restore

ItemLevelRestoreTargetInfo

Restore target info for Item level restore operation

ItemPathBasedRestoreCriteria

Prefix criteria to be used to during restore

JobExtendedInfo

Extended Information about the job

JobSubTask

Details of Job's Sub Task

Jobs

Interface representing a Jobs.

JobsGetOptionalParams

Optional parameters.

JobsListNextOptionalParams

Optional parameters.

JobsListOptionalParams

Optional parameters.

KubernetesClusterBackupDatasourceParameters

Parameters for Kubernetes Cluster Backup Datasource

KubernetesClusterRestoreCriteria

kubernetes Cluster Backup target info for restore operation

KubernetesClusterVaultTierRestoreCriteria

kubernetes Cluster Backup target info for restore operation from vault

KubernetesPVRestoreCriteria

Item Level kubernetes persistent volume target info for restore operation

KubernetesStorageClassRestoreCriteria

Item Level kubernetes storage class target info for restore operation

MonitoringSettings

Monitoring Settings

NamespacedNameResource

Class to refer resources which contains namespace and name

OperationExtendedInfo

Operation Extended Info

OperationJobExtendedInfo

Operation Job Extended Info

OperationResource

Operation Resource

OperationResult

Interface representing a OperationResult.

OperationResultGetHeaders

Defines headers for OperationResult_get operation.

OperationResultGetOptionalParams

Optional parameters.

OperationStatus

Interface representing a OperationStatus.

OperationStatusBackupVaultContext

Interface representing a OperationStatusBackupVaultContext.

OperationStatusBackupVaultContextGetOptionalParams

Optional parameters.

OperationStatusGetOptionalParams

Optional parameters.

OperationStatusResourceGroupContext

Interface representing a OperationStatusResourceGroupContext.

OperationStatusResourceGroupContextGetOptionalParams

Optional parameters.

PatchBackupVaultInput

Backup Vault Contract for Patch Backup Vault API.

PatchResourceGuardInput

Patch Request content for Microsoft.DataProtection Resource Guard resources

PatchResourceRequestInput

Patch Request content for Microsoft.DataProtection resources

PolicyInfo

Policy Info in backupInstance

PolicyParameters

Parameters in Policy

ProtectionStatusDetails

Protection status details

RangeBasedItemLevelRestoreCriteria

Item Level target info for restore operation

RecoveryPointDataStoreDetails

RecoveryPoint datastore details

RecoveryPoints

Interface representing a RecoveryPoints.

RecoveryPointsFilters
RecoveryPointsGetOptionalParams

Optional parameters.

RecoveryPointsListNextOptionalParams

Optional parameters.

RecoveryPointsListOptionalParams

Optional parameters.

ResourceGuard
ResourceGuardOperation

This class contains all the details about a critical operation.

ResourceGuardOperationDetail

VaultCritical Operation protected by a resource guard

ResourceGuardProxyBase

ResourceGuardProxyBase object, used in ResourceGuardProxyBaseResource

ResourceGuardProxyBaseResource

ResourceGuardProxyBaseResource object, used for response and request bodies for ResourceGuardProxy APIs

ResourceGuardProxyBaseResourceList

List of ResourceGuardProxyBase resources

ResourceGuardResource
ResourceGuardResourceList

List of ResourceGuard resources

ResourceGuards

Interface representing a ResourceGuards.

ResourceGuardsDeleteOptionalParams

Optional parameters.

ResourceGuardsGetBackupSecurityPINRequestsObjectsNextOptionalParams

Optional parameters.

ResourceGuardsGetBackupSecurityPINRequestsObjectsOptionalParams

Optional parameters.

ResourceGuardsGetDefaultBackupSecurityPINRequestsObjectOptionalParams

Optional parameters.

ResourceGuardsGetDefaultDeleteProtectedItemRequestsObjectOptionalParams

Optional parameters.

ResourceGuardsGetDefaultDeleteResourceGuardProxyRequestsObjectOptionalParams

Optional parameters.

ResourceGuardsGetDefaultDisableSoftDeleteRequestsObjectOptionalParams

Optional parameters.

ResourceGuardsGetDefaultUpdateProtectedItemRequestsObjectOptionalParams

Optional parameters.

ResourceGuardsGetDefaultUpdateProtectionPolicyRequestsObjectOptionalParams

Optional parameters.

ResourceGuardsGetDeleteProtectedItemRequestsObjectsNextOptionalParams

Optional parameters.

ResourceGuardsGetDeleteProtectedItemRequestsObjectsOptionalParams

Optional parameters.

ResourceGuardsGetDeleteResourceGuardProxyRequestsObjectsNextOptionalParams

Optional parameters.

ResourceGuardsGetDeleteResourceGuardProxyRequestsObjectsOptionalParams

Optional parameters.

ResourceGuardsGetDisableSoftDeleteRequestsObjectsNextOptionalParams

Optional parameters.

ResourceGuardsGetDisableSoftDeleteRequestsObjectsOptionalParams

Optional parameters.

ResourceGuardsGetOptionalParams

Optional parameters.

ResourceGuardsGetResourcesInResourceGroupNextOptionalParams

Optional parameters.

ResourceGuardsGetResourcesInResourceGroupOptionalParams

Optional parameters.

ResourceGuardsGetResourcesInSubscriptionNextOptionalParams

Optional parameters.

ResourceGuardsGetResourcesInSubscriptionOptionalParams

Optional parameters.

ResourceGuardsGetUpdateProtectedItemRequestsObjectsNextOptionalParams

Optional parameters.

ResourceGuardsGetUpdateProtectedItemRequestsObjectsOptionalParams

Optional parameters.

ResourceGuardsGetUpdateProtectionPolicyRequestsObjectsNextOptionalParams

Optional parameters.

ResourceGuardsGetUpdateProtectionPolicyRequestsObjectsOptionalParams

Optional parameters.

ResourceGuardsPatchOptionalParams

Optional parameters.

ResourceGuardsPutOptionalParams

Optional parameters.

ResourceMoveDetails

ResourceMoveDetails will be returned in response to GetResource call from ARM

RestorableTimeRange
RestorableTimeRanges

Interface representing a RestorableTimeRanges.

RestorableTimeRangesFindOptionalParams

Optional parameters.

RestoreFilesTargetInfo

Class encapsulating restore as files target parameters

RestoreJobRecoveryPointDetails
RestoreTargetInfo

Class encapsulating restore target parameters

RestoreTargetInfoBase

Base class common to RestoreTargetInfo and RestoreFilesTargetInfo

RetentionTag

Retention tag

ScheduleBasedBackupCriteria

Schedule based backup criteria

ScheduleBasedTriggerContext

Schedule based trigger context

SecretStoreBasedAuthCredentials

Secret store based authentication credentials.

SecretStoreResource

Class representing a secret store resource.

SecuritySettings

Class containing security settings of vault

SoftDeleteSettings

Soft delete related settings

SourceLifeCycle

Source LifeCycle

StopProtectionRequest

Request body of Stop protection when MUA is Enabled

StorageSetting

Storage setting

SupportedFeature

Elements class for feature request

SuspendBackupRequest

Request body of Suspend backup when MUA is Enabled

SyncBackupInstanceRequest

Sync BackupInstance Request

SystemData

Metadata pertaining to creation and last modification of the resource.

TaggingCriteria

Tagging criteria

TargetCopySetting

Target copy settings

TargetDetails

Class encapsulating target details, used where the destination is not a datasource

TriggerBackupRequest

Trigger backup request

TriggerContext

Trigger context

UnlockDeleteRequest

Request body of unlock delete API.

UnlockDeleteResponse

Response of Unlock Delete API.

UserAssignedIdentity

User assigned identity properties

UserFacingError

Error object used by layers that have access to localized content, and propagate that to user

UserFacingWarningDetail

Warning object used by layers that have access to localized content, and propagate that to user

ValidateCrossRegionRestoreRequestObject

Cross Region Restore Request Object

ValidateForBackupRequest

Validate for backup request

ValidateRestoreRequestObject

Validate restore request object

Type Aliases

AbsoluteMarker

Defines values for AbsoluteMarker.
KnownAbsoluteMarker can be used interchangeably with AbsoluteMarker, this enum contains the known values that the service supports.

Known values supported by the service

AllBackup
FirstOfDay
FirstOfMonth
FirstOfWeek
FirstOfYear

AlertsState

Defines values for AlertsState.
KnownAlertsState can be used interchangeably with AlertsState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

AuthCredentialsUnion
AzureBackupRecoveryPointBasedRestoreRequestUnion
AzureBackupRecoveryPointUnion
AzureBackupRestoreRequestUnion
BackupCriteriaUnion
BackupDatasourceParametersUnion
BackupInstancesAdhocBackupResponse

Contains response data for the adhocBackup operation.

BackupInstancesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

BackupInstancesExtensionRoutingListNextResponse

Contains response data for the listNext operation.

BackupInstancesExtensionRoutingListResponse

Contains response data for the list operation.

BackupInstancesGetBackupInstanceOperationResultResponse

Contains response data for the getBackupInstanceOperationResult operation.

BackupInstancesGetResponse

Contains response data for the get operation.

BackupInstancesListNextResponse

Contains response data for the listNext operation.

BackupInstancesListResponse

Contains response data for the list operation.

BackupInstancesTriggerCrossRegionRestoreResponse

Contains response data for the triggerCrossRegionRestore operation.

BackupInstancesTriggerRehydrateResponse

Contains response data for the triggerRehydrate operation.

BackupInstancesTriggerRestoreResponse

Contains response data for the triggerRestore operation.

BackupInstancesValidateCrossRegionRestoreResponse

Contains response data for the validateCrossRegionRestore operation.

BackupInstancesValidateForBackupResponse

Contains response data for the validateForBackup operation.

BackupInstancesValidateForRestoreResponse

Contains response data for the validateForRestore operation.

BackupParametersUnion
BackupPoliciesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

BackupPoliciesGetResponse

Contains response data for the get operation.

BackupPoliciesListNextResponse

Contains response data for the listNext operation.

BackupPoliciesListResponse

Contains response data for the list operation.

BackupVaultOperationResultsGetResponse

Contains response data for the get operation.

BackupVaultsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

BackupVaultsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

BackupVaultsGetInResourceGroupNextResponse

Contains response data for the getInResourceGroupNext operation.

BackupVaultsGetInResourceGroupResponse

Contains response data for the getInResourceGroup operation.

BackupVaultsGetInSubscriptionNextResponse

Contains response data for the getInSubscriptionNext operation.

BackupVaultsGetInSubscriptionResponse

Contains response data for the getInSubscription operation.

BackupVaultsGetResponse

Contains response data for the get operation.

BackupVaultsUpdateResponse

Contains response data for the update operation.

BaseBackupPolicyUnion
BasePolicyRuleUnion
BaseResourcePropertiesUnion
BcdrSecurityLevel

Defines values for BcdrSecurityLevel.
KnownBcdrSecurityLevel can be used interchangeably with BcdrSecurityLevel, this enum contains the known values that the service supports.

Known values supported by the service

Poor
Fair
Good
Excellent
NotSupported

CopyOptionUnion
CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

CrossRegionRestoreState

Defines values for CrossRegionRestoreState.
KnownCrossRegionRestoreState can be used interchangeably with CrossRegionRestoreState, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

CrossSubscriptionRestoreState

Defines values for CrossSubscriptionRestoreState.
KnownCrossSubscriptionRestoreState can be used interchangeably with CrossSubscriptionRestoreState, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
PermanentlyDisabled
Enabled

CurrentProtectionState

Defines values for CurrentProtectionState.
KnownCurrentProtectionState can be used interchangeably with CurrentProtectionState, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
NotProtected
ConfiguringProtection
ProtectionConfigured
BackupSchedulesSuspended
RetentionSchedulesSuspended
ProtectionStopped
ProtectionError
ConfiguringProtectionFailed
SoftDeleting
SoftDeleted
UpdatingProtection

DataProtectionCheckFeatureSupportResponse

Contains response data for the checkFeatureSupport operation.

DataProtectionOperationsListNextResponse

Contains response data for the listNext operation.

DataProtectionOperationsListResponse

Contains response data for the list operation.

DataStoreParametersUnion
DataStoreTypes

Defines values for DataStoreTypes.
KnownDataStoreTypes can be used interchangeably with DataStoreTypes, this enum contains the known values that the service supports.

Known values supported by the service

OperationalStore
VaultStore
ArchiveStore

DayOfWeek

Defines values for DayOfWeek.
KnownDayOfWeek can be used interchangeably with DayOfWeek, this enum contains the known values that the service supports.

Known values supported by the service

Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

DeleteOptionUnion
DeletedBackupInstancesGetResponse

Contains response data for the get operation.

DeletedBackupInstancesListNextResponse

Contains response data for the listNext operation.

DeletedBackupInstancesListResponse

Contains response data for the list operation.

DppResourceGuardProxyCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

DppResourceGuardProxyGetResponse

Contains response data for the get operation.

DppResourceGuardProxyListNextResponse

Contains response data for the listNext operation.

DppResourceGuardProxyListResponse

Contains response data for the list operation.

DppResourceGuardProxyUnlockDeleteResponse

Contains response data for the unlockDelete operation.

EncryptionState

Defines values for EncryptionState.
KnownEncryptionState can be used interchangeably with EncryptionState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: CMK encryption is enabled on the Backup Vault
Disabled: CMK encryption is disabled on the Backup Vault. User can not set this state once Encryption State is 'Enabled'.
Inconsistent: CMK encryption is in inconsistent state on the Backup Vault. This state indicates that user needs to retry the encryption settings operation immediately to correct the state.

ExistingResourcePolicy

Defines values for ExistingResourcePolicy.
KnownExistingResourcePolicy can be used interchangeably with ExistingResourcePolicy, this enum contains the known values that the service supports.

Known values supported by the service

Skip
Patch

ExportJobsOperationResultGetResponse

Contains response data for the get operation.

ExportJobsTriggerResponse

Contains response data for the trigger operation.

FeatureSupportStatus

Defines values for FeatureSupportStatus.
KnownFeatureSupportStatus can be used interchangeably with FeatureSupportStatus, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
NotSupported
AlphaPreview
PrivatePreview
PublicPreview
GenerallyAvailable

FeatureType

Defines values for FeatureType.
KnownFeatureType can be used interchangeably with FeatureType, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
DataSourceType

FeatureValidationRequestBaseUnion
FeatureValidationResponseBaseUnion
FetchCrossRegionRestoreJobGetResponse

Contains response data for the get operation.

FetchCrossRegionRestoreJobsListNextResponse

Contains response data for the listNext operation.

FetchCrossRegionRestoreJobsListResponse

Contains response data for the list operation.

FetchSecondaryRecoveryPointsListNextResponse

Contains response data for the listNext operation.

FetchSecondaryRecoveryPointsListResponse

Contains response data for the list operation.

IdentityType

Defines values for IdentityType.
KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned
UserAssigned

ImmutabilityState

Defines values for ImmutabilityState.
KnownImmutabilityState can be used interchangeably with ImmutabilityState, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Unlocked
Locked

InfrastructureEncryptionState

Defines values for InfrastructureEncryptionState.
KnownInfrastructureEncryptionState can be used interchangeably with InfrastructureEncryptionState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

ItemLevelRestoreCriteriaUnion
JobsGetResponse

Contains response data for the get operation.

JobsListNextResponse

Contains response data for the listNext operation.

JobsListResponse

Contains response data for the list operation.

Month

Defines values for Month.
KnownMonth can be used interchangeably with Month, this enum contains the known values that the service supports.

Known values supported by the service

April
August
December
February
January
July
June
March
May
November
October
September

OperationExtendedInfoUnion
OperationResultGetResponse

Contains response data for the get operation.

OperationStatusBackupVaultContextGetResponse

Contains response data for the get operation.

OperationStatusGetResponse

Contains response data for the get operation.

OperationStatusResourceGroupContextGetResponse

Contains response data for the get operation.

PersistentVolumeRestoreMode

Defines values for PersistentVolumeRestoreMode.
KnownPersistentVolumeRestoreMode can be used interchangeably with PersistentVolumeRestoreMode, this enum contains the known values that the service supports.

Known values supported by the service

RestoreWithVolumeData
RestoreWithoutVolumeData

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Failed
Provisioning
Succeeded
Unknown
Updating

RecoveryOption

Defines values for RecoveryOption.
KnownRecoveryOption can be used interchangeably with RecoveryOption, this enum contains the known values that the service supports.

Known values supported by the service

FailIfExists

RecoveryPointCompletionState

Defines values for RecoveryPointCompletionState.
KnownRecoveryPointCompletionState can be used interchangeably with RecoveryPointCompletionState, this enum contains the known values that the service supports.

Known values supported by the service

Completed
Partial

RecoveryPointsGetResponse

Contains response data for the get operation.

RecoveryPointsListNextResponse

Contains response data for the listNext operation.

RecoveryPointsListResponse

Contains response data for the list operation.

RehydrationPriority

Defines values for RehydrationPriority.
KnownRehydrationPriority can be used interchangeably with RehydrationPriority, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
High
Standard

RehydrationStatus

Defines values for RehydrationStatus.
KnownRehydrationStatus can be used interchangeably with RehydrationStatus, this enum contains the known values that the service supports.

Known values supported by the service

CREATE_IN_PROGRESS
COMPLETED
DELETE_IN_PROGRESS
DELETED
FAILED

ResourceGuardsGetBackupSecurityPINRequestsObjectsNextResponse

Contains response data for the getBackupSecurityPINRequestsObjectsNext operation.

ResourceGuardsGetBackupSecurityPINRequestsObjectsResponse

Contains response data for the getBackupSecurityPINRequestsObjects operation.

ResourceGuardsGetDefaultBackupSecurityPINRequestsObjectResponse

Contains response data for the getDefaultBackupSecurityPINRequestsObject operation.

ResourceGuardsGetDefaultDeleteProtectedItemRequestsObjectResponse

Contains response data for the getDefaultDeleteProtectedItemRequestsObject operation.

ResourceGuardsGetDefaultDeleteResourceGuardProxyRequestsObjectResponse

Contains response data for the getDefaultDeleteResourceGuardProxyRequestsObject operation.

ResourceGuardsGetDefaultDisableSoftDeleteRequestsObjectResponse

Contains response data for the getDefaultDisableSoftDeleteRequestsObject operation.

ResourceGuardsGetDefaultUpdateProtectedItemRequestsObjectResponse

Contains response data for the getDefaultUpdateProtectedItemRequestsObject operation.

ResourceGuardsGetDefaultUpdateProtectionPolicyRequestsObjectResponse

Contains response data for the getDefaultUpdateProtectionPolicyRequestsObject operation.

ResourceGuardsGetDeleteProtectedItemRequestsObjectsNextResponse

Contains response data for the getDeleteProtectedItemRequestsObjectsNext operation.

ResourceGuardsGetDeleteProtectedItemRequestsObjectsResponse

Contains response data for the getDeleteProtectedItemRequestsObjects operation.

ResourceGuardsGetDeleteResourceGuardProxyRequestsObjectsNextResponse

Contains response data for the getDeleteResourceGuardProxyRequestsObjectsNext operation.

ResourceGuardsGetDeleteResourceGuardProxyRequestsObjectsResponse

Contains response data for the getDeleteResourceGuardProxyRequestsObjects operation.

ResourceGuardsGetDisableSoftDeleteRequestsObjectsNextResponse

Contains response data for the getDisableSoftDeleteRequestsObjectsNext operation.

ResourceGuardsGetDisableSoftDeleteRequestsObjectsResponse

Contains response data for the getDisableSoftDeleteRequestsObjects operation.

ResourceGuardsGetResourcesInResourceGroupNextResponse

Contains response data for the getResourcesInResourceGroupNext operation.

ResourceGuardsGetResourcesInResourceGroupResponse

Contains response data for the getResourcesInResourceGroup operation.

ResourceGuardsGetResourcesInSubscriptionNextResponse

Contains response data for the getResourcesInSubscriptionNext operation.

ResourceGuardsGetResourcesInSubscriptionResponse

Contains response data for the getResourcesInSubscription operation.

ResourceGuardsGetResponse

Contains response data for the get operation.

ResourceGuardsGetUpdateProtectedItemRequestsObjectsNextResponse

Contains response data for the getUpdateProtectedItemRequestsObjectsNext operation.

ResourceGuardsGetUpdateProtectedItemRequestsObjectsResponse

Contains response data for the getUpdateProtectedItemRequestsObjects operation.

ResourceGuardsGetUpdateProtectionPolicyRequestsObjectsNextResponse

Contains response data for the getUpdateProtectionPolicyRequestsObjectsNext operation.

ResourceGuardsGetUpdateProtectionPolicyRequestsObjectsResponse

Contains response data for the getUpdateProtectionPolicyRequestsObjects operation.

ResourceGuardsPatchResponse

Contains response data for the patch operation.

ResourceGuardsPutResponse

Contains response data for the put operation.

ResourceMoveState

Defines values for ResourceMoveState.
KnownResourceMoveState can be used interchangeably with ResourceMoveState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
InProgress
PrepareFailed
CommitFailed
Failed
PrepareTimedout
CommitTimedout
CriticalFailure
PartialSuccess
MoveSucceeded

ResourcePropertiesObjectType

Defines values for ResourcePropertiesObjectType.
KnownResourcePropertiesObjectType can be used interchangeably with ResourcePropertiesObjectType, this enum contains the known values that the service supports.

Known values supported by the service

DefaultResourceProperties

RestorableTimeRangesFindResponse

Contains response data for the find operation.

RestoreSourceDataStoreType

Defines values for RestoreSourceDataStoreType.
KnownRestoreSourceDataStoreType can be used interchangeably with RestoreSourceDataStoreType, this enum contains the known values that the service supports.

Known values supported by the service

OperationalStore
VaultStore
ArchiveStore

RestoreTargetInfoBaseUnion
RestoreTargetLocationType

Defines values for RestoreTargetLocationType.
KnownRestoreTargetLocationType can be used interchangeably with RestoreTargetLocationType, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
AzureBlobs
AzureFiles

SecretStoreType

Defines values for SecretStoreType.
KnownSecretStoreType can be used interchangeably with SecretStoreType, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
AzureKeyVault

SecureScoreLevel

Defines values for SecureScoreLevel.
KnownSecureScoreLevel can be used interchangeably with SecureScoreLevel, this enum contains the known values that the service supports.

Known values supported by the service

None
Minimum
Adequate
Maximum
NotSupported

SoftDeleteState

Defines values for SoftDeleteState.
KnownSoftDeleteState can be used interchangeably with SoftDeleteState, this enum contains the known values that the service supports.

Known values supported by the service

Off: Soft Delete is turned off for the BackupVault
On: Soft Delete is enabled for the BackupVault but can be turned off
AlwaysOn: Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed

SourceDataStoreType

Defines values for SourceDataStoreType.
KnownSourceDataStoreType can be used interchangeably with SourceDataStoreType, this enum contains the known values that the service supports.

Known values supported by the service

ArchiveStore
SnapshotStore
OperationalStore
VaultStore

Status

Defines values for Status.
KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports.

Known values supported by the service

ConfiguringProtection
ConfiguringProtectionFailed
ProtectionConfigured
ProtectionStopped
SoftDeleted
SoftDeleting

StorageSettingStoreTypes

Defines values for StorageSettingStoreTypes.
KnownStorageSettingStoreTypes can be used interchangeably with StorageSettingStoreTypes, this enum contains the known values that the service supports.

Known values supported by the service

ArchiveStore
OperationalStore
VaultStore

StorageSettingTypes

Defines values for StorageSettingTypes.
KnownStorageSettingTypes can be used interchangeably with StorageSettingTypes, this enum contains the known values that the service supports.

Known values supported by the service

GeoRedundant
LocallyRedundant
ZoneRedundant

SyncType

Defines values for SyncType.
KnownSyncType can be used interchangeably with SyncType, this enum contains the known values that the service supports.

Known values supported by the service

Default
ForceResync

TriggerContextUnion
ValidationType

Defines values for ValidationType.
KnownValidationType can be used interchangeably with ValidationType, this enum contains the known values that the service supports.

Known values supported by the service

ShallowValidation
DeepValidation

WeekNumber

Defines values for WeekNumber.
KnownWeekNumber can be used interchangeably with WeekNumber, this enum contains the known values that the service supports.

Known values supported by the service

First
Fourth
Last
Second
Third

Enums

KnownAbsoluteMarker

Known values of AbsoluteMarker that the service accepts.

KnownAlertsState

Known values of AlertsState that the service accepts.

KnownBcdrSecurityLevel

Known values of BcdrSecurityLevel that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownCrossRegionRestoreState

Known values of CrossRegionRestoreState that the service accepts.

KnownCrossSubscriptionRestoreState

Known values of CrossSubscriptionRestoreState that the service accepts.

KnownCurrentProtectionState

Known values of CurrentProtectionState that the service accepts.

KnownDataStoreTypes

Known values of DataStoreTypes that the service accepts.

KnownDayOfWeek

Known values of DayOfWeek that the service accepts.

KnownEncryptionState

Known values of EncryptionState that the service accepts.

KnownExistingResourcePolicy

Known values of ExistingResourcePolicy that the service accepts.

KnownFeatureSupportStatus

Known values of FeatureSupportStatus that the service accepts.

KnownFeatureType

Known values of FeatureType that the service accepts.

KnownIdentityType

Known values of IdentityType that the service accepts.

KnownImmutabilityState

Known values of ImmutabilityState that the service accepts.

KnownInfrastructureEncryptionState

Known values of InfrastructureEncryptionState that the service accepts.

KnownMonth

Known values of Month that the service accepts.

KnownPersistentVolumeRestoreMode

Known values of PersistentVolumeRestoreMode that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownRecoveryOption

Known values of RecoveryOption that the service accepts.

KnownRecoveryPointCompletionState

Known values of RecoveryPointCompletionState that the service accepts.

KnownRehydrationPriority

Known values of RehydrationPriority that the service accepts.

KnownRehydrationStatus

Known values of RehydrationStatus that the service accepts.

KnownResourceMoveState

Known values of ResourceMoveState that the service accepts.

KnownResourcePropertiesObjectType

Known values of ResourcePropertiesObjectType that the service accepts.

KnownRestoreSourceDataStoreType

Known values of RestoreSourceDataStoreType that the service accepts.

KnownRestoreTargetLocationType

Known values of RestoreTargetLocationType that the service accepts.

KnownSecretStoreType

Known values of SecretStoreType that the service accepts.

KnownSecureScoreLevel

Known values of SecureScoreLevel that the service accepts.

KnownSoftDeleteState

Known values of SoftDeleteState that the service accepts.

KnownSourceDataStoreType

Known values of SourceDataStoreType that the service accepts.

KnownStatus

Known values of Status that the service accepts.

KnownStorageSettingStoreTypes

Known values of StorageSettingStoreTypes that the service accepts.

KnownStorageSettingTypes

Known values of StorageSettingTypes that the service accepts.

KnownSyncType

Known values of SyncType that the service accepts.

KnownValidationType

Known values of ValidationType that the service accepts.

KnownWeekNumber

Known values of WeekNumber that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.