@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 |
| AdlsBlobBackupDatasourceParameters |
Parameters to be used during configuration of backup of azure data lake storage account blobs |
| AuthCredentials |
Base class for different types of authentication credentials. |
| AzureBackupDiscreteRecoveryPoint |
Azure backup discrete RecoveryPoint |
| AzureBackupFindRestorableTimeRangesRequest |
List Restore Ranges Request |
| AzureBackupFindRestorableTimeRangesResponse |
List Restore Ranges Response |
| AzureBackupFindRestorableTimeRangesResponseResource |
List Restore Ranges Response |
| AzureBackupJob |
AzureBackup Job Class |
| AzureBackupJobResource |
AzureBackup Job Resource Class |
| AzureBackupParams |
Azure backup parameters |
| AzureBackupRecoveryPoint |
Azure backup recoveryPoint |
| AzureBackupRecoveryPointBasedRestoreRequest |
Azure backup recoveryPoint based restore request |
| AzureBackupRecoveryPointResource |
Azure backup recoveryPoint resource |
| 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 |
| BackupInstancesAdhocBackupOptionalParams |
Optional parameters. |
| BackupInstancesCreateOrUpdateOptionalParams |
Optional parameters. |
| BackupInstancesDeleteOptionalParams |
Optional parameters. |
| BackupInstancesExtensionRoutingListOptionalParams |
Optional parameters. |
| BackupInstancesExtensionRoutingOperations |
Interface representing a BackupInstancesExtensionRouting operations. |
| BackupInstancesGetBackupInstanceOperationResultOptionalParams |
Optional parameters. |
| BackupInstancesGetOptionalParams |
Optional parameters. |
| BackupInstancesListOptionalParams |
Optional parameters. |
| BackupInstancesOperations |
Interface representing a BackupInstances operations. |
| BackupInstancesResumeBackupsOptionalParams |
Optional parameters. |
| BackupInstancesResumeProtectionOptionalParams |
Optional parameters. |
| BackupInstancesStopProtectionOptionalParams |
Optional parameters. |
| BackupInstancesSuspendBackupsOptionalParams |
Optional parameters. |
| BackupInstancesSyncBackupInstanceOptionalParams |
Optional parameters. |
| BackupInstancesTriggerCrossRegionRestoreOptionalParams |
Optional parameters. |
| BackupInstancesTriggerRehydrateOptionalParams |
Optional parameters. |
| BackupInstancesTriggerRestoreOptionalParams |
Optional parameters. |
| BackupInstancesValidateCrossRegionRestoreOptionalParams |
Optional parameters. |
| BackupInstancesValidateForBackupOptionalParams |
Optional parameters. |
| BackupInstancesValidateForModifyBackupOptionalParams |
Optional parameters. |
| BackupInstancesValidateForRestoreOptionalParams |
Optional parameters. |
| BackupParameters |
BackupParameters base |
| BackupPoliciesCreateOrUpdateOptionalParams |
Optional parameters. |
| BackupPoliciesDeleteOptionalParams |
Optional parameters. |
| BackupPoliciesGetOptionalParams |
Optional parameters. |
| BackupPoliciesListOptionalParams |
Optional parameters. |
| BackupPoliciesOperations |
Interface representing a BackupPolicies operations. |
| BackupPolicy |
Rule based backup policy |
| BackupSchedule |
Schedule for backup |
| BackupVault |
Backup Vault |
| BackupVaultOperationResultsGetOptionalParams |
Optional parameters. |
| BackupVaultOperationResultsOperations |
Interface representing a BackupVaultOperationResults operations. |
| BackupVaultResource |
Backup Vault Resource |
| BackupVaultsCheckNameAvailabilityOptionalParams |
Optional parameters. |
| BackupVaultsCreateOrUpdateOptionalParams |
Optional parameters. |
| BackupVaultsDeleteOptionalParams |
Optional parameters. |
| BackupVaultsGetOptionalParams |
Optional parameters. |
| BackupVaultsListInResourceGroupOptionalParams |
Optional parameters. |
| BackupVaultsListInSubscriptionOptionalParams |
Optional parameters. |
| BackupVaultsOperations |
Interface representing a BackupVaults operations. |
| BackupVaultsUpdateOptionalParams |
Optional parameters. |
| BaseBackupPolicy |
BackupPolicy base |
| BaseBackupPolicyResource |
BaseBackupPolicy resource |
| 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 |
| 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 |
model interface CrossRegionRestoreSettings |
| CrossSubscriptionRestoreSettings |
CrossSubscriptionRestore Settings |
| CustomCopyOption |
Duration based custom options to copy |
| DataProtectionCheckFeatureSupportOptionalParams |
Optional parameters. |
| DataProtectionClientOptionalParams |
Optional parameters for the client. |
| DataProtectionOperations |
Interface representing a DataProtection operations. |
| DataProtectionOperationsListOptionalParams |
Optional parameters. |
| DataProtectionOperationsOperations |
Interface representing a DataProtectionOperations operations. |
| 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 |
| DeletedBackupInstancesGetOptionalParams |
Optional parameters. |
| DeletedBackupInstancesListOptionalParams |
Optional parameters. |
| DeletedBackupInstancesOperations |
Interface representing a DeletedBackupInstances operations. |
| DeletedBackupInstancesUndeleteOptionalParams |
Optional parameters. |
| DeletionInfo |
Deletion Info |
| DppBaseResource |
Base resource under Microsoft.DataProtection provider namespace |
| DppIdentityDetails |
Identity details |
| DppResource |
Resource class |
| DppResourceGuardProxyCreateOrUpdateOptionalParams |
Optional parameters. |
| DppResourceGuardProxyDeleteOptionalParams |
Optional parameters. |
| DppResourceGuardProxyGetOptionalParams |
Optional parameters. |
| DppResourceGuardProxyListOptionalParams |
Optional parameters. |
| DppResourceGuardProxyOperations |
Interface representing a DppResourceGuardProxy operations. |
| DppResourceGuardProxyUnlockDeleteOptionalParams |
Optional parameters. |
| DppResourceList |
ListResource |
| DppTrackedResourceList |
model interface DppTrackedResourceList |
| 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. |
| ExportJobsOperationResultGetOptionalParams |
Optional parameters. |
| ExportJobsOperationResultOperations |
Interface representing a ExportJobsOperationResult operations. |
| ExportJobsOperations |
Interface representing a ExportJobs operations. |
| ExportJobsResult |
The result for export jobs containing blob details. |
| 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 |
| FetchCrossRegionRestoreJobGetOptionalParams |
Optional parameters. |
| FetchCrossRegionRestoreJobOperations |
Interface representing a FetchCrossRegionRestoreJob operations. |
| FetchCrossRegionRestoreJobsListOptionalParams |
Optional parameters. |
| FetchCrossRegionRestoreJobsOperations |
Interface representing a FetchCrossRegionRestoreJobs operations. |
| FetchSecondaryRPsRequestParameters |
Information about BI whose secondary RecoveryPoints are requested Source region and BI ARM path |
| FetchSecondaryRecoveryPointsListOptionalParams |
Optional parameters. |
| FetchSecondaryRecoveryPointsOperations |
Interface representing a FetchSecondaryRecoveryPoints operations. |
| IdentityDetails |
model interface 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 |
| JobsGetOptionalParams |
Optional parameters. |
| JobsListOptionalParams |
Optional parameters. |
| JobsOperations |
Interface representing a Jobs operations. |
| 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 |
| Operation |
Details of a REST API operation, returned from the Resource Provider Operations API |
| OperationDisplay |
Localized display information for and operation. |
| OperationExtendedInfo |
Operation Extended Info |
| OperationJobExtendedInfo |
Operation Job Extended Info |
| OperationResource |
Operation Resource |
| OperationResultGetOptionalParams |
Optional parameters. |
| OperationResultOperations |
Interface representing a OperationResult operations. |
| OperationStatusBackupVaultContextGetOptionalParams |
Optional parameters. |
| OperationStatusBackupVaultContextOperations |
Interface representing a OperationStatusBackupVaultContext operations. |
| OperationStatusGetOptionalParams |
Optional parameters. |
| OperationStatusOperations |
Interface representing a OperationStatus operations. |
| OperationStatusResourceGroupContextGetOptionalParams |
Optional parameters. |
| OperationStatusResourceGroupContextOperations |
Interface representing a OperationStatusResourceGroupContext operations. |
| PageSettings |
Options for the byPage method |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| 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 |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| RangeBasedItemLevelRestoreCriteria |
Item Level target info for restore operation |
| RecoveryPointDataStoreDetails |
RecoveryPoint datastore details |
| RecoveryPointsGetOptionalParams |
Optional parameters. |
| RecoveryPointsListOptionalParams |
Optional parameters. |
| RecoveryPointsOperations |
Interface representing a RecoveryPoints operations. |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| ResourceGuard |
model interface 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 |
| ResourceGuardResource |
Concrete tracked resource types can be created by aliasing this type using a specific property type. |
| ResourceGuardsDeleteOptionalParams |
Optional parameters. |
| ResourceGuardsGetDefaultBackupSecurityPINRequestsObjectOptionalParams |
Optional parameters. |
| ResourceGuardsGetDefaultDeleteProtectedItemRequestsObjectOptionalParams |
Optional parameters. |
| ResourceGuardsGetDefaultDeleteResourceGuardProxyRequestsObjectOptionalParams |
Optional parameters. |
| ResourceGuardsGetDefaultDisableSoftDeleteRequestsObjectOptionalParams |
Optional parameters. |
| ResourceGuardsGetDefaultUpdateProtectedItemRequestsObjectOptionalParams |
Optional parameters. |
| ResourceGuardsGetDefaultUpdateProtectionPolicyRequestsObjectOptionalParams |
Optional parameters. |
| ResourceGuardsGetOptionalParams |
Optional parameters. |
| ResourceGuardsListBackupSecurityPINRequestsObjectsOptionalParams |
Optional parameters. |
| ResourceGuardsListDeleteProtectedItemRequestsObjectsOptionalParams |
Optional parameters. |
| ResourceGuardsListDeleteResourceGuardProxyRequestsObjectsOptionalParams |
Optional parameters. |
| ResourceGuardsListDisableSoftDeleteRequestsObjectsOptionalParams |
Optional parameters. |
| ResourceGuardsListResourcesInResourceGroupOptionalParams |
Optional parameters. |
| ResourceGuardsListResourcesInSubscriptionOptionalParams |
Optional parameters. |
| ResourceGuardsListUpdateProtectedItemRequestsObjectsOptionalParams |
Optional parameters. |
| ResourceGuardsListUpdateProtectionPolicyRequestsObjectsOptionalParams |
Optional parameters. |
| ResourceGuardsOperations |
Interface representing a ResourceGuards operations. |
| ResourceGuardsPatchOptionalParams |
Optional parameters. |
| ResourceGuardsPutOptionalParams |
Optional parameters. |
| ResourceMoveDetails |
ResourceMoveDetails will be returned in response to GetResource call from ARM |
| RestorableTimeRange |
model interface RestorableTimeRange |
| RestorableTimeRangesFindOptionalParams |
Optional parameters. |
| RestorableTimeRangesOperations |
Interface representing a RestorableTimeRanges operations. |
| RestoreFilesTargetInfo |
Class encapsulating restore as files target parameters |
| RestoreJobRecoveryPointDetails |
model interface RestoreJobRecoveryPointDetails |
| RestorePollerOptions | |
| 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 |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| 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 |
| ValidateForModifyBackupRequest |
Validate for modify backup request |
| ValidateRestoreRequestObject |
Validate restore request object |
Type Aliases
| AKSVolumeTypes |
Type of AKSVolumeTypes |
| AbsoluteMarker |
Type of AbsoluteMarker |
| ActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Known values supported by the serviceInternal: Actions are for internal-only APIs. |
| AlertsState |
Type of AlertsState |
| AuthCredentialsUnion |
Alias for AuthCredentialsUnion |
| AzureBackupRecoveryPointBasedRestoreRequestUnion |
Alias for AzureBackupRecoveryPointBasedRestoreRequestUnion |
| AzureBackupRecoveryPointUnion |
Alias for AzureBackupRecoveryPointUnion |
| AzureBackupRestoreRequestUnion |
Alias for AzureBackupRestoreRequestUnion |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| BackupCriteriaUnion |
Alias for BackupCriteriaUnion |
| BackupDatasourceParametersUnion |
Alias for BackupDatasourceParametersUnion |
| BackupParametersUnion |
Alias for BackupParametersUnion |
| BaseBackupPolicyUnion |
Alias for BaseBackupPolicyUnion |
| BasePolicyRuleUnion |
Alias for BasePolicyRuleUnion |
| BaseResourcePropertiesUnion |
Alias for BaseResourcePropertiesUnion |
| BcdrSecurityLevel |
Security Level of Backup Vault Known values supported by the servicePoor |
| BlobBackupDatasourceParametersUnion |
Alias for BlobBackupDatasourceParametersUnion |
| ContinuablePage |
An interface that describes a page of results. |
| CopyOptionUnion |
Alias for CopyOptionUnion |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| CrossRegionRestoreState |
CrossRegionRestore state Known values supported by the serviceDisabled |
| CrossSubscriptionRestoreState |
CrossSubscriptionRestore state Known values supported by the serviceDisabled |
| CurrentProtectionState |
Specifies the current protection state of the resource Known values supported by the serviceInvalid |
| DataStoreParametersUnion |
Alias for DataStoreParametersUnion |
| DataStoreTypes |
type of datastore; Operational/Vault/Archive Known values supported by the serviceOperationalStore |
| DayOfWeek |
Type of DayOfWeek |
| DeleteOptionUnion |
Alias for DeleteOptionUnion |
| EncryptionState |
Encryption state of the Backup Vault. Known values supported by the serviceEnabled: CMK encryption is enabled on the Backup Vault |
| ExistingResourcePolicy |
Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore. Known values supported by the serviceSkip |
| FeatureSupportStatus |
feature support status Known values supported by the serviceInvalid |
| FeatureType |
backup support feature type. Known values supported by the serviceInvalid |
| FeatureValidationRequestBaseUnion |
Alias for FeatureValidationRequestBaseUnion |
| FeatureValidationResponseBaseUnion |
Alias for FeatureValidationResponseBaseUnion |
| IdentityType |
The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. Known values supported by the serviceSystemAssigned |
| ImmutabilityState |
Immutability state Known values supported by the serviceDisabled |
| InfrastructureEncryptionState |
Enabling/Disabling the Double Encryption state Known values supported by the serviceEnabled |
| ItemLevelRestoreCriteriaUnion |
Alias for ItemLevelRestoreCriteriaUnion |
| Month |
Type of Month |
| OperationExtendedInfoUnion |
Alias for OperationExtendedInfoUnion |
| Origin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" Known values supported by the serviceuser: Indicates the operation is initiated by a user. |
| PersistentVolumeRestoreMode |
Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored. Known values supported by the serviceRestoreWithVolumeData |
| ProvisioningState |
Provisioning state of the BackupVault resource Known values supported by the serviceFailed |
| RecoveryOption |
Recovery Option Known values supported by the serviceFailIfExists |
| RecoveryPointCompletionState |
Specifies recovery point completeness. Partial (i.e., only some of the intended items were backed up), or Completed (i.e., ALL intended items were backed up). Known values supported by the serviceCompleted |
| RehydrationPriority |
Priority to be used for rehydration. Values High or Standard Known values supported by the serviceInvalid |
| RehydrationStatus |
Type of RehydrationStatus |
| ResourceMoveState |
Resource move state for backup vault Known values supported by the serviceUnknown |
| ResourcePropertiesObjectType |
Type of the specific object - used for deserializing Known values supported by the serviceDefaultResourceProperties |
| RestoreSourceDataStoreType |
Gets or sets the type of the source data store. Known values supported by the serviceOperationalStore |
| RestoreTargetInfoBaseUnion |
Alias for RestoreTargetInfoBaseUnion |
| RestoreTargetLocationType |
Denotes the target location where the data will be restored,
string value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType} Known values supported by the serviceInvalid |
| SecretStoreType |
Gets or sets the type of secret store Known values supported by the serviceInvalid |
| SecureScoreLevel |
Secure Score of Backup Vault Known values supported by the serviceNone |
| SoftDeleteState |
State of soft delete Known values supported by the serviceOff: Soft Delete is turned off for the BackupVault |
| SourceDataStoreType |
Gets or sets the type of the source data store. Known values supported by the serviceArchiveStore |
| Status |
Specifies the protection status of the resource Known values supported by the serviceConfiguringProtection |
| StorageSettingStoreTypes |
Gets or sets the type of the datastore. Known values supported by the serviceArchiveStore |
| StorageSettingTypes |
Gets or sets the type. Known values supported by the serviceGeoRedundant |
| SyncType |
Field indicating sync type e.g. to sync only in case of failure or in all cases Known values supported by the serviceDefault |
| TriggerContextUnion |
Alias for TriggerContextUnion |
| ValidationType |
Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. Known values supported by the serviceShallowValidation |
| WeekNumber |
Type of WeekNumber |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| KnownAKSVolumeTypes |
Known values of AKSVolumeTypes that the service accepts. |
| KnownAbsoluteMarker |
Known values of AbsoluteMarker that the service accepts. |
| KnownActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. |
| KnownAlertsState |
Known values of AlertsState that the service accepts. |
| KnownBcdrSecurityLevel |
Security Level of Backup Vault |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownCrossRegionRestoreState |
CrossRegionRestore state |
| KnownCrossSubscriptionRestoreState |
CrossSubscriptionRestore state |
| KnownCurrentProtectionState |
Specifies the current protection state of the resource |
| KnownDataStoreTypes |
type of datastore; Operational/Vault/Archive |
| KnownDayOfWeek |
Known values of DayOfWeek that the service accepts. |
| KnownEncryptionState |
Encryption state of the Backup Vault. |
| KnownExistingResourcePolicy |
Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore. |
| KnownFeatureSupportStatus |
feature support status |
| KnownFeatureType |
backup support feature type. |
| KnownIdentityType |
The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. |
| KnownImmutabilityState |
Immutability state |
| KnownInfrastructureEncryptionState |
Enabling/Disabling the Double Encryption state |
| KnownMonth |
Known values of Month that the service accepts. |
| KnownOrigin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" |
| KnownPersistentVolumeRestoreMode |
Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored. |
| KnownProvisioningState |
Provisioning state of the BackupVault resource |
| KnownRecoveryOption |
Recovery Option |
| KnownRecoveryPointCompletionState |
Specifies recovery point completeness. Partial (i.e., only some of the intended items were backed up), or Completed (i.e., ALL intended items were backed up). |
| KnownRehydrationPriority |
Priority to be used for rehydration. Values High or Standard |
| KnownRehydrationStatus |
Known values of RehydrationStatus that the service accepts. |
| KnownResourceMoveState |
Resource move state for backup vault |
| KnownResourcePropertiesObjectType |
Type of the specific object - used for deserializing |
| KnownRestoreSourceDataStoreType |
Gets or sets the type of the source data store. |
| KnownRestoreTargetLocationType |
Denotes the target location where the data will be restored, string value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType} |
| KnownSecretStoreType |
Gets or sets the type of secret store |
| KnownSecureScoreLevel |
Secure Score of Backup Vault |
| KnownSoftDeleteState |
State of soft delete |
| KnownSourceDataStoreType |
Gets or sets the type of the source data store. |
| KnownStatus |
Specifies the protection status of the resource |
| KnownStorageSettingStoreTypes |
Gets or sets the type of the datastore. |
| KnownStorageSettingTypes |
Gets or sets the type. |
| KnownSyncType |
Field indicating sync type e.g. to sync only in case of failure or in all cases |
| KnownValidationType |
Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. |
| KnownVersions |
The available API versions. |
| KnownWeekNumber |
Known values of WeekNumber that the service accepts. |
Functions
| restore |
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope. |
Function Details
restorePoller<TResponse, TResult>(DataProtectionClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.
function restorePoller<TResponse, TResult>(client: DataProtectionClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- DataProtectionClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>