Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/services/recoveryServicesBackupManagement/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2018 Microsoft
Copyright (c) 2019 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
13 changes: 7 additions & 6 deletions lib/services/recoveryServicesBackupManagement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,23 @@ uid: azure-arm-recoveryservicesbackup
summary: *content

---
# Microsoft Azure SDK for Node.js - RecoveryServicesBackupClient
**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.**
## Microsoft Azure SDK for Node.js - RecoveryServicesBackupClient
This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**

## Features
### Features


## How to Install
### How to Install

```bash
npm install azure-arm-recoveryservicesbackup
```

## How to use
### How to use

### Authentication, client creation and get protectionIntent as an example.
#### Authentication, client creation and get protectionIntent as an example.

```javascript
const msRestAzure = require("ms-rest-azure");
Expand All @@ -39,6 +40,6 @@ msRestAzure.interactiveLogin().then((creds) => {
console.dir(err, {depth: null, colors: true});
});

## Related projects
### Related projects

- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,11 @@ const models = require('./index');
/**
* AzureBackupServer (DPMVenus) workload-specific protection container.
*
* @extends models['ProtectionContainer']
* @extends models['DpmContainer']
*/
class AzureBackupServerContainer extends models['ProtectionContainer'] {
class AzureBackupServerContainer extends models['DpmContainer'] {
/**
* Create a AzureBackupServerContainer.
* @member {boolean} [canReRegister] Specifies whether the container is
* re-registrable.
* @member {string} [containerId] ID of container.
* @member {number} [protectedItemCount] Number of protected items in the
* BackupEngine
* @member {string} [dpmAgentVersion] Backup engine Agent version
* @member {array} [dpmServers] List of BackupEngines protecting the
* container
* @member {boolean} [upgradeAvailable] To check if upgrade available
* @member {string} [protectionStatus] Protection status of the container.
* @member {object} [extendedInfo] Extended Info of the container.
* @member {date} [extendedInfo.lastRefreshedAt] Last refresh time of the
* DPMContainer.
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const models = require('./index');
class AzureFileShareBackupRequest extends models['BackupRequest'] {
/**
* Create a AzureFileShareBackupRequest.
* @member {date} [recoveryPointExpiryTimeInUTC] Backup copy will expire
* @property {date} [recoveryPointExpiryTimeInUTC] Backup copy will expire
* after the time specified (UTC).
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ const models = require('./index');
class AzureFileShareProtectableItem extends models['WorkloadProtectableItem'] {
/**
* Create a AzureFileShareProtectableItem.
* @member {string} [parentContainerFabricId] Full Fabric ID of container to
* which this protectable item belongs. For example, ARM ID.
* @member {string} [parentContainerFriendlyName] Friendly name of container
* to which this protectable item belongs.
* @member {string} [azureFileShareType] File Share type XSync or XSMB.
* @property {string} [parentContainerFabricId] Full Fabric ID of container
* to which this protectable item belongs. For example, ARM ID.
* @property {string} [parentContainerFriendlyName] Friendly name of
* container to which this protectable item belongs.
* @property {string} [azureFileShareType] File Share type XSync or XSMB.
* Possible values include: 'Invalid', 'XSMB', 'XSync'
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@ const models = require('./index');
class AzureFileShareProtectionPolicy extends models['ProtectionPolicy'] {
/**
* Create a AzureFileShareProtectionPolicy.
* @member {string} [workLoadType] Type of workload for the backup
* @property {string} [workLoadType] Type of workload for the backup
* management. Possible values include: 'Invalid', 'VM', 'FileFolder',
* 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM',
* 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase',
* 'AzureFileShare', 'SAPHanaDatabase'
* @member {object} [schedulePolicy] Backup schedule specified as part of
* 'AzureFileShare', 'SAPHanaDatabase', 'SAPAseDatabase'
* @property {object} [schedulePolicy] Backup schedule specified as part of
* backup policy.
* @member {string} [schedulePolicy.schedulePolicyType] Polymorphic
* @property {string} [schedulePolicy.schedulePolicyType] Polymorphic
* Discriminator
* @member {object} [retentionPolicy] Retention policy with the details on
* @property {object} [retentionPolicy] Retention policy with the details on
* backup copy retention ranges.
* @member {string} [retentionPolicy.retentionPolicyType] Polymorphic
* @property {string} [retentionPolicy.retentionPolicyType] Polymorphic
* Discriminator
* @member {string} [timeZone] TimeZone optional input as string. For
* @property {string} [timeZone] TimeZone optional input as string. For
* example: TimeZone = "Pacific Standard Time".
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ const models = require('./index');
class AzureFileShareRecoveryPoint extends models['RecoveryPoint'] {
/**
* Create a AzureFileShareRecoveryPoint.
* @member {string} [recoveryPointType] Type of the backup copy. Specifies
* @property {string} [recoveryPointType] Type of the backup copy. Specifies
* whether it is a crash consistent backup or app consistent.
* @member {date} [recoveryPointTime] Time at which this backup copy was
* @property {date} [recoveryPointTime] Time at which this backup copy was
* created.
* @member {string} [fileShareSnapshotUri] Contains Url to the snapshot of
* @property {string} [fileShareSnapshotUri] Contains Url to the snapshot of
* fileshare, if applicable
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,21 @@ const models = require('./index');
class AzureFileShareRestoreRequest extends models['RestoreRequest'] {
/**
* Create a AzureFileShareRestoreRequest.
* @member {string} [recoveryType] Type of this recovery. Possible values
* @property {string} [recoveryType] Type of this recovery. Possible values
* include: 'Invalid', 'OriginalLocation', 'AlternateLocation',
* 'RestoreDisks'
* @member {string} [sourceResourceId] Source storage account ARM Id
* @member {string} [copyOptions] Options to resolve copy conflicts. Possible
* values include: 'Invalid', 'CreateCopy', 'Skip', 'Overwrite',
* @property {string} [sourceResourceId] Source storage account ARM Id
* @property {string} [copyOptions] Options to resolve copy conflicts.
* Possible values include: 'Invalid', 'CreateCopy', 'Skip', 'Overwrite',
* 'FailOnConflict'
* @member {string} [restoreRequestType] Restore Type (FullShareRestore or
* @property {string} [restoreRequestType] Restore Type (FullShareRestore or
* ItemLevelRestore). Possible values include: 'Invalid', 'FullShareRestore',
* 'ItemLevelRestore'
* @member {array} [restoreFileSpecs] List of Source Files/Folders(which need
* to recover) and TargetFolderPath details
* @member {object} [targetDetails] Target File Share Details
* @member {string} [targetDetails.name] File share name
* @member {string} [targetDetails.targetResourceId] Target file share
* @property {array} [restoreFileSpecs] List of Source Files/Folders(which
* need to recover) and TargetFolderPath details
* @property {object} [targetDetails] Target File Share Details
* @property {string} [targetDetails.name] File share name
* @property {string} [targetDetails.targetResourceId] Target file share
* resource ARM ID
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,26 @@ const models = require('./index');
class AzureFileshareProtectedItem extends models['ProtectedItem'] {
/**
* Create a AzureFileshareProtectedItem.
* @member {string} [friendlyName] Friendly name of the fileshare represented
* by this backup item.
* @member {string} [protectionStatus] Backup status of this backup item.
* @member {string} [protectionState] Backup state of this backup item.
* @property {string} [friendlyName] Friendly name of the fileshare
* represented by this backup item.
* @property {string} [protectionStatus] Backup status of this backup item.
* @property {string} [protectionState] Backup state of this backup item.
* Possible values include: 'Invalid', 'IRPending', 'Protected',
* 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'
* @member {string} [healthStatus] backups running status for this backup
* @property {string} [healthStatus] backups running status for this backup
* item. Possible values include: 'Passed', 'ActionRequired',
* 'ActionSuggested', 'Invalid'
* @member {string} [lastBackupStatus] Last backup operation status. Possible
* values: Healthy, Unhealthy.
* @member {date} [lastBackupTime] Timestamp of the last backup operation on
* this backup item.
* @member {object} [extendedInfo] Additional information with this backup
* @property {string} [lastBackupStatus] Last backup operation status.
* Possible values: Healthy, Unhealthy.
* @property {date} [lastBackupTime] Timestamp of the last backup operation
* on this backup item.
* @property {object} [extendedInfo] Additional information with this backup
* item.
* @member {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy
* @property {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy
* available for this item in the service.
* @member {number} [extendedInfo.recoveryPointCount] Number of available
* @property {number} [extendedInfo.recoveryPointCount] Number of available
* backup copies associated with this backup item.
* @member {string} [extendedInfo.policyState] Indicates consistency of
* @property {string} [extendedInfo.policyState] Indicates consistency of
* policy object and policy applied to this backup item.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@
class AzureFileshareProtectedItemExtendedInfo {
/**
* Create a AzureFileshareProtectedItemExtendedInfo.
* @member {date} [oldestRecoveryPoint] The oldest backup copy available for
* this item in the service.
* @member {number} [recoveryPointCount] Number of available backup copies
* @property {date} [oldestRecoveryPoint] The oldest backup copy available
* for this item in the service.
* @property {number} [recoveryPointCount] Number of available backup copies
* associated with this backup item.
* @member {string} [policyState] Indicates consistency of policy object and
* policy applied to this backup item.
* @property {string} [policyState] Indicates consistency of policy object
* and policy applied to this backup item.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
class AzureIaaSVMErrorInfo {
/**
* Create a AzureIaaSVMErrorInfo.
* @member {number} [errorCode] Error code.
* @member {string} [errorTitle] Title: Typically, the entity that the error
* pertains to.
* @member {string} [errorString] Localized error string.
* @member {array} [recommendations] List of localized recommendations for
* @property {number} [errorCode] Error code.
* @property {string} [errorTitle] Title: Typically, the entity that the
* error pertains to.
* @property {string} [errorString] Localized error string.
* @property {array} [recommendations] List of localized recommendations for
* above error code.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
class AzureIaaSVMHealthDetails {
/**
* Create a AzureIaaSVMHealthDetails.
* @member {number} [code] Health Code
* @member {string} [title] Health Title
* @member {string} [message] Health Message
* @member {array} [recommendations] Health Recommended Actions
* @property {number} [code] Health Code
* @property {string} [title] Health Title
* @property {string} [message] Health Message
* @property {array} [recommendations] Health Recommended Actions
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,31 @@
const models = require('./index');

/**
* Azure IaaS VM workload-specifc job object.
* Azure IaaS VM workload-specific job object.
*
* @extends models['Job']
*/
class AzureIaaSVMJob extends models['Job'] {
/**
* Create a AzureIaaSVMJob.
* @member {moment.duration} [duration] Time elapsed during the execution of
* @property {moment.duration} [duration] Time elapsed during the execution
* of this job.
* @property {array} [actionsInfo] Gets or sets the state/actions applicable
* on this job like cancel/retry.
* @property {array} [errorDetails] Error details on execution of this job.
* @property {string} [virtualMachineVersion] Specifies whether the backup
* item is a Classic or an Azure Resource Manager VM.
* @property {object} [extendedInfo] Additional information for this job.
* @property {array} [extendedInfo.tasksList] List of tasks associated with
* this job.
* @member {array} [actionsInfo] Gets or sets the state/actions applicable on
* this job like cancel/retry.
* @member {array} [errorDetails] Error details on execution of this job.
* @member {string} [virtualMachineVersion] Specifies whether the backup item
* is a Classic or an Azure Resource Manager VM.
* @member {object} [extendedInfo] Additional information for this job.
* @member {array} [extendedInfo.tasksList] List of tasks associated with
* this job.
* @member {object} [extendedInfo.propertyBag] Job properties.
* @member {object} [extendedInfo.internalPropertyBag] Job internal
* @property {object} [extendedInfo.propertyBag] Job properties.
* @property {object} [extendedInfo.internalPropertyBag] Job internal
* properties.
* @member {number} [extendedInfo.progressPercentage] Indicates progress of
* @property {number} [extendedInfo.progressPercentage] Indicates progress of
* the job. Null if it has not started or completed.
* @member {string} [extendedInfo.estimatedRemainingDuration] Time remaining
* for execution of this job.
* @member {string} [extendedInfo.dynamicErrorMessage] Non localized error
* @property {string} [extendedInfo.estimatedRemainingDuration] Time
* remaining for execution of this job.
* @property {string} [extendedInfo.dynamicErrorMessage] Non localized error
* message on job execution.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@
class AzureIaaSVMJobExtendedInfo {
/**
* Create a AzureIaaSVMJobExtendedInfo.
* @member {array} [tasksList] List of tasks associated with this job.
* @member {object} [propertyBag] Job properties.
* @member {object} [internalPropertyBag] Job internal properties.
* @member {number} [progressPercentage] Indicates progress of the job. Null
* if it has not started or completed.
* @member {string} [estimatedRemainingDuration] Time remaining for execution
* of this job.
* @member {string} [dynamicErrorMessage] Non localized error message on job
* execution.
* @property {array} [tasksList] List of tasks associated with this job.
* @property {object} [propertyBag] Job properties.
* @property {object} [internalPropertyBag] Job internal properties.
* @property {number} [progressPercentage] Indicates progress of the job.
* Null if it has not started or completed.
* @property {string} [estimatedRemainingDuration] Time remaining for
* execution of this job.
* @property {string} [dynamicErrorMessage] Non localized error message on
* job execution.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@
class AzureIaaSVMJobTaskDetails {
/**
* Create a AzureIaaSVMJobTaskDetails.
* @member {string} [taskId] The task display name.
* @member {date} [startTime] The start time.
* @member {date} [endTime] The end time.
* @member {string} [instanceId] The instanceId.
* @member {moment.duration} [duration] Time elapsed for task.
* @member {string} [status] The status.
* @member {number} [progressPercentage] Progress of the task.
* @member {string} [taskExecutionDetails] Details about execution of the
* @property {string} [taskId] The task display name.
* @property {date} [startTime] The start time.
* @property {date} [endTime] The end time.
* @property {string} [instanceId] The instanceId.
* @property {moment.duration} [duration] Time elapsed for task.
* @property {string} [status] The status.
* @property {number} [progressPercentage] Progress of the task.
* @property {string} [taskExecutionDetails] Details about execution of the
* task.
* eg: number of bytes transfered etc
* eg: number of bytes transferred etc
*/
constructor() {
}
Expand Down
Loading