diff --git a/lib/services/recoveryServicesBackupManagement/README.md b/lib/services/recoveryServicesBackupManagement/README.md index 58428e7c18..4d7fd13d8c 100644 --- a/lib/services/recoveryServicesBackupManagement/README.md +++ b/lib/services/recoveryServicesBackupManagement/README.md @@ -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"); @@ -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) diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureBackupServerContainer.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureBackupServerContainer.js index e02b39f773..a17d8f2aed 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureBackupServerContainer.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureBackupServerContainer.js @@ -20,18 +20,18 @@ const models = require('./index'); class AzureBackupServerContainer extends models['ProtectionContainer'] { /** * Create a AzureBackupServerContainer. - * @member {boolean} [canReRegister] Specifies whether the container is + * @property {boolean} [canReRegister] Specifies whether the container is * re-registrable. - * @member {string} [containerId] ID of container. - * @member {number} [protectedItemCount] Number of protected items in the + * @property {string} [containerId] ID of container. + * @property {number} [protectedItemCount] Number of protected items in the * BackupEngine - * @member {string} [dpmAgentVersion] Backup engine Agent version - * @member {array} [dpmServers] List of BackupEngines protecting the + * @property {string} [dpmAgentVersion] Backup engine Agent version + * @property {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 + * @property {boolean} [upgradeAvailable] To check if upgrade available + * @property {string} [protectionStatus] Protection status of the container. + * @property {object} [extendedInfo] Extended Info of the container. + * @property {date} [extendedInfo.lastRefreshedAt] Last refresh time of the * DPMContainer. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareBackupRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareBackupRequest.js index b06415b01c..f6b407902d 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareBackupRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareBackupRequest.js @@ -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() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareProtectableItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareProtectableItem.js index 68ada87fa8..d2cc065ce3 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareProtectableItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareProtectableItem.js @@ -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() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareProtectionPolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareProtectionPolicy.js index f25137e1b6..2000a959e3 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareProtectionPolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareProtectionPolicy.js @@ -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 + * @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() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareRecoveryPoint.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareRecoveryPoint.js index 8b8c6af330..edc2509836 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareRecoveryPoint.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareRecoveryPoint.js @@ -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() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareRestoreRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareRestoreRequest.js index 6e3eb1260b..db8e7b59dc 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareRestoreRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileShareRestoreRequest.js @@ -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() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileshareProtectedItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileshareProtectedItem.js index afa7b2650c..521efbc8bc 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileshareProtectedItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileshareProtectedItem.js @@ -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() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileshareProtectedItemExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileshareProtectedItemExtendedInfo.js index 4b318287f8..7ef98130ed 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureFileshareProtectedItemExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureFileshareProtectedItemExtendedInfo.js @@ -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() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMErrorInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMErrorInfo.js index 6b6d955939..f190d76235 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMErrorInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMErrorInfo.js @@ -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() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMHealthDetails.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMHealthDetails.js index e8272f563f..48d832b65c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMHealthDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMHealthDetails.js @@ -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() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMJob.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMJob.js index eca19b51e2..db125537a6 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMJob.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMJob.js @@ -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() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMJobExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMJobExtendedInfo.js index 63d42d4c8a..2ed1a86a12 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMJobExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMJobExtendedInfo.js @@ -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() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMJobTaskDetails.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMJobTaskDetails.js index 62ce4712d6..70f3f80212 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMJobTaskDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMJobTaskDetails.js @@ -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() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMProtectedItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMProtectedItem.js index 0cf8675a11..7269fcc5dc 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMProtectedItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMProtectedItem.js @@ -20,28 +20,29 @@ const models = require('./index'); class AzureIaaSVMProtectedItem extends models['ProtectedItem'] { /** * Create a AzureIaaSVMProtectedItem. - * @member {string} [friendlyName] Friendly name of the VM represented by + * @property {string} [friendlyName] Friendly name of the VM represented by * this backup item. - * @member {string} [virtualMachineId] Fully qualified ARM ID of the virtual - * machine represented by this item. - * @member {string} [protectionStatus] Backup status of this backup item. - * @member {string} [protectionState] Backup state of this backup item. + * @property {string} [virtualMachineId] Fully qualified ARM ID of the + * virtual machine represented by this 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] Health status of protected item. Possible - * values include: 'Passed', 'ActionRequired', 'ActionSuggested', 'Invalid' - * @member {array} [healthDetails] Health details on this backup item. - * @member {string} [lastBackupStatus] Last backup operation status. - * @member {date} [lastBackupTime] Timestamp of the last backup operation on - * this backup item. - * @member {string} [protectedItemDataId] Data ID of the protected item. - * @member {object} [extendedInfo] Additional information for this backup + * @property {string} [healthStatus] Health status of protected item. + * Possible values include: 'Passed', 'ActionRequired', 'ActionSuggested', + * 'Invalid' + * @property {array} [healthDetails] Health details on this backup item. + * @property {string} [lastBackupStatus] Last backup operation status. + * @property {date} [lastBackupTime] Timestamp of the last backup operation + * on this backup item. + * @property {string} [protectedItemDataId] Data ID of the protected item. + * @property {object} [extendedInfo] Additional information for this backup * item. - * @member {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy - * available for this backup item. - * @member {number} [extendedInfo.recoveryPointCount] Number of backup copies + * @property {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy * available for this backup item. - * @member {boolean} [extendedInfo.policyInconsistent] Specifies if backup + * @property {number} [extendedInfo.recoveryPointCount] Number of backup + * copies available for this backup item. + * @property {boolean} [extendedInfo.policyInconsistent] Specifies if backup * policy associated with the backup item is inconsistent. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMProtectedItemExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMProtectedItemExtendedInfo.js index 19d7702395..d79004a05a 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMProtectedItemExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMProtectedItemExtendedInfo.js @@ -17,11 +17,11 @@ class AzureIaaSVMProtectedItemExtendedInfo { /** * Create a AzureIaaSVMProtectedItemExtendedInfo. - * @member {date} [oldestRecoveryPoint] The oldest backup copy available for - * this backup item. - * @member {number} [recoveryPointCount] Number of backup copies available + * @property {date} [oldestRecoveryPoint] The oldest backup copy available * for this backup item. - * @member {boolean} [policyInconsistent] Specifies if backup policy + * @property {number} [recoveryPointCount] Number of backup copies available + * for this backup item. + * @property {boolean} [policyInconsistent] Specifies if backup policy * associated with the backup item is inconsistent. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMProtectionPolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMProtectionPolicy.js index c1d27bbf78..1e81b7739d 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMProtectionPolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureIaaSVMProtectionPolicy.js @@ -20,17 +20,17 @@ const models = require('./index'); class AzureIaaSVMProtectionPolicy extends models['ProtectionPolicy'] { /** * Create a AzureIaaSVMProtectionPolicy. - * @member {object} [schedulePolicy] Backup schedule specified as part of + * @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 {number} [instantRpRetentionRangeInDays] Instant RP retention + * @property {number} [instantRpRetentionRangeInDays] Instant RP retention * policy range in days - * @member {string} [timeZone] TimeZone optional input as string. For + * @property {string} [timeZone] TimeZone optional input as string. For * example: TimeZone = "Pacific Standard Time". */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureResourceProtectionIntent.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureResourceProtectionIntent.js index 4550f5bb74..09a8cce78b 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureResourceProtectionIntent.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureResourceProtectionIntent.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzureResourceProtectionIntent extends models['ProtectionIntent'] { /** * Create a AzureResourceProtectionIntent. - * @member {string} [friendlyName] Friendly name of the VM represented by + * @property {string} [friendlyName] Friendly name of the VM represented by * this backup item. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureSqlProtectedItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureSqlProtectedItem.js index db52cb43ce..bf9c90d8c8 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureSqlProtectedItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureSqlProtectedItem.js @@ -20,18 +20,18 @@ const models = require('./index'); class AzureSqlProtectedItem extends models['ProtectedItem'] { /** * Create a AzureSqlProtectedItem. - * @member {string} [protectedItemDataId] Internal ID of a backup item. Used - * by Azure SQL Backup engine to contact Recovery Services. - * @member {string} [protectionState] Backup state of the backed up item. + * @property {string} [protectedItemDataId] Internal ID of a backup item. + * Used by Azure SQL Backup engine to contact Recovery Services. + * @property {string} [protectionState] Backup state of the backed up item. * Possible values include: 'Invalid', 'IRPending', 'Protected', * 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' - * @member {object} [extendedInfo] Additional information for this backup + * @property {object} [extendedInfo] Additional information for 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] State of the backup policy + * @property {string} [extendedInfo.policyState] State of the backup policy * associated with this backup item. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureSqlProtectedItemExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureSqlProtectedItemExtendedInfo.js index 0575805f87..834b63a8d9 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureSqlProtectedItemExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureSqlProtectedItemExtendedInfo.js @@ -17,12 +17,12 @@ class AzureSqlProtectedItemExtendedInfo { /** * Create a AzureSqlProtectedItemExtendedInfo. - * @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] State of the backup policy associated with - * this backup item. + * @property {string} [policyState] State of the backup policy associated + * with this backup item. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureSqlProtectionPolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureSqlProtectionPolicy.js index 45a4018ff3..7a2b84ab59 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureSqlProtectionPolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureSqlProtectionPolicy.js @@ -20,8 +20,8 @@ const models = require('./index'); class AzureSqlProtectionPolicy extends models['ProtectionPolicy'] { /** * Create a AzureSqlProtectionPolicy. - * @member {object} [retentionPolicy] Retention policy details. - * @member {string} [retentionPolicy.retentionPolicyType] Polymorphic + * @property {object} [retentionPolicy] Retention policy details. + * @property {string} [retentionPolicy.retentionPolicyType] Polymorphic * Discriminator */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageContainer.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageContainer.js index 3eed0c5338..1871fbe742 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageContainer.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageContainer.js @@ -20,11 +20,11 @@ const models = require('./index'); class AzureStorageContainer extends models['ProtectionContainer'] { /** * Create a AzureStorageContainer. - * @member {string} [sourceResourceId] Fully qualified ARM url. - * @member {string} [storageAccountVersion] Storage account version. - * @member {string} [resourceGroup] Resource group name of Recovery Services - * Vault. - * @member {number} [protectedItemCount] Number of items backed up in this + * @property {string} [sourceResourceId] Fully qualified ARM url. + * @property {string} [storageAccountVersion] Storage account version. + * @property {string} [resourceGroup] Resource group name of Recovery + * Services Vault. + * @property {number} [protectedItemCount] Number of items backed up in this * container. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageErrorInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageErrorInfo.js index d7644f3d9f..c22b89edb8 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageErrorInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageErrorInfo.js @@ -17,9 +17,9 @@ class AzureStorageErrorInfo { /** * Create a AzureStorageErrorInfo. - * @member {number} [errorCode] Error code. - * @member {string} [errorString] Localized error string. - * @member {array} [recommendations] List of localized recommendations for + * @property {number} [errorCode] Error code. + * @property {string} [errorString] Localized error string. + * @property {array} [recommendations] List of localized recommendations for * above error code. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageJob.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageJob.js index db4c3d0580..ae2afd1fde 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageJob.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageJob.js @@ -20,19 +20,19 @@ const models = require('./index'); class AzureStorageJob extends models['Job'] { /** * Create a AzureStorageJob. - * @member {moment.duration} [duration] Time elapsed during the execution of - * 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} [storageAccountName] Specifies friendly name of the + * @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} [storageAccountName] Specifies friendly name of the * storage account. - * @member {string} [storageAccountVersion] Specifies whether the Storage + * @property {string} [storageAccountVersion] Specifies whether the Storage * account is a Classic or an Azure Resource Manager Storage account. - * @member {object} [extendedInfo] Additional information about the job. - * @member {array} [extendedInfo.tasksList] List of tasks for this job - * @member {object} [extendedInfo.propertyBag] Job properties. - * @member {string} [extendedInfo.dynamicErrorMessage] Non localized error + * @property {object} [extendedInfo] Additional information about the job. + * @property {array} [extendedInfo.tasksList] List of tasks for this job + * @property {object} [extendedInfo.propertyBag] Job properties. + * @property {string} [extendedInfo.dynamicErrorMessage] Non localized error * message on job execution. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageJobExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageJobExtendedInfo.js index cdfbbed485..c5e8be90b9 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageJobExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageJobExtendedInfo.js @@ -17,10 +17,10 @@ class AzureStorageJobExtendedInfo { /** * Create a AzureStorageJobExtendedInfo. - * @member {array} [tasksList] List of tasks for this job - * @member {object} [propertyBag] Job properties. - * @member {string} [dynamicErrorMessage] Non localized error message on job - * execution. + * @property {array} [tasksList] List of tasks for this job + * @property {object} [propertyBag] Job properties. + * @property {string} [dynamicErrorMessage] Non localized error message on + * job execution. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageJobTaskDetails.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageJobTaskDetails.js index 186e5ce809..d0a0d3250c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageJobTaskDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureStorageJobTaskDetails.js @@ -17,8 +17,8 @@ class AzureStorageJobTaskDetails { /** * Create a AzureStorageJobTaskDetails. - * @member {string} [taskId] The task display name. - * @member {string} [status] The status. + * @property {string} [taskId] The task display name. + * @property {string} [status] The status. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureVMResourceFeatureSupportRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureVMResourceFeatureSupportRequest.js index 0c8226b81a..b23b5a974c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureVMResourceFeatureSupportRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureVMResourceFeatureSupportRequest.js @@ -20,9 +20,9 @@ const models = require('./index'); class AzureVMResourceFeatureSupportRequest extends models['FeatureSupportRequest'] { /** * Create a AzureVMResourceFeatureSupportRequest. - * @member {string} [vmSize] Size of the resource: VM size(A/D series etc) in - * case of IaasVM - * @member {string} [vmSku] SKUs (Premium/Managed etc) in case of IaasVM + * @property {string} [vmSize] Size of the resource: VM size(A/D series etc) + * in case of IaasVM + * @property {string} [vmSku] SKUs (Premium/Managed etc) in case of IaasVM */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureVMResourceFeatureSupportResponse.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureVMResourceFeatureSupportResponse.js index 7a288a505b..cb25b4b0da 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureVMResourceFeatureSupportResponse.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureVMResourceFeatureSupportResponse.js @@ -17,7 +17,7 @@ class AzureVMResourceFeatureSupportResponse { /** * Create a AzureVMResourceFeatureSupportResponse. - * @member {string} [supportStatus] Support status of feature. Possible + * @property {string} [supportStatus] Support status of feature. Possible * values include: 'Invalid', 'Supported', 'DefaultOFF', 'DefaultON', * 'NotSupported' */ diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadItem.js index aab8eb3773..94953725b4 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadItem.js @@ -20,14 +20,14 @@ const models = require('./index'); class AzureVmWorkloadItem extends models['WorkloadItem'] { /** * Create a AzureVmWorkloadItem. - * @member {string} [parentName] Name for instance or AG - * @member {string} [serverName] Host/Cluster Name for instance or AG - * @member {boolean} [isAutoProtectable] Indicates if workload item is + * @property {string} [parentName] Name for instance or AG + * @property {string} [serverName] Host/Cluster Name for instance or AG + * @property {boolean} [isAutoProtectable] Indicates if workload item is * auto-protectable - * @member {number} [subinquireditemcount] For instance or AG, indicates - * number of DB's present - * @member {number} [subWorkloadItemCount] For instance or AG, indicates - * number of DB's to be protected + * @property {number} [subinquireditemcount] For instance or AG, indicates + * number of DBs present + * @property {number} [subWorkloadItemCount] For instance or AG, indicates + * number of DBs to be protected */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectableItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectableItem.js index ff3486b7f0..d56e267628 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectableItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectableItem.js @@ -20,27 +20,28 @@ const models = require('./index'); class AzureVmWorkloadProtectableItem extends models['WorkloadProtectableItem'] { /** * Create a AzureVmWorkloadProtectableItem. - * @member {string} [parentName] Name for instance or AG - * @member {string} [parentUniqueName] Parent Unique Name is added to provide - * the service formatted URI Name of the Parent + * @property {string} [parentName] Name for instance or AG + * @property {string} [parentUniqueName] Parent Unique Name is added to + * provide the service formatted URI Name of the Parent * Only Applicable for data bases where the parent would be either Instance * or a SQL AG. - * @member {string} [serverName] Host/Cluster Name for instance or AG - * @member {boolean} [isAutoProtectable] Indicates if protectable item is + * @property {string} [serverName] Host/Cluster Name for instance or AG + * @property {boolean} [isAutoProtectable] Indicates if protectable item is * auto-protectable - * @member {boolean} [isAutoProtected] Indicates if protectable item is + * @property {boolean} [isAutoProtected] Indicates if protectable item is * auto-protected - * @member {number} [subinquireditemcount] For instance or AG, indicates - * number of DB's present - * @member {number} [subprotectableitemcount] For instance or AG, indicates - * number of DB's to be protected - * @member {object} [prebackupvalidation] Pre-backup validation for + * @property {number} [subinquireditemcount] For instance or AG, indicates + * number of DBs present + * @property {number} [subprotectableitemcount] For instance or AG, indicates + * number of DBs to be protected + * @property {object} [prebackupvalidation] Pre-backup validation for * protectable objects - * @member {string} [prebackupvalidation.status] Status of protectable item, - * i.e. InProgress,Succeeded,Failed. Possible values include: 'Invalid', - * 'Success', 'Failed' - * @member {string} [prebackupvalidation.code] Error code of protectable item - * @member {string} [prebackupvalidation.message] Message corresponding to + * @property {string} [prebackupvalidation.status] Status of protectable + * item, i.e. InProgress,Succeeded,Failed. Possible values include: + * 'Invalid', 'Success', 'Failed' + * @property {string} [prebackupvalidation.code] Error code of protectable + * item + * @property {string} [prebackupvalidation.message] Message corresponding to * the error code for the protectable item */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectedItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectedItem.js index 465e2d95e9..cffe918605 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectedItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectedItem.js @@ -20,40 +20,40 @@ const models = require('./index'); class AzureVmWorkloadProtectedItem extends models['ProtectedItem'] { /** * Create a AzureVmWorkloadProtectedItem. - * @member {string} [friendlyName] Friendly name of the DB represented by + * @property {string} [friendlyName] Friendly name of the DB represented by * this backup item. - * @member {string} [serverName] Host/Cluster Name for instance or AG - * @member {string} [parentName] Parent name of the DB such as Instance or + * @property {string} [serverName] Host/Cluster Name for instance or AG + * @property {string} [parentName] Parent name of the DB such as Instance or * Availability Group. - * @member {string} [parentType] Parent type of protected item, example: for - * a DB, standalone server or distributed - * @member {string} [protectionStatus] Backup status of this backup item. - * @member {string} [protectionState] Backup state of this backup item. + * @property {string} [parentType] Parent type of protected item, example: + * for a DB, standalone server or distributed + * @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} [lastBackupStatus] Last backup operation status. Possible - * values: Healthy, Unhealthy. Possible values include: 'Invalid', 'Healthy', - * 'Unhealthy', 'IRPending' - * @member {date} [lastBackupTime] Timestamp of the last backup operation on - * this backup item. - * @member {object} [lastBackupErrorDetail] Error details in last backup - * @member {string} [lastBackupErrorDetail.code] Error code. - * @member {string} [lastBackupErrorDetail.message] Error Message related to - * the Code. - * @member {array} [lastBackupErrorDetail.recommendations] List of + * @property {string} [lastBackupStatus] Last backup operation status. + * Possible values: Healthy, Unhealthy. Possible values include: 'Invalid', + * 'Healthy', 'Unhealthy', 'IRPending' + * @property {date} [lastBackupTime] Timestamp of the last backup operation + * on this backup item. + * @property {object} [lastBackupErrorDetail] Error details in last backup + * @property {string} [lastBackupErrorDetail.code] Error code. + * @property {string} [lastBackupErrorDetail.message] Error Message related + * to the Code. + * @property {array} [lastBackupErrorDetail.recommendations] List of * recommendation strings. - * @member {string} [protectedItemDataSourceId] Data ID of the protected + * @property {string} [protectedItemDataSourceId] Data ID of the protected * item. - * @member {string} [protectedItemHealthStatus] Health status of the backup + * @property {string} [protectedItemHealthStatus] Health status of the backup * item, evaluated based on last heartbeat received. Possible values include: * 'Invalid', 'Healthy', 'Unhealthy', 'NotReachable', 'IRPending' - * @member {object} [extendedInfo] Additional information for this backup + * @property {object} [extendedInfo] Additional information for this backup * item. - * @member {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy - * available for this backup item. - * @member {number} [extendedInfo.recoveryPointCount] Number of backup copies + * @property {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy * available for this backup item. - * @member {string} [extendedInfo.policyState] Indicates consistency of + * @property {number} [extendedInfo.recoveryPointCount] Number of backup + * copies available for this backup item. + * @property {string} [extendedInfo.policyState] Indicates consistency of * policy object and policy applied to this backup item. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectedItemExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectedItemExtendedInfo.js index a1e7deace1..b57dccd0ca 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectedItemExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectedItemExtendedInfo.js @@ -17,12 +17,12 @@ class AzureVmWorkloadProtectedItemExtendedInfo { /** * Create a AzureVmWorkloadProtectedItemExtendedInfo. - * @member {date} [oldestRecoveryPoint] The oldest backup copy available for - * this backup item. - * @member {number} [recoveryPointCount] Number of backup copies available + * @property {date} [oldestRecoveryPoint] The oldest backup copy available * for this backup item. - * @member {string} [policyState] Indicates consistency of policy object and - * policy applied to this backup item. + * @property {number} [recoveryPointCount] Number of backup copies available + * for this backup item. + * @property {string} [policyState] Indicates consistency of policy object + * and policy applied to this backup item. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectionPolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectionPolicy.js index 7f4c7a0737..d71877468a 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectionPolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadProtectionPolicy.js @@ -20,19 +20,19 @@ const models = require('./index'); class AzureVmWorkloadProtectionPolicy extends models['ProtectionPolicy'] { /** * Create a AzureVmWorkloadProtectionPolicy. - * @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} [settings] Common settings for the backup management - * @member {string} [settings.timeZone] TimeZone optional input as string. + * @property {object} [settings] Common settings for the backup management + * @property {string} [settings.timeZone] TimeZone optional input as string. * For example: TimeZone = "Pacific Standard Time". - * @member {boolean} [settings.issqlcompression] SQL compression flag - * @member {boolean} [settings.isCompression] Workload compression flag. This - * has been added so that 'isSqlCompression' + * @property {boolean} [settings.issqlcompression] SQL compression flag + * @property {boolean} [settings.isCompression] Workload compression flag. + * This has been added so that 'isSqlCompression' * will be deprecated once clients upgrade to consider this flag. - * @member {array} [subProtectionPolicy] List of sub-protection policies + * @property {array} [subProtectionPolicy] List of sub-protection policies * which includes schedule and retention */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadSQLDatabaseProtectedItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadSQLDatabaseProtectedItem.js index 08b58d1863..e4458d3cdc 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadSQLDatabaseProtectedItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadSQLDatabaseProtectedItem.js @@ -20,39 +20,39 @@ const models = require('./index'); class AzureVmWorkloadSQLDatabaseProtectedItem extends models['ProtectedItem'] { /** * Create a AzureVmWorkloadSQLDatabaseProtectedItem. - * @member {string} [friendlyName] Friendly name of the DB represented by + * @property {string} [friendlyName] Friendly name of the DB represented by * this backup item. - * @member {string} [serverName] Host/Cluster Name for instance or AG - * @member {string} [parentName] Parent name of the DB such as Instance or + * @property {string} [serverName] Host/Cluster Name for instance or AG + * @property {string} [parentName] Parent name of the DB such as Instance or * Availability Group. - * @member {string} [parentType] Parent type of DB, SQLAG or StandAlone - * @member {string} [protectionStatus] Backup status of this backup item. - * @member {string} [protectionState] Backup state of this backup item. + * @property {string} [parentType] Parent type of DB, SQLAG or StandAlone + * @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} [lastBackupStatus] Last backup operation status. Possible - * values: Healthy, Unhealthy. Possible values include: 'Invalid', 'Healthy', - * 'Unhealthy', 'IRPending' - * @member {date} [lastBackupTime] Timestamp of the last backup operation on - * this backup item. - * @member {object} [lastBackupErrorDetail] Error details in last backup - * @member {string} [lastBackupErrorDetail.code] Error code. - * @member {string} [lastBackupErrorDetail.message] Error Message related to - * the Code. - * @member {array} [lastBackupErrorDetail.recommendations] List of + * @property {string} [lastBackupStatus] Last backup operation status. + * Possible values: Healthy, Unhealthy. Possible values include: 'Invalid', + * 'Healthy', 'Unhealthy', 'IRPending' + * @property {date} [lastBackupTime] Timestamp of the last backup operation + * on this backup item. + * @property {object} [lastBackupErrorDetail] Error details in last backup + * @property {string} [lastBackupErrorDetail.code] Error code. + * @property {string} [lastBackupErrorDetail.message] Error Message related + * to the Code. + * @property {array} [lastBackupErrorDetail.recommendations] List of * recommendation strings. - * @member {string} [protectedItemDataSourceId] Data ID of the protected + * @property {string} [protectedItemDataSourceId] Data ID of the protected * item. - * @member {string} [protectedItemHealthStatus] Health status of the backup + * @property {string} [protectedItemHealthStatus] Health status of the backup * item, evaluated based on last heartbeat received. Possible values include: * 'Invalid', 'Healthy', 'Unhealthy', 'NotReachable', 'IRPending' - * @member {object} [extendedInfo] Additional information for this backup + * @property {object} [extendedInfo] Additional information for this backup * item. - * @member {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy - * available for this backup item. - * @member {number} [extendedInfo.recoveryPointCount] Number of backup copies + * @property {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy * available for this backup item. - * @member {string} [extendedInfo.policyState] Indicates consistency of + * @property {number} [extendedInfo.recoveryPointCount] Number of backup + * copies available for this backup item. + * @property {string} [extendedInfo.policyState] Indicates consistency of * policy object and policy applied to this backup item. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadSQLInstanceWorkloadItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadSQLInstanceWorkloadItem.js index 312fd96266..8fc7f29af3 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadSQLInstanceWorkloadItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureVmWorkloadSQLInstanceWorkloadItem.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzureVmWorkloadSQLInstanceWorkloadItem extends models['AzureVmWorkloadItem'] { /** * Create a AzureVmWorkloadSQLInstanceWorkloadItem. - * @member {array} [dataDirectoryPaths] Data Directory Paths for default + * @property {array} [dataDirectoryPaths] Data Directory Paths for default * directories */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadBackupRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadBackupRequest.js index 44e3e4dddc..a1ae300206 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadBackupRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadBackupRequest.js @@ -20,11 +20,11 @@ const models = require('./index'); class AzureWorkloadBackupRequest extends models['BackupRequest'] { /** * Create a AzureWorkloadBackupRequest. - * @member {string} [backupType] Type of backup, viz. Full, Differential, Log - * or CopyOnlyFull. Possible values include: 'Invalid', 'Full', + * @property {string} [backupType] Type of backup, viz. Full, Differential, + * Log or CopyOnlyFull. Possible values include: 'Invalid', 'Full', * 'Differential', 'Log', 'CopyOnlyFull' - * @member {boolean} [enableCompression] Bool for Compression setting - * @member {date} [recoveryPointExpiryTimeInUTC] Backup copy will expire + * @property {boolean} [enableCompression] Bool for Compression setting + * @property {date} [recoveryPointExpiryTimeInUTC] Backup copy will expire * after the time specified (UTC). */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadContainer.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadContainer.js index da2e358e95..e800c58737 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadContainer.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadContainer.js @@ -20,32 +20,32 @@ const models = require('./index'); class AzureWorkloadContainer extends models['ProtectionContainer'] { /** * Create a AzureWorkloadContainer. - * @member {string} [sourceResourceId] ARM ID of the virtual machine + * @property {string} [sourceResourceId] ARM ID of the virtual machine * represented by this Azure Workload Container - * @member {date} [lastUpdatedTime] Time stamp when this container was + * @property {date} [lastUpdatedTime] Time stamp when this container was * updated. - * @member {object} [extendedInfo] Additional details of a workload + * @property {object} [extendedInfo] Additional details of a workload * container. - * @member {string} [extendedInfo.hostServerName] Host Os Name in case of + * @property {string} [extendedInfo.hostServerName] Host Os Name in case of * Stand Alone and Cluster Name in case of distributed container. - * @member {object} [extendedInfo.inquiryInfo] Inquiry Status for the + * @property {object} [extendedInfo.inquiryInfo] Inquiry Status for the * container. - * @member {string} [extendedInfo.inquiryInfo.status] Inquiry Status for this - * container such as + * @property {string} [extendedInfo.inquiryInfo.status] Inquiry Status for + * this container such as * InProgress | Failed | Succeeded - * @member {object} [extendedInfo.inquiryInfo.errorDetail] Error Details if + * @property {object} [extendedInfo.inquiryInfo.errorDetail] Error Details if * the Status is non-success. - * @member {string} [extendedInfo.inquiryInfo.errorDetail.code] Error code. - * @member {string} [extendedInfo.inquiryInfo.errorDetail.message] Error + * @property {string} [extendedInfo.inquiryInfo.errorDetail.code] Error code. + * @property {string} [extendedInfo.inquiryInfo.errorDetail.message] Error * Message related to the Code. - * @member {array} [extendedInfo.inquiryInfo.errorDetail.recommendations] + * @property {array} [extendedInfo.inquiryInfo.errorDetail.recommendations] * List of recommendation strings. - * @member {array} [extendedInfo.inquiryInfo.inquiryDetails] Inquiry Details - * which will have workload specific details. + * @property {array} [extendedInfo.inquiryInfo.inquiryDetails] Inquiry + * Details which will have workload specific details. * For e.g. - For SQL and oracle this will contain different details. - * @member {array} [extendedInfo.nodesList] List of the nodes in case of + * @property {array} [extendedInfo.nodesList] List of the nodes in case of * distributed container. - * @member {string} [workloadType] Workload type for which registration was + * @property {string} [workloadType] Workload type for which registration was * sent. Possible values include: 'Invalid', 'VM', 'FileFolder', * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', * 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadContainerExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadContainerExtendedInfo.js index 773d8ee112..e1c0f65ec7 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadContainerExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadContainerExtendedInfo.js @@ -17,23 +17,23 @@ class AzureWorkloadContainerExtendedInfo { /** * Create a AzureWorkloadContainerExtendedInfo. - * @member {string} [hostServerName] Host Os Name in case of Stand Alone and - * Cluster Name in case of distributed container. - * @member {object} [inquiryInfo] Inquiry Status for the container. - * @member {string} [inquiryInfo.status] Inquiry Status for this container + * @property {string} [hostServerName] Host Os Name in case of Stand Alone + * and Cluster Name in case of distributed container. + * @property {object} [inquiryInfo] Inquiry Status for the container. + * @property {string} [inquiryInfo.status] Inquiry Status for this container * such as * InProgress | Failed | Succeeded - * @member {object} [inquiryInfo.errorDetail] Error Details if the Status is - * non-success. - * @member {string} [inquiryInfo.errorDetail.code] Error code. - * @member {string} [inquiryInfo.errorDetail.message] Error Message related + * @property {object} [inquiryInfo.errorDetail] Error Details if the Status + * is non-success. + * @property {string} [inquiryInfo.errorDetail.code] Error code. + * @property {string} [inquiryInfo.errorDetail.message] Error Message related * to the Code. - * @member {array} [inquiryInfo.errorDetail.recommendations] List of + * @property {array} [inquiryInfo.errorDetail.recommendations] List of * recommendation strings. - * @member {array} [inquiryInfo.inquiryDetails] Inquiry Details which will + * @property {array} [inquiryInfo.inquiryDetails] Inquiry Details which will * have workload specific details. * For e.g. - For SQL and oracle this will contain different details. - * @member {array} [nodesList] List of the nodes in case of distributed + * @property {array} [nodesList] List of the nodes in case of distributed * container. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadErrorInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadErrorInfo.js index 46903ee351..783e3cb190 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadErrorInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadErrorInfo.js @@ -17,13 +17,13 @@ class AzureWorkloadErrorInfo { /** * Create a AzureWorkloadErrorInfo. - * @member {number} [errorCode] Error code. - * @member {string} [errorString] Localized error string. - * @member {string} [errorTitle] Title: Typically, the entity that the error - * pertains to. - * @member {array} [recommendations] List of localized recommendations for + * @property {number} [errorCode] Error code. + * @property {string} [errorString] Localized error string. + * @property {string} [errorTitle] Title: Typically, the entity that the + * error pertains to. + * @property {array} [recommendations] List of localized recommendations for * above error code. - * @member {string} [additionalDetails] Additional details for above error + * @property {string} [additionalDetails] Additional details for above error * code. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadJob.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadJob.js index f9fa2a0f60..66f995eb0b 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadJob.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadJob.js @@ -20,16 +20,16 @@ const models = require('./index'); class AzureWorkloadJob extends models['Job'] { /** * Create a AzureWorkloadJob. - * @member {string} [workloadType] Workload type of the job - * @member {moment.duration} [duration] Time elapsed during the execution of - * 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 {object} [extendedInfo] Additional information about the job. - * @member {array} [extendedInfo.tasksList] List of tasks for this job - * @member {object} [extendedInfo.propertyBag] Job properties. - * @member {string} [extendedInfo.dynamicErrorMessage] Non localized error + * @property {string} [workloadType] Workload type of the job + * @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 {object} [extendedInfo] Additional information about the job. + * @property {array} [extendedInfo.tasksList] List of tasks for this job + * @property {object} [extendedInfo.propertyBag] Job properties. + * @property {string} [extendedInfo.dynamicErrorMessage] Non localized error * message on job execution. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadJobExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadJobExtendedInfo.js index 965cf8515a..ad5c18684e 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadJobExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadJobExtendedInfo.js @@ -17,10 +17,10 @@ class AzureWorkloadJobExtendedInfo { /** * Create a AzureWorkloadJobExtendedInfo. - * @member {array} [tasksList] List of tasks for this job - * @member {object} [propertyBag] Job properties. - * @member {string} [dynamicErrorMessage] Non localized error message on job - * execution. + * @property {array} [tasksList] List of tasks for this job + * @property {object} [propertyBag] Job properties. + * @property {string} [dynamicErrorMessage] Non localized error message on + * job execution. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadJobTaskDetails.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadJobTaskDetails.js index 42e03a407a..071a31cfd4 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadJobTaskDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadJobTaskDetails.js @@ -17,8 +17,8 @@ class AzureWorkloadJobTaskDetails { /** * Create a AzureWorkloadJobTaskDetails. - * @member {string} [taskId] The task display name. - * @member {string} [status] The status. + * @property {string} [taskId] The task display name. + * @property {string} [status] The status. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadRecoveryPoint.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadRecoveryPoint.js index def86d57bb..fa6f81099c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadRecoveryPoint.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadRecoveryPoint.js @@ -13,17 +13,17 @@ const models = require('./index'); /** - * Workload specific recoverypoint, specifcally encaspulates full/diff - * recoverypoint + * Workload specific recovery point, specifically encapsulates full/diff + * recovery point * * @extends models['RecoveryPoint'] */ class AzureWorkloadRecoveryPoint extends models['RecoveryPoint'] { /** * Create a AzureWorkloadRecoveryPoint. - * @member {date} [recoveryPointTimeInUTC] UTC time at which recoverypoint + * @property {date} [recoveryPointTimeInUTC] UTC time at which recovery point * was created - * @member {string} [type] Type of restore point. Possible values include: + * @property {string} [type] Type of restore point. Possible values include: * 'Invalid', 'Full', 'Log', 'Differential' */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadRestoreRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadRestoreRequest.js index dc0ff7cedc..963802847c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadRestoreRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadRestoreRequest.js @@ -20,12 +20,12 @@ const models = require('./index'); class AzureWorkloadRestoreRequest extends models['RestoreRequest'] { /** * Create a AzureWorkloadRestoreRequest. - * @member {string} [recoveryType] OLR/ALR, RestoreDisks is invalid option. + * @property {string} [recoveryType] OLR/ALR, RestoreDisks is invalid option. * Possible values include: 'Invalid', 'OriginalLocation', * 'AlternateLocation', 'RestoreDisks' - * @member {string} [sourceResourceId] Fully qualified ARM ID of the VM on + * @property {string} [sourceResourceId] Fully qualified ARM ID of the VM on * which workload that was running is being recovered. - * @member {object} [propertyBag] Workload specific property bag. + * @property {object} [propertyBag] Workload specific property bag. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaPointInTimeRecoveryPoint.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaPointInTimeRecoveryPoint.js index 626588c4c2..a2efd05aae 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaPointInTimeRecoveryPoint.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaPointInTimeRecoveryPoint.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzureWorkloadSAPHanaPointInTimeRecoveryPoint extends models['AzureWorkloadSAPHanaRecoveryPoint'] { /** * Create a AzureWorkloadSAPHanaPointInTimeRecoveryPoint. - * @member {array} [timeRanges] List of log ranges + * @property {array} [timeRanges] List of log ranges */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaPointInTimeRestoreRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaPointInTimeRestoreRequest.js index e095fbdd5f..aa82084797 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaPointInTimeRestoreRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaPointInTimeRestoreRequest.js @@ -21,7 +21,7 @@ const models = require('./index'); class AzureWorkloadSAPHanaPointInTimeRestoreRequest extends models['AzureWorkloadSAPHanaRestoreRequest'] { /** * Create a AzureWorkloadSAPHanaPointInTimeRestoreRequest. - * @member {date} [pointInTime] PointInTime value + * @property {date} [pointInTime] PointInTime value */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaRecoveryPoint.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaRecoveryPoint.js index df7a0203d5..5284239804 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaRecoveryPoint.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaRecoveryPoint.js @@ -13,17 +13,17 @@ const models = require('./index'); /** - * SAPHana specific recoverypoint, specifcally encaspulates full/diff - * recoverypoints + * SAPHana specific recovery point, specifically encapsulates full/diff + * recovery points * * @extends models['RecoveryPoint'] */ class AzureWorkloadSAPHanaRecoveryPoint extends models['RecoveryPoint'] { /** * Create a AzureWorkloadSAPHanaRecoveryPoint. - * @member {date} [recoveryPointTimeInUTC] UTC time at which recoverypoint + * @property {date} [recoveryPointTimeInUTC] UTC time at which recovery point * was created - * @member {string} [type] Type of restore point. Possible values include: + * @property {string} [type] Type of restore point. Possible values include: * 'Invalid', 'Full', 'Log', 'Differential' */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaRestoreRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaRestoreRequest.js index 62e346e33c..82bb4f974d 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaRestoreRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSAPHanaRestoreRequest.js @@ -20,20 +20,20 @@ const models = require('./index'); class AzureWorkloadSAPHanaRestoreRequest extends models['RestoreRequest'] { /** * Create a AzureWorkloadSAPHanaRestoreRequest. - * @member {object} [targetInfo] Details of target database - * @member {string} [targetInfo.overwriteOption] Can Overwrite if Target + * @property {object} [targetInfo] Details of target database + * @property {string} [targetInfo.overwriteOption] Can Overwrite if Target * DataBase already exists. Possible values include: 'Invalid', * 'FailOnConflict', 'Overwrite' - * @member {string} [targetInfo.containerId] Resource Id name of the + * @property {string} [targetInfo.containerId] Resource Id name of the * container in which Target DataBase resides - * @member {string} [targetInfo.databaseName] Database name + * @property {string} [targetInfo.databaseName] Database name * InstanceName/DataBaseName for SQL or System/DbName for SAP Hana - * @member {string} [recoveryType] OLR/ALR, RestoreDisks is invalid option. + * @property {string} [recoveryType] OLR/ALR, RestoreDisks is invalid option. * Possible values include: 'Invalid', 'OriginalLocation', * 'AlternateLocation', 'RestoreDisks' - * @member {string} [sourceResourceId] Fully qualified ARM ID of the VM on + * @property {string} [sourceResourceId] Fully qualified ARM ID of the VM on * which workload that was running is being recovered. - * @member {object} [propertyBag] Workload specific property bag. + * @property {object} [propertyBag] Workload specific property bag. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLAutoProtectionIntent.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLAutoProtectionIntent.js index 389360b9c1..686cf27ca7 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLAutoProtectionIntent.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLAutoProtectionIntent.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzureWorkloadSQLAutoProtectionIntent extends models['AzureWorkloadAutoProtectionIntent'] { /** * Create a AzureWorkloadSQLAutoProtectionIntent. - * @member {string} [workloadItemType] Workload item type of the item for + * @property {string} [workloadItemType] Workload item type of the item for * which intent is to be set. Possible values include: 'Invalid', * 'SQLInstance', 'SQLDataBase', 'SAPHanaSystem', 'SAPHanaDatabase' */ diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLPointInTimeRecoveryPoint.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLPointInTimeRecoveryPoint.js index 5e0a4a920d..6ea81e417d 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLPointInTimeRecoveryPoint.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLPointInTimeRecoveryPoint.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzureWorkloadSQLPointInTimeRecoveryPoint extends models['AzureWorkloadSQLRecoveryPoint'] { /** * Create a AzureWorkloadSQLPointInTimeRecoveryPoint. - * @member {array} [timeRanges] List of log ranges + * @property {array} [timeRanges] List of log ranges */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLPointInTimeRestoreRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLPointInTimeRestoreRequest.js index 13c2c93244..755c287dfa 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLPointInTimeRestoreRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLPointInTimeRestoreRequest.js @@ -21,7 +21,7 @@ const models = require('./index'); class AzureWorkloadSQLPointInTimeRestoreRequest extends models['AzureWorkloadSQLRestoreRequest'] { /** * Create a AzureWorkloadSQLPointInTimeRestoreRequest. - * @member {date} [pointInTime] PointInTime value + * @property {date} [pointInTime] PointInTime value */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLRecoveryPoint.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLRecoveryPoint.js index 81948206c2..3950a2e726 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLRecoveryPoint.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLRecoveryPoint.js @@ -13,22 +13,22 @@ const models = require('./index'); /** - * SQL specific recoverypoint, specifcally encaspulates full/diff recoverypoint - * alongwith extended info + * SQL specific recovery point, specifically encapsulates full/diff recovery + * point along with extended info * * @extends models['AzureWorkloadRecoveryPoint'] */ class AzureWorkloadSQLRecoveryPoint extends models['AzureWorkloadRecoveryPoint'] { /** * Create a AzureWorkloadSQLRecoveryPoint. - * @member {object} [extendedInfo] Extended Info that provides data directory - * details. Will be populated in two cases: + * @property {object} [extendedInfo] Extended Info that provides data + * directory details. Will be populated in two cases: * When a specific recovery point is accessed using GetRecoveryPoint * Or when ListRecoveryPoints is called for Log RP only with ExtendedInfo * query filter - * @member {date} [extendedInfo.dataDirectoryTimeInUTC] UTC time at which + * @property {date} [extendedInfo.dataDirectoryTimeInUTC] UTC time at which * data directory info was captured - * @member {array} [extendedInfo.dataDirectoryPaths] List of data directory + * @property {array} [extendedInfo.dataDirectoryPaths] List of data directory * paths during restore operation. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLRecoveryPointExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLRecoveryPointExtendedInfo.js index 1e4b189da4..21009c0e3e 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLRecoveryPointExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLRecoveryPointExtendedInfo.js @@ -17,9 +17,9 @@ class AzureWorkloadSQLRecoveryPointExtendedInfo { /** * Create a AzureWorkloadSQLRecoveryPointExtendedInfo. - * @member {date} [dataDirectoryTimeInUTC] UTC time at which data directory + * @property {date} [dataDirectoryTimeInUTC] UTC time at which data directory * info was captured - * @member {array} [dataDirectoryPaths] List of data directory paths during + * @property {array} [dataDirectoryPaths] List of data directory paths during * restore operation. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLRestoreRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLRestoreRequest.js index d61007329e..1bb73c78c7 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLRestoreRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/azureWorkloadSQLRestoreRequest.js @@ -20,19 +20,20 @@ const models = require('./index'); class AzureWorkloadSQLRestoreRequest extends models['AzureWorkloadRestoreRequest'] { /** * Create a AzureWorkloadSQLRestoreRequest. - * @member {boolean} [shouldUseAlternateTargetLocation] Default option set to - * true. If this is set to false, alternate data directory must be provided - * @member {boolean} [isNonRecoverable] SQL specific property where user can - * chose to set no-recovery when restore operation is tried - * @member {object} [targetInfo] Details of target database - * @member {string} [targetInfo.overwriteOption] Can Overwrite if Target + * @property {boolean} [shouldUseAlternateTargetLocation] Default option set + * to true. If this is set to false, alternate data directory must be + * provided + * @property {boolean} [isNonRecoverable] SQL specific property where user + * can chose to set no-recovery when restore operation is tried + * @property {object} [targetInfo] Details of target database + * @property {string} [targetInfo.overwriteOption] Can Overwrite if Target * DataBase already exists. Possible values include: 'Invalid', * 'FailOnConflict', 'Overwrite' - * @member {string} [targetInfo.containerId] Resource Id name of the + * @property {string} [targetInfo.containerId] Resource Id name of the * container in which Target DataBase resides - * @member {string} [targetInfo.databaseName] Database name + * @property {string} [targetInfo.databaseName] Database name * InstanceName/DataBaseName for SQL or System/DbName for SAP Hana - * @member {array} [alternateDirectoryPaths] Data directory details + * @property {array} [alternateDirectoryPaths] Data directory details */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/bEKDetails.js b/lib/services/recoveryServicesBackupManagement/lib/models/bEKDetails.js index 440191288e..389f10c447 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/bEKDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/bEKDetails.js @@ -11,16 +11,16 @@ 'use strict'; /** - * BEK is bitlocker encrpytion key. + * BEK is bitlocker encryption key. * */ class BEKDetails { /** * Create a BEKDetails. - * @member {string} [secretUrl] Secret is BEK. - * @member {string} [secretVaultId] ID of the Key Vault where this Secret is - * stored. - * @member {string} [secretData] BEK data. + * @property {string} [secretUrl] Secret is BEK. + * @property {string} [secretVaultId] ID of the Key Vault where this Secret + * is stored. + * @property {string} [secretData] BEK data. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/bMSBackupEngineQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/bMSBackupEngineQueryObject.js index 0338e77aaa..6732ea609c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/bMSBackupEngineQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/bMSBackupEngineQueryObject.js @@ -17,7 +17,7 @@ class BMSBackupEngineQueryObject { /** * Create a BMSBackupEngineQueryObject. - * @member {string} [expand] attribute to add extended info + * @property {string} [expand] attribute to add extended info */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/bMSBackupEnginesQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/bMSBackupEnginesQueryObject.js index db2d877887..9d993f6e1b 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/bMSBackupEnginesQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/bMSBackupEnginesQueryObject.js @@ -17,12 +17,12 @@ class BMSBackupEnginesQueryObject { /** * Create a BMSBackupEnginesQueryObject. - * @member {string} [backupManagementType] Backup management type for the + * @property {string} [backupManagementType] Backup management type for the * backup engine. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', * 'DefaultBackup' - * @member {string} [friendlyName] Friendly name of the backup engine. - * @member {string} [expand] Attribute to add extended info. + * @property {string} [friendlyName] Friendly name of the backup engine. + * @property {string} [expand] Attribute to add extended info. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/bMSBackupSummariesQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/bMSBackupSummariesQueryObject.js index 27f13a4ae5..07d7ca41be 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/bMSBackupSummariesQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/bMSBackupSummariesQueryObject.js @@ -17,7 +17,7 @@ class BMSBackupSummariesQueryObject { /** * Create a BMSBackupSummariesQueryObject. - * @member {string} [type] Backup management type for this container. + * @property {string} [type] Backup management type for this container. * Possible values include: 'Invalid', 'BackupProtectedItemCountSummary', * 'BackupProtectionContainerCountSummary' */ diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/bMSContainerQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/bMSContainerQueryObject.js index 1ddb56f14b..dc0e01bb94 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/bMSContainerQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/bMSContainerQueryObject.js @@ -17,21 +17,21 @@ class BMSContainerQueryObject { /** * Create a BMSContainerQueryObject. - * @member {string} backupManagementType Backup management type for this + * @property {string} backupManagementType Backup management type for this * container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', * 'DefaultBackup' - * @member {string} [containerType] Type of container for filter. Possible + * @property {string} [containerType] Type of container for filter. Possible * values include: 'Invalid', 'Unknown', 'IaasVMContainer', * 'IaasVMServiceContainer', 'DPMContainer', 'AzureBackupServerContainer', * 'MABContainer', 'Cluster', 'AzureSqlContainer', 'Windows', 'VCenter', * 'VMAppContainer', 'SQLAGWorkLoadContainer', 'StorageContainer', * 'GenericContainer' - * @member {string} [backupEngineName] Backup engine name - * @member {string} [fabricName] Fabric name for filter - * @member {string} [status] Status of registration of this container with + * @property {string} [backupEngineName] Backup engine name + * @property {string} [fabricName] Fabric name for filter + * @property {string} [status] Status of registration of this container with * the Recovery Services Vault. - * @member {string} [friendlyName] Friendly name of this container. + * @property {string} [friendlyName] Friendly name of this container. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/bMSContainersInquiryQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/bMSContainersInquiryQueryObject.js index c852a7b1db..db2fa40d58 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/bMSContainersInquiryQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/bMSContainersInquiryQueryObject.js @@ -17,13 +17,13 @@ class BMSContainersInquiryQueryObject { /** * Create a BMSContainersInquiryQueryObject. - * @member {string} [backupManagementType] Backup management type for this + * @property {string} [backupManagementType] Backup management type for this * container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', * 'DefaultBackup' - * @member {string} [workloadType] Workload type for this container. Possible - * values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', - * 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', + * @property {string} [workloadType] Workload type for this container. + * Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', + * 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/bMSPOQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/bMSPOQueryObject.js index 54137ef589..444517e8a0 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/bMSPOQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/bMSPOQueryObject.js @@ -17,18 +17,18 @@ class BMSPOQueryObject { /** * Create a BMSPOQueryObject. - * @member {string} [backupManagementType] Backup management type. Possible + * @property {string} [backupManagementType] Backup management type. Possible * values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', * 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', * 'DefaultBackup' - * @member {string} [workloadType] Workload type. Possible values include: + * @property {string} [workloadType] Workload type. Possible values include: * 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', * 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', * 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' - * @member {string} [containerName] Full name of the container whose + * @property {string} [containerName] Full name of the container whose * Protectable Objects should be returned. - * @member {string} [status] Backup status query parameter. - * @member {string} [friendlyName] Friendly name. + * @property {string} [status] Backup status query parameter. + * @property {string} [friendlyName] Friendly name. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/bMSRPQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/bMSRPQueryObject.js index d1cffa8a40..ab40d994ef 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/bMSRPQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/bMSRPQueryObject.js @@ -17,12 +17,12 @@ class BMSRPQueryObject { /** * Create a BMSRPQueryObject. - * @member {date} [startDate] Backup copies created after this time. - * @member {date} [endDate] Backup copies created before this time. - * @member {string} [restorePointQueryType] RestorePoint type. Possible + * @property {date} [startDate] Backup copies created after this time. + * @property {date} [endDate] Backup copies created before this time. + * @property {string} [restorePointQueryType] RestorePoint type. Possible * values include: 'Invalid', 'Full', 'Log', 'Differential', * 'FullAndDifferential', 'All' - * @member {boolean} [extendedInfo] In Get Recovery Point, it tells whether + * @property {boolean} [extendedInfo] In Get Recovery Point, it tells whether * extended information about recovery point is asked. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/bMSRefreshContainersQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/bMSRefreshContainersQueryObject.js index 9efe3b48c0..1f8636736b 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/bMSRefreshContainersQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/bMSRefreshContainersQueryObject.js @@ -17,7 +17,7 @@ class BMSRefreshContainersQueryObject { /** * Create a BMSRefreshContainersQueryObject. - * @member {string} [backupManagementType] Backup management type for this + * @property {string} [backupManagementType] Backup management type for this * container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', * 'DefaultBackup' diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/bMSWorkloadItemQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/bMSWorkloadItemQueryObject.js index 0a61a4fa5d..089e01c4c5 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/bMSWorkloadItemQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/bMSWorkloadItemQueryObject.js @@ -17,18 +17,18 @@ class BMSWorkloadItemQueryObject { /** * Create a BMSWorkloadItemQueryObject. - * @member {string} [backupManagementType] Backup management type. Possible + * @property {string} [backupManagementType] Backup management type. Possible * values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', * 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', * 'DefaultBackup' - * @member {string} [workloadItemType] Workload Item type. Possible values + * @property {string} [workloadItemType] Workload Item type. Possible values * include: 'Invalid', 'SQLInstance', 'SQLDataBase', 'SAPHanaSystem', * 'SAPHanaDatabase' - * @member {string} [workloadType] Workload type. Possible values include: + * @property {string} [workloadType] Workload type. Possible values include: * 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', * 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', * 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' - * @member {string} [protectionStatus] Backup status query parameter. + * @property {string} [protectionStatus] Backup status query parameter. * Possible values include: 'Invalid', 'NotProtected', 'Protecting', * 'Protected', 'ProtectionFailed' */ diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/backupEngineBase.js b/lib/services/recoveryServicesBackupManagement/lib/models/backupEngineBase.js index 83091a9778..c168b7c5b0 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/backupEngineBase.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/backupEngineBase.js @@ -18,43 +18,43 @@ class BackupEngineBase { /** * Create a BackupEngineBase. - * @member {string} [friendlyName] Friendly name of the backup engine. - * @member {string} [backupManagementType] Type of backup management for the - * backup engine. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', - * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [registrationStatus] Registration status of the backup + * @property {string} [friendlyName] Friendly name of the backup engine. + * @property {string} [backupManagementType] Type of backup management for + * the backup engine. Possible values include: 'Invalid', 'AzureIaasVM', + * 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', + * 'AzureWorkload', 'DefaultBackup' + * @property {string} [registrationStatus] Registration status of the backup * engine with the Recovery Services Vault. - * @member {string} [backupEngineState] Status of the backup engine with the - * Recovery Services Vault. = {Active/Deleting/DeleteFailed} - * @member {string} [healthStatus] Backup status of the backup engine. - * @member {boolean} [canReRegister] Flag indicating if the backup engine be - * registered, once already registered. - * @member {string} [backupEngineId] ID of the backup engine. - * @member {string} [dpmVersion] Backup engine version - * @member {string} [azureBackupAgentVersion] Backup agent version - * @member {boolean} [isAzureBackupAgentUpgradeAvailable] To check if backup - * agent upgrade available - * @member {boolean} [isDpmUpgradeAvailable] To check if backup engine + * @property {string} [backupEngineState] Status of the backup engine with + * the Recovery Services Vault. = {Active/Deleting/DeleteFailed} + * @property {string} [healthStatus] Backup status of the backup engine. + * @property {boolean} [canReRegister] Flag indicating if the backup engine + * be registered, once already registered. + * @property {string} [backupEngineId] ID of the backup engine. + * @property {string} [dpmVersion] Backup engine version + * @property {string} [azureBackupAgentVersion] Backup agent version + * @property {boolean} [isAzureBackupAgentUpgradeAvailable] To check if + * backup agent upgrade available + * @property {boolean} [isDpmUpgradeAvailable] To check if backup engine * upgrade available - * @member {object} [extendedInfo] Extended info of the backupengine - * @member {string} [extendedInfo.databaseName] Database name of backup + * @property {object} [extendedInfo] Extended info of the backup engine + * @property {string} [extendedInfo.databaseName] Database name of backup * engine. - * @member {number} [extendedInfo.protectedItemsCount] Number of protected + * @property {number} [extendedInfo.protectedItemsCount] Number of protected * items in the backup engine. - * @member {number} [extendedInfo.protectedServersCount] Number of protected - * servers in the backup engine. - * @member {number} [extendedInfo.diskCount] Number of disks in the backup + * @property {number} [extendedInfo.protectedServersCount] Number of + * protected servers in the backup engine. + * @property {number} [extendedInfo.diskCount] Number of disks in the backup * engine. - * @member {number} [extendedInfo.usedDiskSpace] Diskspace used in the backup - * engine. - * @member {number} [extendedInfo.availableDiskSpace] Diskspace currently + * @property {number} [extendedInfo.usedDiskSpace] Disk space used in the + * backup engine. + * @property {number} [extendedInfo.availableDiskSpace] Disk space currently * available in the backup engine. - * @member {date} [extendedInfo.refreshedAt] Last refresh time in the backup - * engine. - * @member {number} [extendedInfo.azureProtectedInstances] Protected + * @property {date} [extendedInfo.refreshedAt] Last refresh time in the + * backup engine. + * @property {number} [extendedInfo.azureProtectedInstances] Protected * instances in the backup engine. - * @member {string} backupEngineType Polymorphic Discriminator + * @property {string} backupEngineType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/backupEngineBaseResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/backupEngineBaseResource.js index 717af737fa..9fbccf8272 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/backupEngineBaseResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/backupEngineBaseResource.js @@ -21,47 +21,48 @@ const models = require('./index'); class BackupEngineBaseResource extends models['Resource'] { /** * Create a BackupEngineBaseResource. - * @member {object} [properties] BackupEngineBaseResource properties - * @member {string} [properties.friendlyName] Friendly name of the backup + * @property {object} [properties] BackupEngineBaseResource properties + * @property {string} [properties.friendlyName] Friendly name of the backup * engine. - * @member {string} [properties.backupManagementType] Type of backup + * @property {string} [properties.backupManagementType] Type of backup * management for the backup engine. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' - * @member {string} [properties.registrationStatus] Registration status of + * @property {string} [properties.registrationStatus] Registration status of * the backup engine with the Recovery Services Vault. - * @member {string} [properties.backupEngineState] Status of the backup + * @property {string} [properties.backupEngineState] Status of the backup * engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed} - * @member {string} [properties.healthStatus] Backup status of the backup + * @property {string} [properties.healthStatus] Backup status of the backup * engine. - * @member {boolean} [properties.canReRegister] Flag indicating if the backup - * engine be registered, once already registered. - * @member {string} [properties.backupEngineId] ID of the backup engine. - * @member {string} [properties.dpmVersion] Backup engine version - * @member {string} [properties.azureBackupAgentVersion] Backup agent version - * @member {boolean} [properties.isAzureBackupAgentUpgradeAvailable] To check - * if backup agent upgrade available - * @member {boolean} [properties.isDpmUpgradeAvailable] To check if backup + * @property {boolean} [properties.canReRegister] Flag indicating if the + * backup engine be registered, once already registered. + * @property {string} [properties.backupEngineId] ID of the backup engine. + * @property {string} [properties.dpmVersion] Backup engine version + * @property {string} [properties.azureBackupAgentVersion] Backup agent + * version + * @property {boolean} [properties.isAzureBackupAgentUpgradeAvailable] To + * check if backup agent upgrade available + * @property {boolean} [properties.isDpmUpgradeAvailable] To check if backup * engine upgrade available - * @member {object} [properties.extendedInfo] Extended info of the - * backupengine - * @member {string} [properties.extendedInfo.databaseName] Database name of + * @property {object} [properties.extendedInfo] Extended info of the backup + * engine + * @property {string} [properties.extendedInfo.databaseName] Database name of * backup engine. - * @member {number} [properties.extendedInfo.protectedItemsCount] Number of + * @property {number} [properties.extendedInfo.protectedItemsCount] Number of * protected items in the backup engine. - * @member {number} [properties.extendedInfo.protectedServersCount] Number of - * protected servers in the backup engine. - * @member {number} [properties.extendedInfo.diskCount] Number of disks in + * @property {number} [properties.extendedInfo.protectedServersCount] Number + * of protected servers in the backup engine. + * @property {number} [properties.extendedInfo.diskCount] Number of disks in * the backup engine. - * @member {number} [properties.extendedInfo.usedDiskSpace] Diskspace used in - * the backup engine. - * @member {number} [properties.extendedInfo.availableDiskSpace] Diskspace + * @property {number} [properties.extendedInfo.usedDiskSpace] Disk space used + * in the backup engine. + * @property {number} [properties.extendedInfo.availableDiskSpace] Disk space * currently available in the backup engine. - * @member {date} [properties.extendedInfo.refreshedAt] Last refresh time in - * the backup engine. - * @member {number} [properties.extendedInfo.azureProtectedInstances] + * @property {date} [properties.extendedInfo.refreshedAt] Last refresh time + * in the backup engine. + * @property {number} [properties.extendedInfo.azureProtectedInstances] * Protected instances in the backup engine. - * @member {string} [properties.backupEngineType] Polymorphic Discriminator + * @property {string} [properties.backupEngineType] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/backupEngineExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/backupEngineExtendedInfo.js index 031ba1efe9..841e070c43 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/backupEngineExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/backupEngineExtendedInfo.js @@ -17,17 +17,17 @@ class BackupEngineExtendedInfo { /** * Create a BackupEngineExtendedInfo. - * @member {string} [databaseName] Database name of backup engine. - * @member {number} [protectedItemsCount] Number of protected items in the + * @property {string} [databaseName] Database name of backup engine. + * @property {number} [protectedItemsCount] Number of protected items in the * backup engine. - * @member {number} [protectedServersCount] Number of protected servers in + * @property {number} [protectedServersCount] Number of protected servers in * the backup engine. - * @member {number} [diskCount] Number of disks in the backup engine. - * @member {number} [usedDiskSpace] Diskspace used in the backup engine. - * @member {number} [availableDiskSpace] Diskspace currently available in the - * backup engine. - * @member {date} [refreshedAt] Last refresh time in the backup engine. - * @member {number} [azureProtectedInstances] Protected instances in the + * @property {number} [diskCount] Number of disks in the backup engine. + * @property {number} [usedDiskSpace] Disk space used in the backup engine. + * @property {number} [availableDiskSpace] Disk space currently available in + * the backup engine. + * @property {date} [refreshedAt] Last refresh time in the backup engine. + * @property {number} [azureProtectedInstances] Protected instances in the * backup engine. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/backupManagementUsage.js b/lib/services/recoveryServicesBackupManagement/lib/models/backupManagementUsage.js index 45d14b3d4b..2473e00702 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/backupManagementUsage.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/backupManagementUsage.js @@ -17,15 +17,15 @@ class BackupManagementUsage { /** * Create a BackupManagementUsage. - * @member {string} [unit] Unit of the usage. Possible values include: + * @property {string} [unit] Unit of the usage. Possible values include: * 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond' - * @member {string} [quotaPeriod] Quota period of usage. - * @member {date} [nextResetTime] Next reset time of usage. - * @member {number} [currentValue] Current value of usage. - * @member {number} [limit] Limit of usage. - * @member {object} [name] Name of usage. - * @member {string} [name.value] Value of usage. - * @member {string} [name.localizedValue] Localized value of usage. + * @property {string} [quotaPeriod] Quota period of usage. + * @property {date} [nextResetTime] Next reset time of usage. + * @property {number} [currentValue] Current value of usage. + * @property {number} [limit] Limit of usage. + * @property {object} [name] Name of usage. + * @property {string} [name.value] Value of usage. + * @property {string} [name.localizedValue] Localized value of usage. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/backupRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/backupRequest.js index f8b4fb4bf8..be099bf947 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/backupRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/backupRequest.js @@ -18,7 +18,7 @@ class BackupRequest { /** * Create a BackupRequest. - * @member {string} objectType Polymorphic Discriminator + * @property {string} objectType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/backupRequestResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/backupRequestResource.js index 147af1489a..dce847766f 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/backupRequestResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/backupRequestResource.js @@ -21,8 +21,8 @@ const models = require('./index'); class BackupRequestResource extends models['Resource'] { /** * Create a BackupRequestResource. - * @member {object} [properties] BackupRequestResource properties - * @member {string} [properties.objectType] Polymorphic Discriminator + * @property {object} [properties] BackupRequestResource properties + * @property {string} [properties.objectType] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceConfig.js b/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceConfig.js index 763ea265e3..8c2ac3396f 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceConfig.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceConfig.js @@ -17,12 +17,12 @@ class BackupResourceConfig { /** * Create a BackupResourceConfig. - * @member {string} [storageModelType] Storage type. Possible values include: + * @property {string} [storageModelType] Storage type. Possible values + * include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' + * @property {string} [storageType] Storage type. Possible values include: * 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [storageType] Storage type. Possible values include: - * 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [storageTypeState] Locked or Unlocked. Once a machine is - * registered against a resource, the storageTypeState is always Locked. + * @property {string} [storageTypeState] Locked or Unlocked. Once a machine + * is registered against a resource, the storageTypeState is always Locked. * Possible values include: 'Invalid', 'Locked', 'Unlocked' */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceConfigResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceConfigResource.js index 12886c0f4e..1bac5096b2 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceConfigResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceConfigResource.js @@ -20,13 +20,13 @@ const models = require('./index'); class BackupResourceConfigResource extends models['Resource'] { /** * Create a BackupResourceConfigResource. - * @member {object} [properties] BackupResourceConfigResource properties - * @member {string} [properties.storageModelType] Storage type. Possible + * @property {object} [properties] BackupResourceConfigResource properties + * @property {string} [properties.storageModelType] Storage type. Possible * values include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [properties.storageType] Storage type. Possible values + * @property {string} [properties.storageType] Storage type. Possible values * include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [properties.storageTypeState] Locked or Unlocked. Once a - * machine is registered against a resource, the storageTypeState is always + * @property {string} [properties.storageTypeState] Locked or Unlocked. Once + * a machine is registered against a resource, the storageTypeState is always * Locked. Possible values include: 'Invalid', 'Locked', 'Unlocked' */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceVaultConfig.js b/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceVaultConfig.js index 0f05d92856..9dabfe2923 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceVaultConfig.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceVaultConfig.js @@ -17,14 +17,14 @@ class BackupResourceVaultConfig { /** * Create a BackupResourceVaultConfig. - * @member {string} [storageModelType] Storage type. Possible values include: + * @property {string} [storageModelType] Storage type. Possible values + * include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' + * @property {string} [storageType] Storage type. Possible values include: * 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [storageType] Storage type. Possible values include: - * 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [storageTypeState] Locked or Unlocked. Once a machine is - * registered against a resource, the storageTypeState is always Locked. + * @property {string} [storageTypeState] Locked or Unlocked. Once a machine + * is registered against a resource, the storageTypeState is always Locked. * Possible values include: 'Invalid', 'Locked', 'Unlocked' - * @member {string} [enhancedSecurityState] Enabled or Disabled. Possible + * @property {string} [enhancedSecurityState] Enabled or Disabled. Possible * values include: 'Invalid', 'Enabled', 'Disabled' */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceVaultConfigResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceVaultConfigResource.js index c2072fcb17..2da5d007ba 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceVaultConfigResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/backupResourceVaultConfigResource.js @@ -20,15 +20,16 @@ const models = require('./index'); class BackupResourceVaultConfigResource extends models['Resource'] { /** * Create a BackupResourceVaultConfigResource. - * @member {object} [properties] BackupResourceVaultConfigResource properties - * @member {string} [properties.storageModelType] Storage type. Possible + * @property {object} [properties] BackupResourceVaultConfigResource + * properties + * @property {string} [properties.storageModelType] Storage type. Possible * values include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [properties.storageType] Storage type. Possible values + * @property {string} [properties.storageType] Storage type. Possible values * include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [properties.storageTypeState] Locked or Unlocked. Once a - * machine is registered against a resource, the storageTypeState is always + * @property {string} [properties.storageTypeState] Locked or Unlocked. Once + * a machine is registered against a resource, the storageTypeState is always * Locked. Possible values include: 'Invalid', 'Locked', 'Unlocked' - * @member {string} [properties.enhancedSecurityState] Enabled or Disabled. + * @property {string} [properties.enhancedSecurityState] Enabled or Disabled. * Possible values include: 'Invalid', 'Enabled', 'Disabled' */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/backupStatusRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/backupStatusRequest.js index 44f53d72e2..e52bf007e3 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/backupStatusRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/backupStatusRequest.js @@ -17,13 +17,13 @@ class BackupStatusRequest { /** * Create a BackupStatusRequest. - * @member {string} [resourceType] Container Type - VM, SQLPaaS, DPM, + * @property {string} [resourceType] Container Type - VM, SQLPaaS, DPM, * AzureFileShare. Possible values include: 'Invalid', 'VM', 'FileFolder', * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', * 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', * 'AzureFileShare', 'SAPHanaDatabase' - * @member {string} [resourceId] Entire ARM resource id of the resource - * @member {string} [poLogicalName] Protectable Item Logical Name + * @property {string} [resourceId] Entire ARM resource id of the resource + * @property {string} [poLogicalName] Protectable Item Logical Name */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/backupStatusResponse.js b/lib/services/recoveryServicesBackupManagement/lib/models/backupStatusResponse.js index 0ed47f4e40..a1ec45b0ef 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/backupStatusResponse.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/backupStatusResponse.js @@ -17,20 +17,20 @@ class BackupStatusResponse { /** * Create a BackupStatusResponse. - * @member {string} [protectionStatus] Specifies whether the container is + * @property {string} [protectionStatus] Specifies whether the container is * registered or not. Possible values include: 'Invalid', 'NotProtected', * 'Protecting', 'Protected', 'ProtectionFailed' - * @member {string} [fabricName] Specifies the fabric name - Azure or AD. + * @property {string} [fabricName] Specifies the fabric name - Azure or AD. * Possible values include: 'Invalid', 'Azure' - * @member {string} [containerName] Specifies the product specific container - * name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname. - * @member {string} [protectedItemName] Specifies the product specific ds + * @property {string} [containerName] Specifies the product specific + * container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname. + * @property {string} [protectedItemName] Specifies the product specific ds * name. E.g. vm;iaasvmcontainer;csname;vmname. - * @member {string} [errorCode] ErrorCode in case of intent failed - * @member {string} [errorMessage] ErrorMessage in case of intent failed. - * @member {string} [policyName] Specifies the policy name which is used for - * protection - * @member {string} [registrationStatus] Container registration status + * @property {string} [errorCode] ErrorCode in case of intent failed + * @property {string} [errorMessage] ErrorMessage in case of intent failed. + * @property {string} [policyName] Specifies the policy name which is used + * for protection + * @property {string} [registrationStatus] Container registration status */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryDisplay.js b/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryDisplay.js index 20f43f4224..2cdbc83d09 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryDisplay.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryDisplay.js @@ -17,12 +17,12 @@ class ClientDiscoveryDisplay { /** * Create a ClientDiscoveryDisplay. - * @member {string} [provider] Name of the provider for display purposes - * @member {string} [resource] ResourceType for which this Operation can be + * @property {string} [provider] Name of the provider for display purposes + * @property {string} [resource] ResourceType for which this Operation can be * performed. - * @member {string} [operation] Operations Name itself. - * @member {string} [description] Description of the operation having details - * of what operation is about. + * @property {string} [operation] Operations Name itself. + * @property {string} [description] Description of the operation having + * details of what operation is about. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryForLogSpecification.js b/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryForLogSpecification.js index bf9d1ca3c3..113faa60d5 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryForLogSpecification.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryForLogSpecification.js @@ -17,9 +17,10 @@ class ClientDiscoveryForLogSpecification { /** * Create a ClientDiscoveryForLogSpecification. - * @member {string} [name] Name for shoebox log specification. - * @member {string} [displayName] Localized display name - * @member {string} [blobDuration] blob duration of shoebox log specification + * @property {string} [name] Name for shoebox log specification. + * @property {string} [displayName] Localized display name + * @property {string} [blobDuration] blob duration of shoebox log + * specification */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryForProperties.js b/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryForProperties.js index c2adf7fec6..7f266c0cdc 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryForProperties.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryForProperties.js @@ -17,8 +17,8 @@ class ClientDiscoveryForProperties { /** * Create a ClientDiscoveryForProperties. - * @member {object} [serviceSpecification] Operation properties. - * @member {array} [serviceSpecification.logSpecifications] List of log + * @property {object} [serviceSpecification] Operation properties. + * @property {array} [serviceSpecification.logSpecifications] List of log * specifications of this operation. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryForServiceSpecification.js b/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryForServiceSpecification.js index ab52bd8439..f2379db3da 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryForServiceSpecification.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryForServiceSpecification.js @@ -17,7 +17,7 @@ class ClientDiscoveryForServiceSpecification { /** * Create a ClientDiscoveryForServiceSpecification. - * @member {array} [logSpecifications] List of log specifications of this + * @property {array} [logSpecifications] List of log specifications of this * operation. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryResponse.js b/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryResponse.js index 3d69264ece..67f0a5add2 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryResponse.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryResponse.js @@ -16,7 +16,7 @@ class ClientDiscoveryResponse extends Array { /** * Create a ClientDiscoveryResponse. - * @member {string} [nextLink] Link to the next chunk of Response. + * @property {string} [nextLink] Link to the next chunk of Response. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryValueForSingleApi.js b/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryValueForSingleApi.js index a6dbe5bad4..dfbb24848b 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryValueForSingleApi.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/clientDiscoveryValueForSingleApi.js @@ -17,21 +17,22 @@ class ClientDiscoveryValueForSingleApi { /** * Create a ClientDiscoveryValueForSingleApi. - * @member {string} [name] Name of the Operation. - * @member {object} [display] Contains the localized display information for - * this particular operation - * @member {string} [display.provider] Name of the provider for display + * @property {string} [name] Name of the Operation. + * @property {object} [display] Contains the localized display information + * for this particular operation + * @property {string} [display.provider] Name of the provider for display * purposes - * @member {string} [display.resource] ResourceType for which this Operation - * can be performed. - * @member {string} [display.operation] Operations Name itself. - * @member {string} [display.description] Description of the operation having - * details of what operation is about. - * @member {string} [origin] The intended executor of the operation;governs + * @property {string} [display.resource] ResourceType for which this + * Operation can be performed. + * @property {string} [display.operation] Operations Name itself. + * @property {string} [display.description] Description of the operation + * having details of what operation is about. + * @property {string} [origin] The intended executor of the operation;governs * the display of the operation in the RBAC UX and the audit logs UX - * @member {object} [properties] ShoeBox properties for the given operation. - * @member {object} [properties.serviceSpecification] Operation properties. - * @member {array} [properties.serviceSpecification.logSpecifications] List + * @property {object} [properties] ShoeBox properties for the given + * operation. + * @property {object} [properties.serviceSpecification] Operation properties. + * @property {array} [properties.serviceSpecification.logSpecifications] List * of log specifications of this operation. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/clientScriptForConnect.js b/lib/services/recoveryServicesBackupManagement/lib/models/clientScriptForConnect.js index 96fb255740..4ad43e0436 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/clientScriptForConnect.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/clientScriptForConnect.js @@ -17,15 +17,15 @@ class ClientScriptForConnect { /** * Create a ClientScriptForConnect. - * @member {string} [scriptContent] File content of the client script for + * @property {string} [scriptContent] File content of the client script for * file / folder restore. - * @member {string} [scriptExtension] File extension of the client script for - * file / folder restore - .ps1 , .sh , etc. - * @member {string} [osType] OS type - Windows, Linux etc. for which this + * @property {string} [scriptExtension] File extension of the client script + * for file / folder restore - .ps1 , .sh , etc. + * @property {string} [osType] OS type - Windows, Linux etc. for which this * file / folder restore client script works. - * @member {string} [url] URL of Executable from where to source the content. - * If this is not null then ScriptContent should not be used - * @member {string} [scriptNameSuffix] Mandator suffix that should be added + * @property {string} [url] URL of Executable from where to source the + * content. If this is not null then ScriptContent should not be used + * @property {string} [scriptNameSuffix] Mandator suffix that should be added * to the name of script that is given for download to user. * If its null or empty then , ignore it. */ diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/containerIdentityInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/containerIdentityInfo.js index 1d434e0e70..79cb37cf87 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/containerIdentityInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/containerIdentityInfo.js @@ -17,11 +17,12 @@ class ContainerIdentityInfo { /** * Create a ContainerIdentityInfo. - * @member {string} [uniqueName] Unique name of the container - * @member {string} [aadTenantId] Protection container identity - AAD Tenant - * @member {string} [servicePrincipalClientId] Protection container identity - * - AAD Service Principal - * @member {string} [audience] Protection container identity - Audience + * @property {string} [uniqueName] Unique name of the container + * @property {string} [aadTenantId] Protection container identity - AAD + * Tenant + * @property {string} [servicePrincipalClientId] Protection container + * identity - AAD Service Principal + * @property {string} [audience] Protection container identity - Audience */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/dPMContainerExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/dPMContainerExtendedInfo.js index 4a344bdb2e..02694d355d 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/dPMContainerExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/dPMContainerExtendedInfo.js @@ -17,7 +17,7 @@ class DPMContainerExtendedInfo { /** * Create a DPMContainerExtendedInfo. - * @member {date} [lastRefreshedAt] Last refresh time of the DPMContainer. + * @property {date} [lastRefreshedAt] Last refresh time of the DPMContainer. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/dPMProtectedItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/dPMProtectedItem.js index 3b2f3b2391..149b7f2c0f 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/dPMProtectedItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/dPMProtectedItem.js @@ -20,42 +20,42 @@ const models = require('./index'); class DPMProtectedItem extends models['ProtectedItem'] { /** * Create a DPMProtectedItem. - * @member {string} [friendlyName] Friendly name of the managed item - * @member {string} [backupEngineName] Backup Management server protecting + * @property {string} [friendlyName] Friendly name of the managed item + * @property {string} [backupEngineName] Backup Management server protecting * this backup item - * @member {string} [protectionState] Protection state of the backupengine. - * Possible values include: 'Invalid', 'IRPending', 'Protected', + * @property {string} [protectionState] Protection state of the backup + * engine. Possible values include: 'Invalid', 'IRPending', 'Protected', * 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' - * @member {boolean} [isScheduledForDeferredDelete] To check if backup item + * @property {boolean} [isScheduledForDeferredDelete] To check if backup item * is scheduled for deferred delete - * @member {object} [extendedInfo] Extended info of the backup item. - * @member {object} [extendedInfo.protectableObjectLoadPath] Attribute to + * @property {object} [extendedInfo] Extended info of the backup item. + * @property {object} [extendedInfo.protectableObjectLoadPath] Attribute to * provide information on various DBs. - * @member {boolean} [extendedInfo.protectedProperty] To check if backup item - * is disk protected. - * @member {boolean} [extendedInfo.isPresentOnCloud] To check if backup item - * is cloud protected. - * @member {string} [extendedInfo.lastBackupStatus] Last backup status + * @property {boolean} [extendedInfo.protectedProperty] To check if backup + * item is disk protected. + * @property {boolean} [extendedInfo.isPresentOnCloud] To check if backup + * item is cloud protected. + * @property {string} [extendedInfo.lastBackupStatus] Last backup status * information on backup item. - * @member {date} [extendedInfo.lastRefreshedAt] Last refresh time on backup - * item. - * @member {date} [extendedInfo.oldestRecoveryPoint] Oldest cloud recovery + * @property {date} [extendedInfo.lastRefreshedAt] Last refresh time on + * backup item. + * @property {date} [extendedInfo.oldestRecoveryPoint] Oldest cloud recovery * point time. - * @member {number} [extendedInfo.recoveryPointCount] cloud recovery point + * @property {number} [extendedInfo.recoveryPointCount] cloud recovery point * count. - * @member {date} [extendedInfo.onPremiseOldestRecoveryPoint] Oldest disk + * @property {date} [extendedInfo.onPremiseOldestRecoveryPoint] Oldest disk * recovery point time. - * @member {date} [extendedInfo.onPremiseLatestRecoveryPoint] latest disk + * @property {date} [extendedInfo.onPremiseLatestRecoveryPoint] latest disk * recovery point time. - * @member {number} [extendedInfo.onPremiseRecoveryPointCount] disk recovery - * point count. - * @member {boolean} [extendedInfo.isCollocated] To check if backup item is + * @property {number} [extendedInfo.onPremiseRecoveryPointCount] disk + * recovery point count. + * @property {boolean} [extendedInfo.isCollocated] To check if backup item is * collocated. - * @member {string} [extendedInfo.protectionGroupName] Protection group name - * of the backup item. - * @member {string} [extendedInfo.diskStorageUsedInBytes] Used Disk storage + * @property {string} [extendedInfo.protectionGroupName] Protection group + * name of the backup item. + * @property {string} [extendedInfo.diskStorageUsedInBytes] Used Disk storage * in bytes. - * @member {string} [extendedInfo.totalDiskStorageSizeInBytes] total Disk + * @property {string} [extendedInfo.totalDiskStorageSizeInBytes] total Disk * storage in bytes. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/dPMProtectedItemExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/dPMProtectedItemExtendedInfo.js index 2fb8b92c0b..8db143ebe0 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/dPMProtectedItemExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/dPMProtectedItemExtendedInfo.js @@ -17,27 +17,28 @@ class DPMProtectedItemExtendedInfo { /** * Create a DPMProtectedItemExtendedInfo. - * @member {object} [protectableObjectLoadPath] Attribute to provide + * @property {object} [protectableObjectLoadPath] Attribute to provide * information on various DBs. - * @member {boolean} [protectedProperty] To check if backup item is disk + * @property {boolean} [protectedProperty] To check if backup item is disk * protected. - * @member {boolean} [isPresentOnCloud] To check if backup item is cloud + * @property {boolean} [isPresentOnCloud] To check if backup item is cloud * protected. - * @member {string} [lastBackupStatus] Last backup status information on + * @property {string} [lastBackupStatus] Last backup status information on * backup item. - * @member {date} [lastRefreshedAt] Last refresh time on backup item. - * @member {date} [oldestRecoveryPoint] Oldest cloud recovery point time. - * @member {number} [recoveryPointCount] cloud recovery point count. - * @member {date} [onPremiseOldestRecoveryPoint] Oldest disk recovery point + * @property {date} [lastRefreshedAt] Last refresh time on backup item. + * @property {date} [oldestRecoveryPoint] Oldest cloud recovery point time. + * @property {number} [recoveryPointCount] cloud recovery point count. + * @property {date} [onPremiseOldestRecoveryPoint] Oldest disk recovery point * time. - * @member {date} [onPremiseLatestRecoveryPoint] latest disk recovery point + * @property {date} [onPremiseLatestRecoveryPoint] latest disk recovery point * time. - * @member {number} [onPremiseRecoveryPointCount] disk recovery point count. - * @member {boolean} [isCollocated] To check if backup item is collocated. - * @member {string} [protectionGroupName] Protection group name of the backup - * item. - * @member {string} [diskStorageUsedInBytes] Used Disk storage in bytes. - * @member {string} [totalDiskStorageSizeInBytes] total Disk storage in + * @property {number} [onPremiseRecoveryPointCount] disk recovery point + * count. + * @property {boolean} [isCollocated] To check if backup item is collocated. + * @property {string} [protectionGroupName] Protection group name of the + * backup item. + * @property {string} [diskStorageUsedInBytes] Used Disk storage in bytes. + * @property {string} [totalDiskStorageSizeInBytes] total Disk storage in * bytes. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/dailyRetentionFormat.js b/lib/services/recoveryServicesBackupManagement/lib/models/dailyRetentionFormat.js index 9cd22bebf8..34a35d4b9b 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/dailyRetentionFormat.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/dailyRetentionFormat.js @@ -17,7 +17,7 @@ class DailyRetentionFormat { /** * Create a DailyRetentionFormat. - * @member {array} [daysOfTheMonth] List of days of the month. + * @property {array} [daysOfTheMonth] List of days of the month. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/dailyRetentionSchedule.js b/lib/services/recoveryServicesBackupManagement/lib/models/dailyRetentionSchedule.js index 0cfdca28ef..09b11b73ca 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/dailyRetentionSchedule.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/dailyRetentionSchedule.js @@ -17,17 +17,17 @@ class DailyRetentionSchedule { /** * Create a DailyRetentionSchedule. - * @member {array} [retentionTimes] Retention times of retention policy. - * @member {object} [retentionDuration] Retention duration of retention + * @property {array} [retentionTimes] Retention times of retention policy. + * @property {object} [retentionDuration] Retention duration of retention * Policy. - * @member {number} [retentionDuration.count] Count of duration types. + * @property {number} [retentionDuration.count] Count of duration types. * Retention duration is obtained by the counting the duration type Count * times. * For example, when Count = 3 and DurationType = Weeks, retention duration * will be three weeks. - * @member {string} [retentionDuration.durationType] Retention duration type - * of retention policy. Possible values include: 'Invalid', 'Days', 'Weeks', - * 'Months', 'Years' + * @property {string} [retentionDuration.durationType] Retention duration + * type of retention policy. Possible values include: 'Invalid', 'Days', + * 'Weeks', 'Months', 'Years' */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/day.js b/lib/services/recoveryServicesBackupManagement/lib/models/day.js index 8c5a396fdc..5ef06774f5 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/day.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/day.js @@ -17,8 +17,8 @@ class Day { /** * Create a Day. - * @member {number} [date] Date of the month - * @member {boolean} [isLast] Whether Date is last date of month + * @property {number} [date] Date of the month + * @property {boolean} [isLast] Whether Date is last date of month */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/distributedNodesInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/distributedNodesInfo.js index fc002ff063..0745fd5eaf 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/distributedNodesInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/distributedNodesInfo.js @@ -17,14 +17,16 @@ class DistributedNodesInfo { /** * Create a DistributedNodesInfo. - * @member {string} [nodeName] Name of the node under a distributed + * @property {string} [nodeName] Name of the node under a distributed * container. - * @member {string} [status] Status of this Node. + * @property {string} [status] Status of this Node. * Failed | Succeeded - * @member {object} [errorDetail] Error Details if the Status is non-success. - * @member {string} [errorDetail.code] Error code. - * @member {string} [errorDetail.message] Error Message related to the Code. - * @member {array} [errorDetail.recommendations] List of recommendation + * @property {object} [errorDetail] Error Details if the Status is + * non-success. + * @property {string} [errorDetail.code] Error code. + * @property {string} [errorDetail.message] Error Message related to the + * Code. + * @property {array} [errorDetail.recommendations] List of recommendation * strings. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/dpmContainer.js b/lib/services/recoveryServicesBackupManagement/lib/models/dpmContainer.js index b75416dee3..596a8218ed 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/dpmContainer.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/dpmContainer.js @@ -20,18 +20,18 @@ const models = require('./index'); class DpmContainer extends models['ProtectionContainer'] { /** * Create a DpmContainer. - * @member {boolean} [canReRegister] Specifies whether the container is + * @property {boolean} [canReRegister] Specifies whether the container is * re-registrable. - * @member {string} [containerId] ID of container. - * @member {number} [protectedItemCount] Number of protected items in the + * @property {string} [containerId] ID of container. + * @property {number} [protectedItemCount] Number of protected items in the * BackupEngine - * @member {string} [dpmAgentVersion] Backup engine Agent version - * @member {array} [dpmServers] List of BackupEngines protecting the + * @property {string} [dpmAgentVersion] Backup engine Agent version + * @property {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 + * @property {boolean} [upgradeAvailable] To check if upgrade available + * @property {string} [protectionStatus] Protection status of the container. + * @property {object} [extendedInfo] Extended Info of the container. + * @property {date} [extendedInfo.lastRefreshedAt] Last refresh time of the * DPMContainer. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/dpmErrorInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/dpmErrorInfo.js index 35f7b4d0d4..06f46200af 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/dpmErrorInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/dpmErrorInfo.js @@ -17,8 +17,8 @@ class DpmErrorInfo { /** * Create a DpmErrorInfo. - * @member {string} [errorString] Localized error string. - * @member {array} [recommendations] List of localized recommendations for + * @property {string} [errorString] Localized error string. + * @property {array} [recommendations] List of localized recommendations for * above error code. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/dpmJob.js b/lib/services/recoveryServicesBackupManagement/lib/models/dpmJob.js index 22d0aaabb9..50f77b83d1 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/dpmJob.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/dpmJob.js @@ -13,28 +13,28 @@ const models = require('./index'); /** - * DPM workload-specifc job object. + * DPM workload-specific job object. * * @extends models['Job'] */ class DpmJob extends models['Job'] { /** * Create a DpmJob. - * @member {moment.duration} [duration] Time elapsed for job. - * @member {string} [dpmServerName] DPM server name managing the backup item - * or backup job. - * @member {string} [containerName] Name of cluster/server protecting current - * backup item, if any. - * @member {string} [containerType] Type of container. - * @member {string} [workloadType] Type of backup item. - * @member {array} [actionsInfo] The state/actions applicable on this job + * @property {moment.duration} [duration] Time elapsed for job. + * @property {string} [dpmServerName] DPM server name managing the backup + * item or backup job. + * @property {string} [containerName] Name of cluster/server protecting + * current backup item, if any. + * @property {string} [containerType] Type of container. + * @property {string} [workloadType] Type of backup item. + * @property {array} [actionsInfo] The state/actions applicable on this job * like cancel/retry. - * @member {array} [errorDetails] The errors. - * @member {object} [extendedInfo] Additional information for this job. - * @member {array} [extendedInfo.tasksList] List of tasks associated with + * @property {array} [errorDetails] The errors. + * @property {object} [extendedInfo] Additional information for this job. + * @property {array} [extendedInfo.tasksList] List of tasks associated with * this job. - * @member {object} [extendedInfo.propertyBag] The job properties. - * @member {string} [extendedInfo.dynamicErrorMessage] Non localized error + * @property {object} [extendedInfo.propertyBag] The job properties. + * @property {string} [extendedInfo.dynamicErrorMessage] Non localized error * message on job execution. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/dpmJobExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/dpmJobExtendedInfo.js index 9f10551462..2072b81752 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/dpmJobExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/dpmJobExtendedInfo.js @@ -17,10 +17,10 @@ class DpmJobExtendedInfo { /** * Create a DpmJobExtendedInfo. - * @member {array} [tasksList] List of tasks associated with this job. - * @member {object} [propertyBag] The job properties. - * @member {string} [dynamicErrorMessage] Non localized error message on job - * execution. + * @property {array} [tasksList] List of tasks associated with this job. + * @property {object} [propertyBag] The job properties. + * @property {string} [dynamicErrorMessage] Non localized error message on + * job execution. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/dpmJobTaskDetails.js b/lib/services/recoveryServicesBackupManagement/lib/models/dpmJobTaskDetails.js index 81cdcfc4a4..cad8137ff2 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/dpmJobTaskDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/dpmJobTaskDetails.js @@ -17,11 +17,11 @@ class DpmJobTaskDetails { /** * Create a DpmJobTaskDetails. - * @member {string} [taskId] The task display name. - * @member {date} [startTime] The start time. - * @member {date} [endTime] The end time. - * @member {moment.duration} [duration] Time elapsed for task. - * @member {string} [status] The status. + * @property {string} [taskId] The task display name. + * @property {date} [startTime] The start time. + * @property {date} [endTime] The end time. + * @property {moment.duration} [duration] Time elapsed for task. + * @property {string} [status] The status. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/encryptionDetails.js b/lib/services/recoveryServicesBackupManagement/lib/models/encryptionDetails.js index 989fe36fb6..86b10c3735 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/encryptionDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/encryptionDetails.js @@ -17,12 +17,12 @@ class EncryptionDetails { /** * Create a EncryptionDetails. - * @member {boolean} [encryptionEnabled] Identifies whether this backup copy - * represents an encrypted VM at the time of backup. - * @member {string} [kekUrl] Key Url. - * @member {string} [secretKeyUrl] Secret Url. - * @member {string} [kekVaultId] ID of Key Vault where KEK is stored. - * @member {string} [secretKeyVaultId] ID of Key Vault where Secret is + * @property {boolean} [encryptionEnabled] Identifies whether this backup + * copy represents an encrypted VM at the time of backup. + * @property {string} [kekUrl] Key Url. + * @property {string} [secretKeyUrl] Secret Url. + * @property {string} [kekVaultId] ID of Key Vault where KEK is stored. + * @property {string} [secretKeyVaultId] ID of Key Vault where Secret is * stored. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/errorDetail.js b/lib/services/recoveryServicesBackupManagement/lib/models/errorDetail.js index d167d849f7..174c9f9828 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/errorDetail.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/errorDetail.js @@ -17,9 +17,9 @@ class ErrorDetail { /** * Create a ErrorDetail. - * @member {string} [code] Error code. - * @member {string} [message] Error Message related to the Code. - * @member {array} [recommendations] List of recommendation strings. + * @property {string} [code] Error code. + * @property {string} [message] Error Message related to the Code. + * @property {array} [recommendations] List of recommendation strings. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/exportJobsOperationResultInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/exportJobsOperationResultInfo.js index f647a9c252..5d688be2d0 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/exportJobsOperationResultInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/exportJobsOperationResultInfo.js @@ -20,10 +20,10 @@ const models = require('./index'); class ExportJobsOperationResultInfo extends models['OperationResultInfoBase'] { /** * Create a ExportJobsOperationResultInfo. - * @member {string} [blobUrl] URL of the blob into which the serialized + * @property {string} [blobUrl] URL of the blob into which the serialized * string of list of jobs is exported. - * @member {string} [blobSasKey] SAS key to access the blob. It expires in 15 - * mins. + * @property {string} [blobSasKey] SAS key to access the blob. It expires in + * 15 mins. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/featureSupportRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/featureSupportRequest.js index 5199181d27..f6a4f3bbcd 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/featureSupportRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/featureSupportRequest.js @@ -17,7 +17,7 @@ class FeatureSupportRequest { /** * Create a FeatureSupportRequest. - * @member {string} featureType Polymorphic Discriminator + * @property {string} featureType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/genericContainer.js b/lib/services/recoveryServicesBackupManagement/lib/models/genericContainer.js index 5a39b1f691..b304cb631c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/genericContainer.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/genericContainer.js @@ -20,23 +20,23 @@ const models = require('./index'); class GenericContainer extends models['ProtectionContainer'] { /** * Create a GenericContainer. - * @member {string} [fabricName] Name of the container's fabric - * @member {object} [extendedInformation] Extended information (not returned - * in List container API calls) - * @member {string} [extendedInformation.rawCertData] Public key of container - * cert - * @member {object} [extendedInformation.containerIdentityInfo] Container + * @property {string} [fabricName] Name of the container's fabric + * @property {object} [extendedInformation] Extended information (not + * returned in List container API calls) + * @property {string} [extendedInformation.rawCertData] Public key of + * container cert + * @property {object} [extendedInformation.containerIdentityInfo] Container * identity information - * @member {string} [extendedInformation.containerIdentityInfo.uniqueName] + * @property {string} [extendedInformation.containerIdentityInfo.uniqueName] * Unique name of the container - * @member {string} [extendedInformation.containerIdentityInfo.aadTenantId] + * @property {string} [extendedInformation.containerIdentityInfo.aadTenantId] * Protection container identity - AAD Tenant - * @member {string} + * @property {string} * [extendedInformation.containerIdentityInfo.servicePrincipalClientId] * Protection container identity - AAD Service Principal - * @member {string} [extendedInformation.containerIdentityInfo.audience] + * @property {string} [extendedInformation.containerIdentityInfo.audience] * Protection container identity - Audience - * @member {object} [extendedInformation.serviceEndpoints] Azure Backup + * @property {object} [extendedInformation.serviceEndpoints] Azure Backup * Service Endpoints for the container */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/genericContainerExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/genericContainerExtendedInfo.js index da4b06aef9..94ad8b5302 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/genericContainerExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/genericContainerExtendedInfo.js @@ -17,18 +17,18 @@ class GenericContainerExtendedInfo { /** * Create a GenericContainerExtendedInfo. - * @member {string} [rawCertData] Public key of container cert - * @member {object} [containerIdentityInfo] Container identity information - * @member {string} [containerIdentityInfo.uniqueName] Unique name of the + * @property {string} [rawCertData] Public key of container cert + * @property {object} [containerIdentityInfo] Container identity information + * @property {string} [containerIdentityInfo.uniqueName] Unique name of the * container - * @member {string} [containerIdentityInfo.aadTenantId] Protection container - * identity - AAD Tenant - * @member {string} [containerIdentityInfo.servicePrincipalClientId] + * @property {string} [containerIdentityInfo.aadTenantId] Protection + * container identity - AAD Tenant + * @property {string} [containerIdentityInfo.servicePrincipalClientId] * Protection container identity - AAD Service Principal - * @member {string} [containerIdentityInfo.audience] Protection container + * @property {string} [containerIdentityInfo.audience] Protection container * identity - Audience - * @member {object} [serviceEndpoints] Azure Backup Service Endpoints for the - * container + * @property {object} [serviceEndpoints] Azure Backup Service Endpoints for + * the container */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/genericProtectedItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/genericProtectedItem.js index c232e31bda..6f3d55617b 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/genericProtectedItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/genericProtectedItem.js @@ -20,17 +20,17 @@ const models = require('./index'); class GenericProtectedItem extends models['ProtectedItem'] { /** * Create a GenericProtectedItem. - * @member {string} [friendlyName] Friendly name of the container. - * @member {string} [policyState] Indicates consistency of policy object and - * policy applied to this backup item. - * @member {string} [protectionState] Backup state of this backup item. + * @property {string} [friendlyName] Friendly name of the container. + * @property {string} [policyState] Indicates consistency of policy object + * and policy applied to this backup item. + * @property {string} [protectionState] Backup state of this backup item. * Possible values include: 'Invalid', 'IRPending', 'Protected', * 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' - * @member {number} [protectedItemId] Data Plane Service ID of the protected - * item. - * @member {object} [sourceAssociations] Loosely coupled (type, value) + * @property {number} [protectedItemId] Data Plane Service ID of the + * protected item. + * @property {object} [sourceAssociations] Loosely coupled (type, value) * associations (example - parent of a protected item) - * @member {string} [fabricName] Name of this backup item's fabric. + * @property {string} [fabricName] Name of this backup item's fabric. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/genericProtectionPolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/genericProtectionPolicy.js index 6912e34298..3e33d9a18e 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/genericProtectionPolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/genericProtectionPolicy.js @@ -20,11 +20,11 @@ const models = require('./index'); class GenericProtectionPolicy extends models['ProtectionPolicy'] { /** * Create a GenericProtectionPolicy. - * @member {array} [subProtectionPolicy] List of sub-protection policies + * @property {array} [subProtectionPolicy] List of sub-protection policies * which includes schedule and retention - * @member {string} [timeZone] TimeZone optional input as string. For + * @property {string} [timeZone] TimeZone optional input as string. For * example: TimeZone = "Pacific Standard Time". - * @member {string} [fabricName] Name of this policy's fabric. + * @property {string} [fabricName] Name of this policy's fabric. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/genericRecoveryPoint.js b/lib/services/recoveryServicesBackupManagement/lib/models/genericRecoveryPoint.js index f6df9a77cc..d1b5a5b8e6 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/genericRecoveryPoint.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/genericRecoveryPoint.js @@ -20,11 +20,11 @@ const models = require('./index'); class GenericRecoveryPoint extends models['RecoveryPoint'] { /** * Create a GenericRecoveryPoint. - * @member {string} [friendlyName] Friendly name of the backup copy. - * @member {string} [recoveryPointType] Type of the backup copy. - * @member {date} [recoveryPointTime] Time at which this backup copy was + * @property {string} [friendlyName] Friendly name of the backup copy. + * @property {string} [recoveryPointType] Type of the backup copy. + * @property {date} [recoveryPointTime] Time at which this backup copy was * created. - * @member {string} [recoveryPointAdditionalInfo] Additional information + * @property {string} [recoveryPointAdditionalInfo] Additional information * associated with this backup copy. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/getProtectedItemQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/getProtectedItemQueryObject.js index 069661b3a5..1dacca391a 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/getProtectedItemQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/getProtectedItemQueryObject.js @@ -17,7 +17,7 @@ class GetProtectedItemQueryObject { /** * Create a GetProtectedItemQueryObject. - * @member {string} [expand] Specifies if the additional information should + * @property {string} [expand] Specifies if the additional information should * be provided for this item. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/iLRRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/iLRRequest.js index 7badbd86a9..2711344c4f 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/iLRRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/iLRRequest.js @@ -17,7 +17,7 @@ class ILRRequest { /** * Create a ILRRequest. - * @member {string} objectType Polymorphic Discriminator + * @property {string} objectType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/iLRRequestResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/iLRRequestResource.js index 90a5b00bb8..21255fd91c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/iLRRequestResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/iLRRequestResource.js @@ -20,8 +20,8 @@ const models = require('./index'); class ILRRequestResource extends models['Resource'] { /** * Create a ILRRequestResource. - * @member {object} [properties] ILRRequestResource properties - * @member {string} [properties.objectType] Polymorphic Discriminator + * @property {object} [properties] ILRRequestResource properties + * @property {string} [properties.objectType] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/iaaSVMContainer.js b/lib/services/recoveryServicesBackupManagement/lib/models/iaaSVMContainer.js index 7d87270cc1..fa964e1c45 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/iaaSVMContainer.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/iaaSVMContainer.js @@ -20,12 +20,12 @@ const models = require('./index'); class IaaSVMContainer extends models['ProtectionContainer'] { /** * Create a IaaSVMContainer. - * @member {string} [virtualMachineId] Fully qualified ARM url of the virtual - * machine represented by this Azure IaaS VM container. - * @member {string} [virtualMachineVersion] Specifies whether the container + * @property {string} [virtualMachineId] Fully qualified ARM url of the + * virtual machine represented by this Azure IaaS VM container. + * @property {string} [virtualMachineVersion] Specifies whether the container * represents a Classic or an Azure Resource Manager VM. - * @member {string} [resourceGroup] Resource group name of Recovery Services - * Vault. + * @property {string} [resourceGroup] Resource group name of Recovery + * Services Vault. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/iaaSVMProtectableItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/iaaSVMProtectableItem.js index 522918ffdc..a2f9815af5 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/iaaSVMProtectableItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/iaaSVMProtectableItem.js @@ -20,8 +20,8 @@ const models = require('./index'); class IaaSVMProtectableItem extends models['WorkloadProtectableItem'] { /** * Create a IaaSVMProtectableItem. - * @member {string} [virtualMachineId] Fully qualified ARM ID of the virtual - * machine. + * @property {string} [virtualMachineId] Fully qualified ARM ID of the + * virtual machine. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMBackupRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMBackupRequest.js index 123a1545f7..ca7cafa474 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMBackupRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMBackupRequest.js @@ -20,7 +20,7 @@ const models = require('./index'); class IaasVMBackupRequest extends models['BackupRequest'] { /** * Create a IaasVMBackupRequest. - * @member {date} [recoveryPointExpiryTimeInUTC] Backup copy will expire + * @property {date} [recoveryPointExpiryTimeInUTC] Backup copy will expire * after the time specified (UTC). */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMILRRegistrationRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMILRRegistrationRequest.js index 58914c5f3e..8cacbfcd13 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMILRRegistrationRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMILRRegistrationRequest.js @@ -20,12 +20,12 @@ const models = require('./index'); class IaasVMILRRegistrationRequest extends models['ILRRequest'] { /** * Create a IaasVMILRRegistrationRequest. - * @member {string} [recoveryPointId] ID of the IaaS VM backup copy from + * @property {string} [recoveryPointId] ID of the IaaS VM backup copy from * where the files/folders have to be restored. - * @member {string} [virtualMachineId] Fully qualified ARM ID of the virtual - * machine whose the files / folders have to be restored. - * @member {string} [initiatorName] iSCSI initiator name. - * @member {boolean} [renewExistingRegistration] Whether to renew existing + * @property {string} [virtualMachineId] Fully qualified ARM ID of the + * virtual machine whose the files / folders have to be restored. + * @property {string} [initiatorName] iSCSI initiator name. + * @property {boolean} [renewExistingRegistration] Whether to renew existing * registration with the iSCSI server. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMRecoveryPoint.js b/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMRecoveryPoint.js index b18baaaff0..2975a4f48c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMRecoveryPoint.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMRecoveryPoint.js @@ -20,40 +20,41 @@ const models = require('./index'); class IaasVMRecoveryPoint extends models['RecoveryPoint'] { /** * Create a IaasVMRecoveryPoint. - * @member {string} [recoveryPointType] Type of the backup copy. - * @member {date} [recoveryPointTime] Time at which this backup copy was + * @property {string} [recoveryPointType] Type of the backup copy. + * @property {date} [recoveryPointTime] Time at which this backup copy was * created. - * @member {string} [recoveryPointAdditionalInfo] Additional information + * @property {string} [recoveryPointAdditionalInfo] Additional information * associated with this backup copy. - * @member {string} [sourceVMStorageType] Storage type of the VM whose backup - * copy is created. - * @member {boolean} [isSourceVMEncrypted] Identifies whether the VM was + * @property {string} [sourceVMStorageType] Storage type of the VM whose + * backup copy is created. + * @property {boolean} [isSourceVMEncrypted] Identifies whether the VM was * encrypted when the backup copy is created. - * @member {object} [keyAndSecret] Required details for recovering an + * @property {object} [keyAndSecret] Required details for recovering an * encrypted VM. Applicable only when IsSourceVMEncrypted is true. - * @member {object} [keyAndSecret.kekDetails] KEK is encryption key for BEK. - * @member {string} [keyAndSecret.kekDetails.keyUrl] Key is KEK. - * @member {string} [keyAndSecret.kekDetails.keyVaultId] Key Vault ID where + * @property {object} [keyAndSecret.kekDetails] KEK is encryption key for + * BEK. + * @property {string} [keyAndSecret.kekDetails.keyUrl] Key is KEK. + * @property {string} [keyAndSecret.kekDetails.keyVaultId] Key Vault ID where * this Key is stored. - * @member {string} [keyAndSecret.kekDetails.keyBackupData] KEK data. - * @member {object} [keyAndSecret.bekDetails] BEK is bitlocker encrpytion + * @property {string} [keyAndSecret.kekDetails.keyBackupData] KEK data. + * @property {object} [keyAndSecret.bekDetails] BEK is bitlocker encryption * key. - * @member {string} [keyAndSecret.bekDetails.secretUrl] Secret is BEK. - * @member {string} [keyAndSecret.bekDetails.secretVaultId] ID of the Key + * @property {string} [keyAndSecret.bekDetails.secretUrl] Secret is BEK. + * @property {string} [keyAndSecret.bekDetails.secretVaultId] ID of the Key * Vault where this Secret is stored. - * @member {string} [keyAndSecret.bekDetails.secretData] BEK data. - * @member {string} [keyAndSecret.encryptionMechanism] Encryption mechanism: - * None/ SinglePass/ DoublePass - * @member {boolean} [isInstantIlrSessionActive] Is the session to recover + * @property {string} [keyAndSecret.bekDetails.secretData] BEK data. + * @property {string} [keyAndSecret.encryptionMechanism] Encryption + * mechanism: None/ SinglePass/ DoublePass + * @property {boolean} [isInstantIlrSessionActive] Is the session to recover * items from this backup copy still active. - * @member {array} [recoveryPointTierDetails] Recovery point tier + * @property {array} [recoveryPointTierDetails] Recovery point tier * information. - * @member {boolean} [isManagedVirtualMachine] Whether VM is with Managed + * @property {boolean} [isManagedVirtualMachine] Whether VM is with Managed * Disks - * @member {string} [virtualMachineSize] Virtual Machine Size - * @member {boolean} [originalStorageAccountOption] Original Storage Account - * Option - * @member {string} [osType] OS type + * @property {string} [virtualMachineSize] Virtual Machine Size + * @property {boolean} [originalStorageAccountOption] Original Storage + * Account Option + * @property {string} [osType] OS type */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMRestoreRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMRestoreRequest.js index c08792b75b..896154ac67 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMRestoreRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/iaasVMRestoreRequest.js @@ -20,52 +20,54 @@ const models = require('./index'); class IaasVMRestoreRequest extends models['RestoreRequest'] { /** * Create a IaasVMRestoreRequest. - * @member {string} [recoveryPointId] ID of the backup copy to be recovered. - * @member {string} [recoveryType] Type of this recovery. Possible values + * @property {string} [recoveryPointId] ID of the backup copy to be + * recovered. + * @property {string} [recoveryType] Type of this recovery. Possible values * include: 'Invalid', 'OriginalLocation', 'AlternateLocation', * 'RestoreDisks' - * @member {string} [sourceResourceId] Fully qualified ARM ID of the VM which - * is being recovered. - * @member {string} [targetVirtualMachineId] This is the complete ARM Id of + * @property {string} [sourceResourceId] Fully qualified ARM ID of the VM + * which is being recovered. + * @property {string} [targetVirtualMachineId] This is the complete ARM Id of * the VM that will be created. * For e.g. * /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm} - * @member {string} [targetResourceGroupId] This is the ARM Id of the + * @property {string} [targetResourceGroupId] This is the ARM Id of the * resource group that you want to create for this Virtual machine and other * artifacts. * For e.g. /subscriptions/{subId}/resourcegroups/{rg} - * @member {string} [storageAccountId] Fully qualified ARM ID of the storage - * account to which the VM has to be restored. - * @member {string} [virtualNetworkId] This is the virtual network Id of the - * vnet that will be attached to the virtual machine. + * @property {string} [storageAccountId] Fully qualified ARM ID of the + * storage account to which the VM has to be restored. + * @property {string} [virtualNetworkId] This is the virtual network Id of + * the vnet that will be attached to the virtual machine. * User will be validated for join action permissions in the linked access. - * @member {string} [subnetId] Subnet ID, is the subnet ID associated with + * @property {string} [subnetId] Subnet ID, is the subnet ID associated with * the to be restored VM. For Classic VMs it would be * {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it * would be ARM resource ID used to represent * the subnet. - * @member {string} [targetDomainNameId] Fully qualified ARM ID of the domain - * name to be associated to the VM being restored. This applies only to - * Classic + * @property {string} [targetDomainNameId] Fully qualified ARM ID of the + * domain name to be associated to the VM being restored. This applies only + * to Classic * Virtual Machines. - * @member {string} [region] Region in which the virtual machine is restored. - * @member {string} [affinityGroup] Affinity group associated to VM to be + * @property {string} [region] Region in which the virtual machine is + * restored. + * @property {string} [affinityGroup] Affinity group associated to VM to be * restored. Used only for Classic Compute Virtual Machines. - * @member {boolean} [createNewCloudService] Should a new cloud service be + * @property {boolean} [createNewCloudService] Should a new cloud service be * created while restoring the VM. If this is false, VM will be restored to * the same * cloud service as it was at the time of backup. - * @member {boolean} [originalStorageAccountOption] Original Storage Account - * Option - * @member {object} [encryptionDetails] Details needed if the VM was + * @property {boolean} [originalStorageAccountOption] Original Storage + * Account Option + * @property {object} [encryptionDetails] Details needed if the VM was * encrypted at the time of backup. - * @member {boolean} [encryptionDetails.encryptionEnabled] Identifies whether - * this backup copy represents an encrypted VM at the time of backup. - * @member {string} [encryptionDetails.kekUrl] Key Url. - * @member {string} [encryptionDetails.secretKeyUrl] Secret Url. - * @member {string} [encryptionDetails.kekVaultId] ID of Key Vault where KEK - * is stored. - * @member {string} [encryptionDetails.secretKeyVaultId] ID of Key Vault + * @property {boolean} [encryptionDetails.encryptionEnabled] Identifies + * whether this backup copy represents an encrypted VM at the time of backup. + * @property {string} [encryptionDetails.kekUrl] Key Url. + * @property {string} [encryptionDetails.secretKeyUrl] Secret Url. + * @property {string} [encryptionDetails.kekVaultId] ID of Key Vault where + * KEK is stored. + * @property {string} [encryptionDetails.secretKeyVaultId] ID of Key Vault * where Secret is stored. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/index.d.ts b/lib/services/recoveryServicesBackupManagement/lib/models/index.d.ts index f5ac0e9126..54e3e038d3 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/index.d.ts +++ b/lib/services/recoveryServicesBackupManagement/lib/models/index.d.ts @@ -1,4757 +1,4232 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { BaseResource } from 'ms-rest-azure'; -import { CloudError } from 'ms-rest-azure'; -import * as moment from 'moment'; +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; -export { BaseResource } from 'ms-rest-azure'; -export { CloudError } from 'ms-rest-azure'; +export { + BaseResource, + CloudError +}; /** - * @class - * Initializes a new instance of the FeatureSupportRequest class. - * @constructor * Base class for feature request - * - * @member {string} featureType Polymorphic Discriminator */ export interface FeatureSupportRequest { + /** + * Polymorphic Discriminator + */ featureType: string; } /** - * @class - * Initializes a new instance of the AzureBackupGoalFeatureSupportRequest class. - * @constructor * Azure backup goal feature specific request. - * */ export interface AzureBackupGoalFeatureSupportRequest extends FeatureSupportRequest { } /** - * @class - * Initializes a new instance of the AzureFileshareProtectedItemExtendedInfo class. - * @constructor * Additional information about Azure File Share backup item. - * - * @member {date} [oldestRecoveryPoint] The oldest backup copy available for - * this item in the service. - * @member {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. */ export interface AzureFileshareProtectedItemExtendedInfo { + /** + * The oldest backup copy available for this item in the service. + */ oldestRecoveryPoint?: Date; + /** + * Number of available backup copies associated with this backup item. + */ recoveryPointCount?: number; + /** + * Indicates consistency of policy object and policy applied to this backup item. + */ policyState?: string; } /** - * @class - * Initializes a new instance of the ProtectedItem class. - * @constructor * Base class for backup items. - * - * @member {string} [backupManagementType] Type of backup managemenent for the - * backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', - * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [workloadType] Type of workload this item represents. - * Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', - * 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', - * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' - * @member {string} [containerName] Unique name of container - * @member {string} [sourceResourceId] ARM ID of the resource to be backed up. - * @member {string} [policyId] ID of the backup policy with which this item is - * backed up. - * @member {date} [lastRecoveryPoint] Timestamp when the last (latest) backup - * copy was created for this backup item. - * @member {string} [backupSetName] Name of the backup set the backup item - * belongs to - * @member {string} [createMode] Create mode to indicate recovery of existing - * soft deleted data source or creation of new data source. Possible values - * include: 'Invalid', 'Default', 'Recover' - * @member {string} protectedItemType Polymorphic Discriminator */ export interface ProtectedItem { + /** + * Type of backup management for the backed up item. Possible values include: 'Invalid', + * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; + /** + * Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', + * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', + * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' + */ workloadType?: string; + /** + * Unique name of container + */ containerName?: string; + /** + * ARM ID of the resource to be backed up. + */ sourceResourceId?: string; + /** + * ID of the backup policy with which this item is backed up. + */ policyId?: string; + /** + * Timestamp when the last (latest) backup copy was created for this backup item. + */ lastRecoveryPoint?: Date; + /** + * Name of the backup set the backup item belongs to + */ backupSetName?: string; + /** + * Create mode to indicate recovery of existing soft deleted data source or creation of new data + * source. Possible values include: 'Invalid', 'Default', 'Recover' + */ createMode?: string; + /** + * Polymorphic Discriminator + */ protectedItemType: string; } /** - * @class - * Initializes a new instance of the AzureFileshareProtectedItem class. - * @constructor * Azure File Share workload-specific backup item. - * - * @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. - * Possible values include: 'Invalid', 'IRPending', 'Protected', - * 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' - * @member {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 - * item. - * @member {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy - * available for this item in the service. - * @member {number} [extendedInfo.recoveryPointCount] Number of available - * backup copies associated with this backup item. - * @member {string} [extendedInfo.policyState] Indicates consistency of policy - * object and policy applied to this backup item. */ export interface AzureFileshareProtectedItem extends ProtectedItem { + /** + * Friendly name of the fileshare represented by this backup item. + */ friendlyName?: string; + /** + * Backup status of this backup item. + */ protectionStatus?: string; + /** + * Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', + * 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' + */ protectionState?: string; + /** + * backups running status for this backup item. Possible values include: 'Passed', + * 'ActionRequired', 'ActionSuggested', 'Invalid' + */ healthStatus?: string; + /** + * Last backup operation status. Possible values: Healthy, Unhealthy. + */ lastBackupStatus?: string; + /** + * Timestamp of the last backup operation on this backup item. + */ lastBackupTime?: Date; + /** + * Additional information with this backup item. + */ extendedInfo?: AzureFileshareProtectedItemExtendedInfo; } /** - * @class - * Initializes a new instance of the SchedulePolicy class. - * @constructor * Base class for backup schedule. - * - * @member {string} schedulePolicyType Polymorphic Discriminator */ export interface SchedulePolicy { + /** + * Polymorphic Discriminator + */ schedulePolicyType: string; } /** - * @class - * Initializes a new instance of the RetentionPolicy class. - * @constructor * Base class for retention policy. - * - * @member {string} retentionPolicyType Polymorphic Discriminator */ export interface RetentionPolicy { + /** + * Polymorphic Discriminator + */ retentionPolicyType: string; } /** - * @class - * Initializes a new instance of the ProtectionPolicy class. - * @constructor - * Base class for backup policy. Workload-specific backup policies are derived - * from this class. - * - * @member {number} [protectedItemsCount] Number of items associated with this - * policy. - * @member {string} backupManagementType Polymorphic Discriminator + * Base class for backup policy. Workload-specific backup policies are derived from this class. */ export interface ProtectionPolicy { + /** + * Number of items associated with this policy. + */ protectedItemsCount?: number; + /** + * Polymorphic Discriminator + */ backupManagementType: string; } /** - * @class - * Initializes a new instance of the AzureFileShareProtectionPolicy class. - * @constructor * AzureStorage backup policy. - * - * @member {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 - * backup policy. - * @member {string} [schedulePolicy.schedulePolicyType] Polymorphic - * Discriminator - * @member {object} [retentionPolicy] Retention policy with the details on - * backup copy retention ranges. - * @member {string} [retentionPolicy.retentionPolicyType] Polymorphic - * Discriminator - * @member {string} [timeZone] TimeZone optional input as string. For example: - * TimeZone = "Pacific Standard Time". */ export interface AzureFileShareProtectionPolicy extends ProtectionPolicy { + /** + * Type of workload for the backup management. Possible values include: 'Invalid', 'VM', + * 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', + * 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' + */ workLoadType?: string; + /** + * Backup schedule specified as part of backup policy. + */ schedulePolicy?: SchedulePolicy; + /** + * Retention policy with the details on backup copy retention ranges. + */ retentionPolicy?: RetentionPolicy; + /** + * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time". + */ timeZone?: string; } /** - * @class - * Initializes a new instance of the RestoreFileSpecs class. - * @constructor * Restore file specs like file path, type and target folder path info. - * - * @member {string} [path] Source File/Folder path - * @member {string} [fileSpecType] Indicates what the Path variable stands for - * @member {string} [targetFolderPath] Destination folder path in target - * FileShare */ export interface RestoreFileSpecs { + /** + * Source File/Folder path + */ path?: string; + /** + * Indicates what the Path variable stands for + */ fileSpecType?: string; + /** + * Destination folder path in target FileShare + */ targetFolderPath?: string; } /** - * @class - * Initializes a new instance of the TargetAFSRestoreInfo class. - * @constructor * Target Azure File Share Info. - * - * @member {string} [name] File share name - * @member {string} [targetResourceId] Target file share resource ARM ID */ export interface TargetAFSRestoreInfo { + /** + * File share name + */ name?: string; + /** + * Target file share resource ARM ID + */ targetResourceId?: string; } /** - * @class - * Initializes a new instance of the RestoreRequest class. - * @constructor - * Base class for restore request. Workload-specific restore requests are - * derived from this class. - * - * @member {string} objectType Polymorphic Discriminator + * Base class for restore request. Workload-specific restore requests are derived from this class. */ export interface RestoreRequest { + /** + * Polymorphic Discriminator + */ objectType: string; } /** - * @class - * Initializes a new instance of the AzureFileShareRestoreRequest class. - * @constructor * AzureFileShare Restore Request - * - * @member {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', - * 'FailOnConflict' - * @member {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 resource - * ARM ID */ export interface AzureFileShareRestoreRequest extends RestoreRequest { + /** + * Type of this recovery. Possible values include: 'Invalid', 'OriginalLocation', + * 'AlternateLocation', 'RestoreDisks' + */ recoveryType?: string; + /** + * Source storage account ARM Id + */ sourceResourceId?: string; + /** + * Options to resolve copy conflicts. Possible values include: 'Invalid', 'CreateCopy', 'Skip', + * 'Overwrite', 'FailOnConflict' + */ copyOptions?: string; + /** + * Restore Type (FullShareRestore or ItemLevelRestore). Possible values include: 'Invalid', + * 'FullShareRestore', 'ItemLevelRestore' + */ restoreRequestType?: string; + /** + * List of Source Files/Folders(which need to recover) and TargetFolderPath details + */ restoreFileSpecs?: RestoreFileSpecs[]; + /** + * Target File Share Details + */ targetDetails?: TargetAFSRestoreInfo; } /** - * @class - * Initializes a new instance of the AzureIaaSVMProtectedItem class. - * @constructor * IaaS VM workload-specific backup item. - * - * @member {string} [friendlyName] Friendly name of the VM represented by this - * backup item. - * @member {string} [virtualMachineId] Fully qualified ARM ID of the virtual - * machine represented by this item. - * @member {string} [protectionStatus] Backup status of this backup item. - * @member {string} [protectionState] Backup state of this backup item. - * Possible values include: 'Invalid', 'IRPending', 'Protected', - * 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' - * @member {string} [healthStatus] Health status of protected item. Possible - * values include: 'Passed', 'ActionRequired', 'ActionSuggested', 'Invalid' - * @member {array} [healthDetails] Health details on this backup item. - * @member {string} [lastBackupStatus] Last backup operation status. - * @member {date} [lastBackupTime] Timestamp of the last backup operation on - * this backup item. - * @member {string} [protectedItemDataId] Data ID of the protected item. - * @member {object} [extendedInfo] Additional information for this backup item. - * @member {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy - * available for this backup item. - * @member {number} [extendedInfo.recoveryPointCount] Number of backup copies - * available for this backup item. - * @member {boolean} [extendedInfo.policyInconsistent] Specifies if backup - * policy associated with the backup item is inconsistent. */ export interface AzureIaaSVMProtectedItem extends ProtectedItem { + /** + * Friendly name of the VM represented by this backup item. + */ friendlyName?: string; + /** + * Fully qualified ARM ID of the virtual machine represented by this item. + */ virtualMachineId?: string; + /** + * Backup status of this backup item. + */ protectionStatus?: string; + /** + * Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', + * 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' + */ protectionState?: string; + /** + * Health status of protected item. Possible values include: 'Passed', 'ActionRequired', + * 'ActionSuggested', 'Invalid' + */ healthStatus?: string; + /** + * Health details on this backup item. + */ healthDetails?: AzureIaaSVMHealthDetails[]; + /** + * Last backup operation status. + */ lastBackupStatus?: string; + /** + * Timestamp of the last backup operation on this backup item. + */ lastBackupTime?: Date; + /** + * Data ID of the protected item. + */ protectedItemDataId?: string; + /** + * Additional information for this backup item. + */ extendedInfo?: AzureIaaSVMProtectedItemExtendedInfo; } /** - * @class - * Initializes a new instance of the AzureIaaSClassicComputeVMProtectedItem class. - * @constructor * IaaS VM workload-specific backup item representing the Classic Compute VM. - * */ export interface AzureIaaSClassicComputeVMProtectedItem extends AzureIaaSVMProtectedItem { } /** - * @class - * Initializes a new instance of the AzureIaaSComputeVMProtectedItem class. - * @constructor - * IaaS VM workload-specific backup item representing the Azure Resource - * Manager VM. - * + * IaaS VM workload-specific backup item representing the Azure Resource Manager VM. */ export interface AzureIaaSComputeVMProtectedItem extends AzureIaaSVMProtectedItem { } /** - * @class - * Initializes a new instance of the AzureIaaSVMErrorInfo class. - * @constructor * Azure IaaS VM workload-specific error information. - * - * @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 - * above error code. */ export interface AzureIaaSVMErrorInfo { + /** + * Error code. + */ errorCode?: number; + /** + * Title: Typically, the entity that the error pertains to. + */ errorTitle?: string; + /** + * Localized error string. + */ errorString?: string; + /** + * List of localized recommendations for above error code. + */ recommendations?: string[]; } /** - * @class - * Initializes a new instance of the AzureIaaSVMHealthDetails class. - * @constructor * Azure IaaS VM workload-specific Health Details. - * - * @member {number} [code] Health Code - * @member {string} [title] Health Title - * @member {string} [message] Health Message - * @member {array} [recommendations] Health Recommended Actions */ export interface AzureIaaSVMHealthDetails { + /** + * Health Code + */ code?: number; + /** + * Health Title + */ title?: string; + /** + * Health Message + */ message?: string; + /** + * Health Recommended Actions + */ recommendations?: string[]; } /** - * @class - * Initializes a new instance of the AzureIaaSVMJobTaskDetails class. - * @constructor * Azure IaaS VM workload-specific job task details. - * - * @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 task. - * eg: number of bytes transfered etc */ export interface AzureIaaSVMJobTaskDetails { + /** + * The task display name. + */ taskId?: string; + /** + * The start time. + */ startTime?: Date; + /** + * The end time. + */ endTime?: Date; + /** + * The instanceId. + */ instanceId?: string; + /** + * Time elapsed for task. + */ duration?: moment.Duration; + /** + * The status. + */ status?: string; + /** + * Progress of the task. + */ progressPercentage?: number; + /** + * Details about execution of the task. + * eg: number of bytes transferred etc + */ taskExecutionDetails?: string; } /** - * @class - * Initializes a new instance of the AzureIaaSVMJobExtendedInfo class. - * @constructor * Azure IaaS VM workload-specific additional information for job. - * - * @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. */ export interface AzureIaaSVMJobExtendedInfo { + /** + * List of tasks associated with this job. + */ tasksList?: AzureIaaSVMJobTaskDetails[]; + /** + * Job properties. + */ propertyBag?: { [propertyName: string]: string }; + /** + * Job internal properties. + */ internalPropertyBag?: { [propertyName: string]: string }; + /** + * Indicates progress of the job. Null if it has not started or completed. + */ progressPercentage?: number; + /** + * Time remaining for execution of this job. + */ estimatedRemainingDuration?: string; + /** + * Non localized error message on job execution. + */ dynamicErrorMessage?: string; } /** - * @class - * Initializes a new instance of the Job class. - * @constructor * Defines workload agnostic properties for a job. - * - * @member {string} [entityFriendlyName] Friendly name of the entity on which - * the current job is executing. - * @member {string} [backupManagementType] Backup management type to execute - * the current job. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', - * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [operation] The operation name. - * @member {string} [status] Job status. - * @member {date} [startTime] The start time. - * @member {date} [endTime] The end time. - * @member {string} [activityId] ActivityId of job. - * @member {string} jobType Polymorphic Discriminator */ export interface Job { + /** + * Friendly name of the entity on which the current job is executing. + */ entityFriendlyName?: string; + /** + * Backup management type to execute the current job. Possible values include: 'Invalid', + * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; + /** + * The operation name. + */ operation?: string; + /** + * Job status. + */ status?: string; + /** + * The start time. + */ startTime?: Date; + /** + * The end time. + */ endTime?: Date; + /** + * ActivityId of job. + */ activityId?: string; + /** + * Polymorphic Discriminator + */ jobType: string; } /** - * @class - * Initializes a new instance of the AzureIaaSVMJob class. - * @constructor - * Azure IaaS VM workload-specifc job object. - * - * @member {moment.duration} [duration] Time elapsed during the execution of - * 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 properties. - * @member {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 - * message on job execution. + * Azure IaaS VM workload-specific job object. */ export interface AzureIaaSVMJob extends Job { + /** + * Time elapsed during the execution of this job. + */ duration?: moment.Duration; + /** + * Gets or sets the state/actions applicable on this job like cancel/retry. + */ actionsInfo?: string[]; + /** + * Error details on execution of this job. + */ errorDetails?: AzureIaaSVMErrorInfo[]; + /** + * Specifies whether the backup item is a Classic or an Azure Resource Manager VM. + */ virtualMachineVersion?: string; + /** + * Additional information for this job. + */ extendedInfo?: AzureIaaSVMJobExtendedInfo; } /** - * @class - * Initializes a new instance of the AzureIaaSVMProtectedItemExtendedInfo class. - * @constructor * Additional information on Azure IaaS VM specific backup item. - * - * @member {date} [oldestRecoveryPoint] The oldest backup copy available for - * this backup item. - * @member {number} [recoveryPointCount] Number of backup copies available for - * this backup item. - * @member {boolean} [policyInconsistent] Specifies if backup policy associated - * with the backup item is inconsistent. */ export interface AzureIaaSVMProtectedItemExtendedInfo { + /** + * The oldest backup copy available for this backup item. + */ oldestRecoveryPoint?: Date; + /** + * Number of backup copies available for this backup item. + */ recoveryPointCount?: number; + /** + * Specifies if backup policy associated with the backup item is inconsistent. + */ policyInconsistent?: boolean; } /** - * @class - * Initializes a new instance of the AzureIaaSVMProtectionPolicy class. - * @constructor * IaaS VM workload-specific backup policy. - * - * @member {object} [schedulePolicy] Backup schedule specified as part of - * backup policy. - * @member {string} [schedulePolicy.schedulePolicyType] Polymorphic - * Discriminator - * @member {object} [retentionPolicy] Retention policy with the details on - * backup copy retention ranges. - * @member {string} [retentionPolicy.retentionPolicyType] Polymorphic - * Discriminator - * @member {number} [instantRpRetentionRangeInDays] Instant RP retention policy - * range in days - * @member {string} [timeZone] TimeZone optional input as string. For example: - * TimeZone = "Pacific Standard Time". */ export interface AzureIaaSVMProtectionPolicy extends ProtectionPolicy { + /** + * Backup schedule specified as part of backup policy. + */ schedulePolicy?: SchedulePolicy; + /** + * Retention policy with the details on backup copy retention ranges. + */ retentionPolicy?: RetentionPolicy; + /** + * Instant RP retention policy range in days + */ instantRpRetentionRangeInDays?: number; + /** + * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time". + */ timeZone?: string; } /** - * @class - * Initializes a new instance of the ProtectionIntent class. - * @constructor * Base class for backup ProtectionIntent. - * - * @member {string} [backupManagementType] Type of backup managemenent for the - * backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', - * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [sourceResourceId] ARM ID of the resource to be backed up. - * @member {string} [itemId] ID of the item which is getting protected, In case - * of Azure Vm , it is ProtectedItemId - * @member {string} [policyId] ID of the backup policy with which this item is - * backed up. - * @member {string} [protectionState] Backup state of this backup item. - * Possible values include: 'Invalid', 'NotProtected', 'Protecting', - * 'Protected', 'ProtectionFailed' - * @member {string} protectionIntentItemType Polymorphic Discriminator */ export interface ProtectionIntent { + /** + * Type of backup management for the backed up item. Possible values include: 'Invalid', + * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; + /** + * ARM ID of the resource to be backed up. + */ sourceResourceId?: string; + /** + * ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId + */ itemId?: string; + /** + * ID of the backup policy with which this item is backed up. + */ policyId?: string; + /** + * Backup state of this backup item. Possible values include: 'Invalid', 'NotProtected', + * 'Protecting', 'Protected', 'ProtectionFailed' + */ protectionState?: string; + /** + * Polymorphic Discriminator + */ protectionIntentItemType: string; } /** - * @class - * Initializes a new instance of the AzureRecoveryServiceVaultProtectionIntent class. - * @constructor * Azure Recovery Services Vault specific protection intent item. - * */ export interface AzureRecoveryServiceVaultProtectionIntent extends ProtectionIntent { } /** - * @class - * Initializes a new instance of the AzureResourceProtectionIntent class. - * @constructor * IaaS VM specific backup protection intent item. - * - * @member {string} [friendlyName] Friendly name of the VM represented by this - * backup item. */ export interface AzureResourceProtectionIntent extends ProtectionIntent { + /** + * Friendly name of the VM represented by this backup item. + */ friendlyName?: string; } /** - * @class - * Initializes a new instance of the AzureSqlProtectedItemExtendedInfo class. - * @constructor * Additional information on Azure Sql specific protected item. - * - * @member {date} [oldestRecoveryPoint] The oldest backup copy available for - * this item in the service. - * @member {number} [recoveryPointCount] Number of available backup copies - * associated with this backup item. - * @member {string} [policyState] State of the backup policy associated with - * this backup item. */ export interface AzureSqlProtectedItemExtendedInfo { + /** + * The oldest backup copy available for this item in the service. + */ oldestRecoveryPoint?: Date; + /** + * Number of available backup copies associated with this backup item. + */ recoveryPointCount?: number; + /** + * State of the backup policy associated with this backup item. + */ policyState?: string; } /** - * @class - * Initializes a new instance of the AzureSqlProtectedItem class. - * @constructor * Azure SQL workload-specific backup item. - * - * @member {string} [protectedItemDataId] Internal ID of a backup item. Used by - * Azure SQL Backup engine to contact Recovery Services. - * @member {string} [protectionState] Backup state of the backed up item. - * Possible values include: 'Invalid', 'IRPending', 'Protected', - * 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' - * @member {object} [extendedInfo] Additional information for this backup item. - * @member {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy - * available for this item in the service. - * @member {number} [extendedInfo.recoveryPointCount] Number of available - * backup copies associated with this backup item. - * @member {string} [extendedInfo.policyState] State of the backup policy - * associated with this backup item. */ export interface AzureSqlProtectedItem extends ProtectedItem { + /** + * Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services. + */ protectedItemDataId?: string; + /** + * Backup state of the backed up item. Possible values include: 'Invalid', 'IRPending', + * 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' + */ protectionState?: string; + /** + * Additional information for this backup item. + */ extendedInfo?: AzureSqlProtectedItemExtendedInfo; } /** - * @class - * Initializes a new instance of the AzureSqlProtectionPolicy class. - * @constructor * Azure SQL workload-specific backup policy. - * - * @member {object} [retentionPolicy] Retention policy details. - * @member {string} [retentionPolicy.retentionPolicyType] Polymorphic - * Discriminator */ export interface AzureSqlProtectionPolicy extends ProtectionPolicy { + /** + * Retention policy details. + */ retentionPolicy?: RetentionPolicy; } /** - * @class - * Initializes a new instance of the AzureStorageErrorInfo class. - * @constructor * Azure storage specific error information - * - * @member {number} [errorCode] Error code. - * @member {string} [errorString] Localized error string. - * @member {array} [recommendations] List of localized recommendations for - * above error code. */ export interface AzureStorageErrorInfo { + /** + * Error code. + */ errorCode?: number; + /** + * Localized error string. + */ errorString?: string; + /** + * List of localized recommendations for above error code. + */ recommendations?: string[]; } /** - * @class - * Initializes a new instance of the AzureStorageJobTaskDetails class. - * @constructor * Azure storage workload specific job task details. - * - * @member {string} [taskId] The task display name. - * @member {string} [status] The status. */ export interface AzureStorageJobTaskDetails { + /** + * The task display name. + */ taskId?: string; + /** + * The status. + */ status?: string; } /** - * @class - * Initializes a new instance of the AzureStorageJobExtendedInfo class. - * @constructor * Azure Storage workload-specific additional information for job. - * - * @member {array} [tasksList] List of tasks for this job - * @member {object} [propertyBag] Job properties. - * @member {string} [dynamicErrorMessage] Non localized error message on job - * execution. */ export interface AzureStorageJobExtendedInfo { + /** + * List of tasks for this job + */ tasksList?: AzureStorageJobTaskDetails[]; + /** + * Job properties. + */ propertyBag?: { [propertyName: string]: string }; + /** + * Non localized error message on job execution. + */ dynamicErrorMessage?: string; } /** - * @class - * Initializes a new instance of the AzureStorageJob class. - * @constructor * Azure storage specific job. - * - * @member {moment.duration} [duration] Time elapsed during the execution of - * 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} [storageAccountName] Specifies friendly name of the storage - * account. - * @member {string} [storageAccountVersion] Specifies whether the Storage - * account is a Classic or an Azure Resource Manager Storage account. - * @member {object} [extendedInfo] Additional information about the job. - * @member {array} [extendedInfo.tasksList] List of tasks for this job - * @member {object} [extendedInfo.propertyBag] Job properties. - * @member {string} [extendedInfo.dynamicErrorMessage] Non localized error - * message on job execution. */ export interface AzureStorageJob extends Job { + /** + * Time elapsed during the execution of this job. + */ duration?: moment.Duration; + /** + * Gets or sets the state/actions applicable on this job like cancel/retry. + */ actionsInfo?: string[]; + /** + * Error details on execution of this job. + */ errorDetails?: AzureStorageErrorInfo[]; + /** + * Specifies friendly name of the storage account. + */ storageAccountName?: string; + /** + * Specifies whether the Storage account is a Classic or an Azure Resource Manager Storage + * account. + */ storageAccountVersion?: string; + /** + * Additional information about the job. + */ extendedInfo?: AzureStorageJobExtendedInfo; } /** - * @class - * Initializes a new instance of the AzureVMResourceFeatureSupportRequest class. - * @constructor * AzureResource(IaaS VM) Specific feature support request - * - * @member {string} [vmSize] Size of the resource: VM size(A/D series etc) in - * case of IaasVM - * @member {string} [vmSku] SKUs (Premium/Managed etc) in case of IaasVM */ export interface AzureVMResourceFeatureSupportRequest extends FeatureSupportRequest { + /** + * Size of the resource: VM size(A/D series etc) in case of IaasVM + */ vmSize?: string; + /** + * SKUs (Premium/Managed etc) in case of IaasVM + */ vmSku?: string; } /** - * @class - * Initializes a new instance of the AzureVMResourceFeatureSupportResponse class. - * @constructor * Response for feature support requests for Azure IaasVm - * - * @member {string} [supportStatus] Support status of feature. Possible values - * include: 'Invalid', 'Supported', 'DefaultOFF', 'DefaultON', 'NotSupported' */ export interface AzureVMResourceFeatureSupportResponse { + /** + * Support status of feature. Possible values include: 'Invalid', 'Supported', 'DefaultOFF', + * 'DefaultON', 'NotSupported' + */ supportStatus?: string; } /** - * @class - * Initializes a new instance of the ErrorDetail class. - * @constructor * Error Detail class which encapsulates Code, Message and Recommendations. - * - * @member {string} [code] Error code. - * @member {string} [message] Error Message related to the Code. - * @member {array} [recommendations] List of recommendation strings. */ export interface ErrorDetail { + /** + * Error code. + */ code?: string; + /** + * Error Message related to the Code. + */ message?: string; + /** + * List of recommendation strings. + */ recommendations?: string[]; } /** - * @class - * Initializes a new instance of the AzureVmWorkloadProtectedItemExtendedInfo class. - * @constructor * Additional information on Azure Workload for SQL specific backup item. - * - * @member {date} [oldestRecoveryPoint] The oldest backup copy available for - * this backup item. - * @member {number} [recoveryPointCount] Number of backup copies available for - * this backup item. - * @member {string} [policyState] Indicates consistency of policy object and - * policy applied to this backup item. */ export interface AzureVmWorkloadProtectedItemExtendedInfo { + /** + * The oldest backup copy available for this backup item. + */ oldestRecoveryPoint?: Date; + /** + * Number of backup copies available for this backup item. + */ recoveryPointCount?: number; + /** + * Indicates consistency of policy object and policy applied to this backup item. + */ policyState?: string; } /** - * @class - * Initializes a new instance of the AzureVmWorkloadProtectedItem class. - * @constructor * Azure VM workload-specific protected item. - * - * @member {string} [friendlyName] Friendly name of the DB represented by this - * backup item. - * @member {string} [serverName] Host/Cluster Name for instance or AG - * @member {string} [parentName] Parent name of the DB such as Instance or - * Availability Group. - * @member {string} [parentType] Parent type of protected item, example: for a - * DB, standalone server or distributed - * @member {string} [protectionStatus] Backup status of this backup item. - * @member {string} [protectionState] Backup state of this backup item. - * Possible values include: 'Invalid', 'IRPending', 'Protected', - * 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' - * @member {string} [lastBackupStatus] Last backup operation status. Possible - * values: Healthy, Unhealthy. Possible values include: 'Invalid', 'Healthy', - * 'Unhealthy', 'IRPending' - * @member {date} [lastBackupTime] Timestamp of the last backup operation on - * this backup item. - * @member {object} [lastBackupErrorDetail] Error details in last backup - * @member {string} [lastBackupErrorDetail.code] Error code. - * @member {string} [lastBackupErrorDetail.message] Error Message related to - * the Code. - * @member {array} [lastBackupErrorDetail.recommendations] List of - * recommendation strings. - * @member {string} [protectedItemDataSourceId] Data ID of the protected item. - * @member {string} [protectedItemHealthStatus] Health status of the backup - * item, evaluated based on last heartbeat received. Possible values include: - * 'Invalid', 'Healthy', 'Unhealthy', 'NotReachable', 'IRPending' - * @member {object} [extendedInfo] Additional information for this backup item. - * @member {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy - * available for this backup item. - * @member {number} [extendedInfo.recoveryPointCount] Number of backup copies - * available for this backup item. - * @member {string} [extendedInfo.policyState] Indicates consistency of policy - * object and policy applied to this backup item. */ export interface AzureVmWorkloadProtectedItem extends ProtectedItem { + /** + * Friendly name of the DB represented by this backup item. + */ friendlyName?: string; + /** + * Host/Cluster Name for instance or AG + */ serverName?: string; + /** + * Parent name of the DB such as Instance or Availability Group. + */ parentName?: string; + /** + * Parent type of protected item, example: for a DB, standalone server or distributed + */ parentType?: string; + /** + * Backup status of this backup item. + */ protectionStatus?: string; + /** + * Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', + * 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' + */ protectionState?: string; + /** + * Last backup operation status. Possible values: Healthy, Unhealthy. Possible values include: + * 'Invalid', 'Healthy', 'Unhealthy', 'IRPending' + */ lastBackupStatus?: string; + /** + * Timestamp of the last backup operation on this backup item. + */ lastBackupTime?: Date; + /** + * Error details in last backup + */ lastBackupErrorDetail?: ErrorDetail; + /** + * Data ID of the protected item. + */ protectedItemDataSourceId?: string; + /** + * Health status of the backup item, evaluated based on last heartbeat received. Possible values + * include: 'Invalid', 'Healthy', 'Unhealthy', 'NotReachable', 'IRPending' + */ protectedItemHealthStatus?: string; + /** + * Additional information for this backup item. + */ extendedInfo?: AzureVmWorkloadProtectedItemExtendedInfo; } /** - * @class - * Initializes a new instance of the Settings class. - * @constructor * Common settings field for backup management - * - * @member {string} [timeZone] TimeZone optional input as string. For example: - * TimeZone = "Pacific Standard Time". - * @member {boolean} [issqlcompression] SQL compression flag - * @member {boolean} [isCompression] Workload compression flag. This has been - * added so that 'isSqlCompression' - * will be deprecated once clients upgrade to consider this flag. */ export interface Settings { + /** + * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time". + */ timeZone?: string; + /** + * SQL compression flag + */ issqlcompression?: boolean; + /** + * Workload compression flag. This has been added so that 'isSqlCompression' + * will be deprecated once clients upgrade to consider this flag. + */ isCompression?: boolean; } /** - * @class - * Initializes a new instance of the SubProtectionPolicy class. - * @constructor * Sub-protection policy which includes schedule and retention - * - * @member {string} [policyType] Type of backup policy type. Possible values - * include: 'Invalid', 'Full', 'Differential', 'Log', 'CopyOnlyFull' - * @member {object} [schedulePolicy] Backup schedule specified as part of - * backup policy. - * @member {string} [schedulePolicy.schedulePolicyType] Polymorphic - * Discriminator - * @member {object} [retentionPolicy] Retention policy with the details on - * backup copy retention ranges. - * @member {string} [retentionPolicy.retentionPolicyType] Polymorphic - * Discriminator */ export interface SubProtectionPolicy { + /** + * Type of backup policy type. Possible values include: 'Invalid', 'Full', 'Differential', 'Log', + * 'CopyOnlyFull' + */ policyType?: string; + /** + * Backup schedule specified as part of backup policy. + */ schedulePolicy?: SchedulePolicy; + /** + * Retention policy with the details on backup copy retention ranges. + */ retentionPolicy?: RetentionPolicy; } /** - * @class - * Initializes a new instance of the AzureVmWorkloadProtectionPolicy class. - * @constructor * Azure VM (Mercury) workload-specific backup policy. - * - * @member {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} [settings] Common settings for the backup management - * @member {string} [settings.timeZone] TimeZone optional input as string. For - * example: TimeZone = "Pacific Standard Time". - * @member {boolean} [settings.issqlcompression] SQL compression flag - * @member {boolean} [settings.isCompression] Workload compression flag. This - * has been added so that 'isSqlCompression' - * will be deprecated once clients upgrade to consider this flag. - * @member {array} [subProtectionPolicy] List of sub-protection policies which - * includes schedule and retention */ export interface AzureVmWorkloadProtectionPolicy extends ProtectionPolicy { + /** + * Type of workload for the backup management. Possible values include: 'Invalid', 'VM', + * 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', + * 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' + */ workLoadType?: string; + /** + * Common settings for the backup management + */ settings?: Settings; + /** + * List of sub-protection policies which includes schedule and retention + */ subProtectionPolicy?: SubProtectionPolicy[]; } /** - * @class - * Initializes a new instance of the AzureVmWorkloadSAPHanaDatabaseProtectedItem class. - * @constructor * Azure VM workload-specific protected item representing SAP Hana Database. - * */ export interface AzureVmWorkloadSAPHanaDatabaseProtectedItem extends AzureVmWorkloadProtectedItem { } /** - * @class - * Initializes a new instance of the AzureVmWorkloadSQLDatabaseProtectedItem class. - * @constructor * Azure VM workload-specific protected item representing SQL Database. - * - * @member {string} [friendlyName] Friendly name of the DB represented by this - * backup item. - * @member {string} [serverName] Host/Cluster Name for instance or AG - * @member {string} [parentName] Parent name of the DB such as Instance or - * Availability Group. - * @member {string} [parentType] Parent type of DB, SQLAG or StandAlone - * @member {string} [protectionStatus] Backup status of this backup item. - * @member {string} [protectionState] Backup state of this backup item. - * Possible values include: 'Invalid', 'IRPending', 'Protected', - * 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' - * @member {string} [lastBackupStatus] Last backup operation status. Possible - * values: Healthy, Unhealthy. Possible values include: 'Invalid', 'Healthy', - * 'Unhealthy', 'IRPending' - * @member {date} [lastBackupTime] Timestamp of the last backup operation on - * this backup item. - * @member {object} [lastBackupErrorDetail] Error details in last backup - * @member {string} [lastBackupErrorDetail.code] Error code. - * @member {string} [lastBackupErrorDetail.message] Error Message related to - * the Code. - * @member {array} [lastBackupErrorDetail.recommendations] List of - * recommendation strings. - * @member {string} [protectedItemDataSourceId] Data ID of the protected item. - * @member {string} [protectedItemHealthStatus] Health status of the backup - * item, evaluated based on last heartbeat received. Possible values include: - * 'Invalid', 'Healthy', 'Unhealthy', 'NotReachable', 'IRPending' - * @member {object} [extendedInfo] Additional information for this backup item. - * @member {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy - * available for this backup item. - * @member {number} [extendedInfo.recoveryPointCount] Number of backup copies - * available for this backup item. - * @member {string} [extendedInfo.policyState] Indicates consistency of policy - * object and policy applied to this backup item. */ export interface AzureVmWorkloadSQLDatabaseProtectedItem extends ProtectedItem { + /** + * Friendly name of the DB represented by this backup item. + */ friendlyName?: string; + /** + * Host/Cluster Name for instance or AG + */ serverName?: string; + /** + * Parent name of the DB such as Instance or Availability Group. + */ parentName?: string; + /** + * Parent type of DB, SQLAG or StandAlone + */ parentType?: string; + /** + * Backup status of this backup item. + */ protectionStatus?: string; + /** + * Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', + * 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' + */ protectionState?: string; + /** + * Last backup operation status. Possible values: Healthy, Unhealthy. Possible values include: + * 'Invalid', 'Healthy', 'Unhealthy', 'IRPending' + */ lastBackupStatus?: string; + /** + * Timestamp of the last backup operation on this backup item. + */ lastBackupTime?: Date; + /** + * Error details in last backup + */ lastBackupErrorDetail?: ErrorDetail; + /** + * Data ID of the protected item. + */ protectedItemDataSourceId?: string; + /** + * Health status of the backup item, evaluated based on last heartbeat received. Possible values + * include: 'Invalid', 'Healthy', 'Unhealthy', 'NotReachable', 'IRPending' + */ protectedItemHealthStatus?: string; + /** + * Additional information for this backup item. + */ extendedInfo?: AzureVmWorkloadProtectedItemExtendedInfo; } /** - * @class - * Initializes a new instance of the AzureWorkloadAutoProtectionIntent class. - * @constructor * Azure Recovery Services Vault specific protection intent item. - * */ export interface AzureWorkloadAutoProtectionIntent extends AzureRecoveryServiceVaultProtectionIntent { } /** - * @class - * Initializes a new instance of the AzureWorkloadErrorInfo class. - * @constructor * Azure storage specific error information - * - * @member {number} [errorCode] Error code. - * @member {string} [errorString] Localized error string. - * @member {string} [errorTitle] Title: Typically, the entity that the error - * pertains to. - * @member {array} [recommendations] List of localized recommendations for - * above error code. - * @member {string} [additionalDetails] Additional details for above error - * code. */ export interface AzureWorkloadErrorInfo { + /** + * Error code. + */ errorCode?: number; + /** + * Localized error string. + */ errorString?: string; + /** + * Title: Typically, the entity that the error pertains to. + */ errorTitle?: string; + /** + * List of localized recommendations for above error code. + */ recommendations?: string[]; + /** + * Additional details for above error code. + */ additionalDetails?: string; } /** - * @class - * Initializes a new instance of the AzureWorkloadJobTaskDetails class. - * @constructor * Azure VM workload specific job task details. - * - * @member {string} [taskId] The task display name. - * @member {string} [status] The status. */ export interface AzureWorkloadJobTaskDetails { + /** + * The task display name. + */ taskId?: string; + /** + * The status. + */ status?: string; } /** - * @class - * Initializes a new instance of the AzureWorkloadJobExtendedInfo class. - * @constructor * Azure VM workload-specific additional information for job. - * - * @member {array} [tasksList] List of tasks for this job - * @member {object} [propertyBag] Job properties. - * @member {string} [dynamicErrorMessage] Non localized error message on job - * execution. */ export interface AzureWorkloadJobExtendedInfo { + /** + * List of tasks for this job + */ tasksList?: AzureWorkloadJobTaskDetails[]; + /** + * Job properties. + */ propertyBag?: { [propertyName: string]: string }; + /** + * Non localized error message on job execution. + */ dynamicErrorMessage?: string; } /** - * @class - * Initializes a new instance of the AzureWorkloadJob class. - * @constructor * Azure storage specific job. - * - * @member {string} [workloadType] Workload type of the job - * @member {moment.duration} [duration] Time elapsed during the execution of - * 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 {object} [extendedInfo] Additional information about the job. - * @member {array} [extendedInfo.tasksList] List of tasks for this job - * @member {object} [extendedInfo.propertyBag] Job properties. - * @member {string} [extendedInfo.dynamicErrorMessage] Non localized error - * message on job execution. */ export interface AzureWorkloadJob extends Job { + /** + * Workload type of the job + */ workloadType?: string; + /** + * Time elapsed during the execution of this job. + */ duration?: moment.Duration; + /** + * Gets or sets the state/actions applicable on this job like cancel/retry. + */ actionsInfo?: string[]; + /** + * Error details on execution of this job. + */ errorDetails?: AzureWorkloadErrorInfo[]; + /** + * Additional information about the job. + */ extendedInfo?: AzureWorkloadJobExtendedInfo; } /** - * @class - * Initializes a new instance of the AzureWorkloadRestoreRequest class. - * @constructor * AzureWorkload-specific restore. - * - * @member {string} [recoveryType] OLR/ALR, RestoreDisks is invalid option. - * Possible values include: 'Invalid', 'OriginalLocation', 'AlternateLocation', - * 'RestoreDisks' - * @member {string} [sourceResourceId] Fully qualified ARM ID of the VM on - * which workload that was running is being recovered. - * @member {object} [propertyBag] Workload specific property bag. */ export interface AzureWorkloadRestoreRequest extends RestoreRequest { + /** + * OLR/ALR, RestoreDisks is invalid option. Possible values include: 'Invalid', + * 'OriginalLocation', 'AlternateLocation', 'RestoreDisks' + */ recoveryType?: string; + /** + * Fully qualified ARM ID of the VM on which workload that was running is being recovered. + */ sourceResourceId?: string; + /** + * Workload specific property bag. + */ propertyBag?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the AzureWorkloadSAPHanaRestoreRequest class. - * @constructor * AzureWorkload SAP Hana-specific restore. - * - * @member {object} [targetInfo] Details of target database - * @member {string} [targetInfo.overwriteOption] Can Overwrite if Target - * DataBase already exists. Possible values include: 'Invalid', - * 'FailOnConflict', 'Overwrite' - * @member {string} [targetInfo.containerId] Resource Id name of the container - * in which Target DataBase resides - * @member {string} [targetInfo.databaseName] Database name - * InstanceName/DataBaseName for SQL or System/DbName for SAP Hana - * @member {string} [recoveryType] OLR/ALR, RestoreDisks is invalid option. - * Possible values include: 'Invalid', 'OriginalLocation', 'AlternateLocation', - * 'RestoreDisks' - * @member {string} [sourceResourceId] Fully qualified ARM ID of the VM on - * which workload that was running is being recovered. - * @member {object} [propertyBag] Workload specific property bag. */ export interface AzureWorkloadSAPHanaRestoreRequest extends RestoreRequest { + /** + * Details of target database + */ targetInfo?: TargetRestoreInfo; + /** + * OLR/ALR, RestoreDisks is invalid option. Possible values include: 'Invalid', + * 'OriginalLocation', 'AlternateLocation', 'RestoreDisks' + */ recoveryType?: string; + /** + * Fully qualified ARM ID of the VM on which workload that was running is being recovered. + */ sourceResourceId?: string; + /** + * Workload specific property bag. + */ propertyBag?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the AzureWorkloadSAPHanaPointInTimeRestoreRequest class. - * @constructor - * AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log - * restore - * - * @member {date} [pointInTime] PointInTime value + * AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore */ export interface AzureWorkloadSAPHanaPointInTimeRestoreRequest extends AzureWorkloadSAPHanaRestoreRequest { + /** + * PointInTime value + */ pointInTime?: Date; } /** - * @class - * Initializes a new instance of the TargetRestoreInfo class. - * @constructor * Details about target workload during restore operation. - * - * @member {string} [overwriteOption] Can Overwrite if Target DataBase already - * exists. Possible values include: 'Invalid', 'FailOnConflict', 'Overwrite' - * @member {string} [containerId] Resource Id name of the container in which - * Target DataBase resides - * @member {string} [databaseName] Database name InstanceName/DataBaseName for - * SQL or System/DbName for SAP Hana */ export interface TargetRestoreInfo { + /** + * Can Overwrite if Target DataBase already exists. Possible values include: 'Invalid', + * 'FailOnConflict', 'Overwrite' + */ overwriteOption?: string; + /** + * Resource Id name of the container in which Target DataBase resides + */ containerId?: string; + /** + * Database name InstanceName/DataBaseName for SQL or System/DbName for SAP Hana + */ databaseName?: string; } /** - * @class - * Initializes a new instance of the AzureWorkloadSQLAutoProtectionIntent class. - * @constructor * Azure Workload SQL Auto Protection intent item. - * - * @member {string} [workloadItemType] Workload item type of the item for which - * intent is to be set. Possible values include: 'Invalid', 'SQLInstance', - * 'SQLDataBase', 'SAPHanaSystem', 'SAPHanaDatabase' */ export interface AzureWorkloadSQLAutoProtectionIntent extends AzureWorkloadAutoProtectionIntent { + /** + * Workload item type of the item for which intent is to be set. Possible values include: + * 'Invalid', 'SQLInstance', 'SQLDataBase', 'SAPHanaSystem', 'SAPHanaDatabase' + */ workloadItemType?: string; } /** - * @class - * Initializes a new instance of the AzureWorkloadSQLRestoreRequest class. - * @constructor * AzureWorkload SQL -specific restore. Specifically for full/diff restore - * - * @member {boolean} [shouldUseAlternateTargetLocation] Default option set to - * true. If this is set to false, alternate data directory must be provided - * @member {boolean} [isNonRecoverable] SQL specific property where user can - * chose to set no-recovery when restore operation is tried - * @member {object} [targetInfo] Details of target database - * @member {string} [targetInfo.overwriteOption] Can Overwrite if Target - * DataBase already exists. Possible values include: 'Invalid', - * 'FailOnConflict', 'Overwrite' - * @member {string} [targetInfo.containerId] Resource Id name of the container - * in which Target DataBase resides - * @member {string} [targetInfo.databaseName] Database name - * InstanceName/DataBaseName for SQL or System/DbName for SAP Hana - * @member {array} [alternateDirectoryPaths] Data directory details */ export interface AzureWorkloadSQLRestoreRequest extends AzureWorkloadRestoreRequest { + /** + * Default option set to true. If this is set to false, alternate data directory must be provided + */ shouldUseAlternateTargetLocation?: boolean; + /** + * SQL specific property where user can chose to set no-recovery when restore operation is tried + */ isNonRecoverable?: boolean; + /** + * Details of target database + */ targetInfo?: TargetRestoreInfo; + /** + * Data directory details + */ alternateDirectoryPaths?: SQLDataDirectoryMapping[]; } /** - * @class - * Initializes a new instance of the AzureWorkloadSQLPointInTimeRestoreRequest class. - * @constructor - * AzureWorkload SQL -specific restore. Specifically for PointInTime/Log - * restore - * - * @member {date} [pointInTime] PointInTime value + * AzureWorkload SQL -specific restore. Specifically for PointInTime/Log restore */ export interface AzureWorkloadSQLPointInTimeRestoreRequest extends AzureWorkloadSQLRestoreRequest { + /** + * PointInTime value + */ pointInTime?: Date; } /** - * @class - * Initializes a new instance of the SQLDataDirectoryMapping class. - * @constructor * Encapsulates information regarding data directory - * - * @member {string} [mappingType] Type of data directory mapping. Possible - * values include: 'Invalid', 'Data', 'Log' - * @member {string} [sourceLogicalName] Restore source logical name path - * @member {string} [sourcePath] Restore source path - * @member {string} [targetPath] Target path */ export interface SQLDataDirectoryMapping { + /** + * Type of data directory mapping. Possible values include: 'Invalid', 'Data', 'Log' + */ mappingType?: string; + /** + * Restore source logical name path + */ sourceLogicalName?: string; + /** + * Restore source path + */ sourcePath?: string; + /** + * Target path + */ targetPath?: string; } /** - * @class - * Initializes a new instance of the NameInfo class. - * @constructor * The name of usage. - * - * @member {string} [value] Value of usage. - * @member {string} [localizedValue] Localized value of usage. */ export interface NameInfo { + /** + * Value of usage. + */ value?: string; + /** + * Localized value of usage. + */ localizedValue?: string; } /** - * @class - * Initializes a new instance of the BackupManagementUsage class. - * @constructor * Backup management usages of a vault. - * - * @member {string} [unit] Unit of the usage. Possible values include: 'Count', - * 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond' - * @member {string} [quotaPeriod] Quota period of usage. - * @member {date} [nextResetTime] Next reset time of usage. - * @member {number} [currentValue] Current value of usage. - * @member {number} [limit] Limit of usage. - * @member {object} [name] Name of usage. - * @member {string} [name.value] Value of usage. - * @member {string} [name.localizedValue] Localized value of usage. */ export interface BackupManagementUsage { + /** + * Unit of the usage. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', + * 'CountPerSecond', 'BytesPerSecond' + */ unit?: string; + /** + * Quota period of usage. + */ quotaPeriod?: string; + /** + * Next reset time of usage. + */ nextResetTime?: Date; + /** + * Current value of usage. + */ currentValue?: number; + /** + * Limit of usage. + */ limit?: number; + /** + * Name of usage. + */ name?: NameInfo; } /** - * @class - * Initializes a new instance of the BackupStatusRequest class. - * @constructor * BackupStatus request. - * - * @member {string} [resourceType] Container Type - VM, SQLPaaS, DPM, - * AzureFileShare. Possible values include: 'Invalid', 'VM', 'FileFolder', - * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', - * 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', - * 'SAPHanaDatabase' - * @member {string} [resourceId] Entire ARM resource id of the resource - * @member {string} [poLogicalName] Protectable Item Logical Name */ export interface BackupStatusRequest { + /** + * Container Type - VM, SQLPaaS, DPM, AzureFileShare. Possible values include: 'Invalid', 'VM', + * 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', + * 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' + */ resourceType?: string; + /** + * Entire ARM resource id of the resource + */ resourceId?: string; + /** + * Protectable Item Logical Name + */ poLogicalName?: string; } /** - * @class - * Initializes a new instance of the BackupStatusResponse class. - * @constructor * BackupStatus response. - * - * @member {string} [protectionStatus] Specifies whether the container is - * registered or not. Possible values include: 'Invalid', 'NotProtected', - * 'Protecting', 'Protected', 'ProtectionFailed' - * @member {string} [fabricName] Specifies the fabric name - Azure or AD. - * Possible values include: 'Invalid', 'Azure' - * @member {string} [containerName] Specifies the product specific container - * name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname. - * @member {string} [protectedItemName] Specifies the product specific ds name. - * E.g. vm;iaasvmcontainer;csname;vmname. - * @member {string} [errorCode] ErrorCode in case of intent failed - * @member {string} [errorMessage] ErrorMessage in case of intent failed. - * @member {string} [policyName] Specifies the policy name which is used for - * protection - * @member {string} [registrationStatus] Container registration status */ export interface BackupStatusResponse { + /** + * Specifies whether the container is registered or not. Possible values include: 'Invalid', + * 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed' + */ protectionStatus?: string; + /** + * Specifies the fabric name - Azure or AD. Possible values include: 'Invalid', 'Azure' + */ fabricName?: string; + /** + * Specifies the product specific container name. E.g. + * iaasvmcontainer;iaasvmcontainer;csname;vmname. + */ containerName?: string; + /** + * Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname. + */ protectedItemName?: string; + /** + * ErrorCode in case of intent failed + */ errorCode?: string; + /** + * ErrorMessage in case of intent failed. + */ errorMessage?: string; + /** + * Specifies the policy name which is used for protection + */ policyName?: string; + /** + * Container registration status + */ registrationStatus?: string; } /** - * @class - * Initializes a new instance of the BMSBackupSummariesQueryObject class. - * @constructor * Query parameters to fetch backup summaries. - * - * @member {string} [type] Backup management type for this container. Possible - * values include: 'Invalid', 'BackupProtectedItemCountSummary', - * 'BackupProtectionContainerCountSummary' */ export interface BMSBackupSummariesQueryObject { + /** + * Backup management type for this container. Possible values include: 'Invalid', + * 'BackupProtectedItemCountSummary', 'BackupProtectionContainerCountSummary' + */ type?: string; } /** - * @class - * Initializes a new instance of the Day class. - * @constructor * Day of the week. - * - * @member {number} [date] Date of the month - * @member {boolean} [isLast] Whether Date is last date of month */ export interface Day { + /** + * Date of the month + */ date?: number; + /** + * Whether Date is last date of month + */ isLast?: boolean; } /** - * @class - * Initializes a new instance of the DailyRetentionFormat class. - * @constructor * Daily retention format. - * - * @member {array} [daysOfTheMonth] List of days of the month. */ export interface DailyRetentionFormat { + /** + * List of days of the month. + */ daysOfTheMonth?: Day[]; } /** - * @class - * Initializes a new instance of the RetentionDuration class. - * @constructor * Retention duration. - * - * @member {number} [count] Count of duration types. Retention duration is - * obtained by the counting the duration type Count times. - * For example, when Count = 3 and DurationType = Weeks, retention duration - * will be three weeks. - * @member {string} [durationType] Retention duration type of retention policy. - * Possible values include: 'Invalid', 'Days', 'Weeks', 'Months', 'Years' */ export interface RetentionDuration { + /** + * Count of duration types. Retention duration is obtained by the counting the duration type + * Count times. + * For example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks. + */ count?: number; + /** + * Retention duration type of retention policy. Possible values include: 'Invalid', 'Days', + * 'Weeks', 'Months', 'Years' + */ durationType?: string; } /** - * @class - * Initializes a new instance of the DailyRetentionSchedule class. - * @constructor * Daily retention schedule. - * - * @member {array} [retentionTimes] Retention times of retention policy. - * @member {object} [retentionDuration] Retention duration of retention Policy. - * @member {number} [retentionDuration.count] Count of duration types. - * Retention duration is obtained by the counting the duration type Count - * times. - * For example, when Count = 3 and DurationType = Weeks, retention duration - * will be three weeks. - * @member {string} [retentionDuration.durationType] Retention duration type of - * retention policy. Possible values include: 'Invalid', 'Days', 'Weeks', - * 'Months', 'Years' */ export interface DailyRetentionSchedule { + /** + * Retention times of retention policy. + */ retentionTimes?: Date[]; + /** + * Retention duration of retention Policy. + */ retentionDuration?: RetentionDuration; } /** - * @class - * Initializes a new instance of the DpmErrorInfo class. - * @constructor * DPM workload-specific error information. - * - * @member {string} [errorString] Localized error string. - * @member {array} [recommendations] List of localized recommendations for - * above error code. */ export interface DpmErrorInfo { + /** + * Localized error string. + */ errorString?: string; + /** + * List of localized recommendations for above error code. + */ recommendations?: string[]; } /** - * @class - * Initializes a new instance of the DpmJobTaskDetails class. - * @constructor * DPM workload-specific job task details. - * - * @member {string} [taskId] The task display name. - * @member {date} [startTime] The start time. - * @member {date} [endTime] The end time. - * @member {moment.duration} [duration] Time elapsed for task. - * @member {string} [status] The status. */ export interface DpmJobTaskDetails { + /** + * The task display name. + */ taskId?: string; + /** + * The start time. + */ startTime?: Date; + /** + * The end time. + */ endTime?: Date; + /** + * Time elapsed for task. + */ duration?: moment.Duration; + /** + * The status. + */ status?: string; } /** - * @class - * Initializes a new instance of the DpmJobExtendedInfo class. - * @constructor * Additional information on the DPM workload-specific job. - * - * @member {array} [tasksList] List of tasks associated with this job. - * @member {object} [propertyBag] The job properties. - * @member {string} [dynamicErrorMessage] Non localized error message on job - * execution. */ export interface DpmJobExtendedInfo { + /** + * List of tasks associated with this job. + */ tasksList?: DpmJobTaskDetails[]; + /** + * The job properties. + */ propertyBag?: { [propertyName: string]: string }; + /** + * Non localized error message on job execution. + */ dynamicErrorMessage?: string; } /** - * @class - * Initializes a new instance of the DpmJob class. - * @constructor - * DPM workload-specifc job object. - * - * @member {moment.duration} [duration] Time elapsed for job. - * @member {string} [dpmServerName] DPM server name managing the backup item or - * backup job. - * @member {string} [containerName] Name of cluster/server protecting current - * backup item, if any. - * @member {string} [containerType] Type of container. - * @member {string} [workloadType] Type of backup item. - * @member {array} [actionsInfo] The state/actions applicable on this job like - * cancel/retry. - * @member {array} [errorDetails] The errors. - * @member {object} [extendedInfo] Additional information for this job. - * @member {array} [extendedInfo.tasksList] List of tasks associated with this - * job. - * @member {object} [extendedInfo.propertyBag] The job properties. - * @member {string} [extendedInfo.dynamicErrorMessage] Non localized error - * message on job execution. + * DPM workload-specific job object. */ export interface DpmJob extends Job { + /** + * Time elapsed for job. + */ duration?: moment.Duration; + /** + * DPM server name managing the backup item or backup job. + */ dpmServerName?: string; + /** + * Name of cluster/server protecting current backup item, if any. + */ containerName?: string; + /** + * Type of container. + */ containerType?: string; + /** + * Type of backup item. + */ workloadType?: string; + /** + * The state/actions applicable on this job like cancel/retry. + */ actionsInfo?: string[]; + /** + * The errors. + */ errorDetails?: DpmErrorInfo[]; + /** + * Additional information for this job. + */ extendedInfo?: DpmJobExtendedInfo; } /** - * @class - * Initializes a new instance of the DPMProtectedItemExtendedInfo class. - * @constructor * Additional information of DPM Protected item. - * - * @member {object} [protectableObjectLoadPath] Attribute to provide - * information on various DBs. - * @member {boolean} [protectedProperty] To check if backup item is disk - * protected. - * @member {boolean} [isPresentOnCloud] To check if backup item is cloud - * protected. - * @member {string} [lastBackupStatus] Last backup status information on backup - * item. - * @member {date} [lastRefreshedAt] Last refresh time on backup item. - * @member {date} [oldestRecoveryPoint] Oldest cloud recovery point time. - * @member {number} [recoveryPointCount] cloud recovery point count. - * @member {date} [onPremiseOldestRecoveryPoint] Oldest disk recovery point - * time. - * @member {date} [onPremiseLatestRecoveryPoint] latest disk recovery point - * time. - * @member {number} [onPremiseRecoveryPointCount] disk recovery point count. - * @member {boolean} [isCollocated] To check if backup item is collocated. - * @member {string} [protectionGroupName] Protection group name of the backup - * item. - * @member {string} [diskStorageUsedInBytes] Used Disk storage in bytes. - * @member {string} [totalDiskStorageSizeInBytes] total Disk storage in bytes. */ export interface DPMProtectedItemExtendedInfo { + /** + * Attribute to provide information on various DBs. + */ protectableObjectLoadPath?: { [propertyName: string]: string }; + /** + * To check if backup item is disk protected. + */ protectedProperty?: boolean; + /** + * To check if backup item is cloud protected. + */ isPresentOnCloud?: boolean; + /** + * Last backup status information on backup item. + */ lastBackupStatus?: string; + /** + * Last refresh time on backup item. + */ lastRefreshedAt?: Date; + /** + * Oldest cloud recovery point time. + */ oldestRecoveryPoint?: Date; + /** + * cloud recovery point count. + */ recoveryPointCount?: number; + /** + * Oldest disk recovery point time. + */ onPremiseOldestRecoveryPoint?: Date; + /** + * latest disk recovery point time. + */ onPremiseLatestRecoveryPoint?: Date; + /** + * disk recovery point count. + */ onPremiseRecoveryPointCount?: number; + /** + * To check if backup item is collocated. + */ isCollocated?: boolean; + /** + * Protection group name of the backup item. + */ protectionGroupName?: string; + /** + * Used Disk storage in bytes. + */ diskStorageUsedInBytes?: string; + /** + * total Disk storage in bytes. + */ totalDiskStorageSizeInBytes?: string; } /** - * @class - * Initializes a new instance of the DPMProtectedItem class. - * @constructor * Additional information on Backup engine specific backup item. - * - * @member {string} [friendlyName] Friendly name of the managed item - * @member {string} [backupEngineName] Backup Management server protecting this - * backup item - * @member {string} [protectionState] Protection state of the backupengine. - * Possible values include: 'Invalid', 'IRPending', 'Protected', - * 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' - * @member {boolean} [isScheduledForDeferredDelete] To check if backup item is - * scheduled for deferred delete - * @member {object} [extendedInfo] Extended info of the backup item. - * @member {object} [extendedInfo.protectableObjectLoadPath] Attribute to - * provide information on various DBs. - * @member {boolean} [extendedInfo.protectedProperty] To check if backup item - * is disk protected. - * @member {boolean} [extendedInfo.isPresentOnCloud] To check if backup item is - * cloud protected. - * @member {string} [extendedInfo.lastBackupStatus] Last backup status - * information on backup item. - * @member {date} [extendedInfo.lastRefreshedAt] Last refresh time on backup - * item. - * @member {date} [extendedInfo.oldestRecoveryPoint] Oldest cloud recovery - * point time. - * @member {number} [extendedInfo.recoveryPointCount] cloud recovery point - * count. - * @member {date} [extendedInfo.onPremiseOldestRecoveryPoint] Oldest disk - * recovery point time. - * @member {date} [extendedInfo.onPremiseLatestRecoveryPoint] latest disk - * recovery point time. - * @member {number} [extendedInfo.onPremiseRecoveryPointCount] disk recovery - * point count. - * @member {boolean} [extendedInfo.isCollocated] To check if backup item is - * collocated. - * @member {string} [extendedInfo.protectionGroupName] Protection group name of - * the backup item. - * @member {string} [extendedInfo.diskStorageUsedInBytes] Used Disk storage in - * bytes. - * @member {string} [extendedInfo.totalDiskStorageSizeInBytes] total Disk - * storage in bytes. */ export interface DPMProtectedItem extends ProtectedItem { + /** + * Friendly name of the managed item + */ friendlyName?: string; + /** + * Backup Management server protecting this backup item + */ backupEngineName?: string; + /** + * Protection state of the backup engine. Possible values include: 'Invalid', 'IRPending', + * 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' + */ protectionState?: string; + /** + * To check if backup item is scheduled for deferred delete + */ isScheduledForDeferredDelete?: boolean; + /** + * Extended info of the backup item. + */ extendedInfo?: DPMProtectedItemExtendedInfo; } /** - * @class - * Initializes a new instance of the EncryptionDetails class. - * @constructor * Details needed if the VM was encrypted at the time of backup. - * - * @member {boolean} [encryptionEnabled] Identifies whether this backup copy - * represents an encrypted VM at the time of backup. - * @member {string} [kekUrl] Key Url. - * @member {string} [secretKeyUrl] Secret Url. - * @member {string} [kekVaultId] ID of Key Vault where KEK is stored. - * @member {string} [secretKeyVaultId] ID of Key Vault where Secret is stored. */ export interface EncryptionDetails { + /** + * Identifies whether this backup copy represents an encrypted VM at the time of backup. + */ encryptionEnabled?: boolean; + /** + * Key Url. + */ kekUrl?: string; + /** + * Secret Url. + */ secretKeyUrl?: string; + /** + * ID of Key Vault where KEK is stored. + */ kekVaultId?: string; + /** + * ID of Key Vault where Secret is stored. + */ secretKeyVaultId?: string; } /** - * @class - * Initializes a new instance of the OperationResultInfoBase class. - * @constructor * Base class for operation result info. - * - * @member {string} objectType Polymorphic Discriminator */ export interface OperationResultInfoBase { + /** + * Polymorphic Discriminator + */ objectType: string; } /** - * @class - * Initializes a new instance of the ExportJobsOperationResultInfo class. - * @constructor * This class is used to send blob details after exporting jobs. - * - * @member {string} [blobUrl] URL of the blob into which the serialized string - * of list of jobs is exported. - * @member {string} [blobSasKey] SAS key to access the blob. It expires in 15 - * mins. */ export interface ExportJobsOperationResultInfo extends OperationResultInfoBase { + /** + * URL of the blob into which the serialized string of list of jobs is exported. + */ blobUrl?: string; + /** + * SAS key to access the blob. It expires in 15 mins. + */ blobSasKey?: string; } /** - * @class - * Initializes a new instance of the GenericProtectedItem class. - * @constructor * Base class for backup items. - * - * @member {string} [friendlyName] Friendly name of the container. - * @member {string} [policyState] Indicates consistency of policy object and - * policy applied to this backup item. - * @member {string} [protectionState] Backup state of this backup item. - * Possible values include: 'Invalid', 'IRPending', 'Protected', - * 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' - * @member {number} [protectedItemId] Data Plane Service ID of the protected - * item. - * @member {object} [sourceAssociations] Loosely coupled (type, value) - * associations (example - parent of a protected item) - * @member {string} [fabricName] Name of this backup item's fabric. */ export interface GenericProtectedItem extends ProtectedItem { + /** + * Friendly name of the container. + */ friendlyName?: string; + /** + * Indicates consistency of policy object and policy applied to this backup item. + */ policyState?: string; + /** + * Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', + * 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused' + */ protectionState?: string; + /** + * Data Plane Service ID of the protected item. + */ protectedItemId?: number; + /** + * Loosely coupled (type, value) associations (example - parent of a protected item) + */ sourceAssociations?: { [propertyName: string]: string }; + /** + * Name of this backup item's fabric. + */ fabricName?: string; } /** - * @class - * Initializes a new instance of the GenericProtectionPolicy class. - * @constructor * Azure VM (Mercury) workload-specific backup policy. - * - * @member {array} [subProtectionPolicy] List of sub-protection policies which - * includes schedule and retention - * @member {string} [timeZone] TimeZone optional input as string. For example: - * TimeZone = "Pacific Standard Time". - * @member {string} [fabricName] Name of this policy's fabric. */ export interface GenericProtectionPolicy extends ProtectionPolicy { + /** + * List of sub-protection policies which includes schedule and retention + */ subProtectionPolicy?: SubProtectionPolicy[]; + /** + * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time". + */ timeZone?: string; + /** + * Name of this policy's fabric. + */ fabricName?: string; } /** - * @class - * Initializes a new instance of the IaasVMRestoreRequest class. - * @constructor * IaaS VM workload-specific restore. - * - * @member {string} [recoveryPointId] ID of the backup copy to be recovered. - * @member {string} [recoveryType] Type of this recovery. Possible values - * include: 'Invalid', 'OriginalLocation', 'AlternateLocation', 'RestoreDisks' - * @member {string} [sourceResourceId] Fully qualified ARM ID of the VM which - * is being recovered. - * @member {string} [targetVirtualMachineId] This is the complete ARM Id of the - * VM that will be created. - * For e.g. - * /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm} - * @member {string} [targetResourceGroupId] This is the ARM Id of the resource - * group that you want to create for this Virtual machine and other artifacts. - * For e.g. /subscriptions/{subId}/resourcegroups/{rg} - * @member {string} [storageAccountId] Fully qualified ARM ID of the storage - * account to which the VM has to be restored. - * @member {string} [virtualNetworkId] This is the virtual network Id of the - * vnet that will be attached to the virtual machine. - * User will be validated for join action permissions in the linked access. - * @member {string} [subnetId] Subnet ID, is the subnet ID associated with the - * to be restored VM. For Classic VMs it would be - * {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it - * would be ARM resource ID used to represent - * the subnet. - * @member {string} [targetDomainNameId] Fully qualified ARM ID of the domain - * name to be associated to the VM being restored. This applies only to Classic - * Virtual Machines. - * @member {string} [region] Region in which the virtual machine is restored. - * @member {string} [affinityGroup] Affinity group associated to VM to be - * restored. Used only for Classic Compute Virtual Machines. - * @member {boolean} [createNewCloudService] Should a new cloud service be - * created while restoring the VM. If this is false, VM will be restored to the - * same - * cloud service as it was at the time of backup. - * @member {boolean} [originalStorageAccountOption] Original Storage Account - * Option - * @member {object} [encryptionDetails] Details needed if the VM was encrypted - * at the time of backup. - * @member {boolean} [encryptionDetails.encryptionEnabled] Identifies whether - * this backup copy represents an encrypted VM at the time of backup. - * @member {string} [encryptionDetails.kekUrl] Key Url. - * @member {string} [encryptionDetails.secretKeyUrl] Secret Url. - * @member {string} [encryptionDetails.kekVaultId] ID of Key Vault where KEK is - * stored. - * @member {string} [encryptionDetails.secretKeyVaultId] ID of Key Vault where - * Secret is stored. */ export interface IaasVMRestoreRequest extends RestoreRequest { + /** + * ID of the backup copy to be recovered. + */ recoveryPointId?: string; + /** + * Type of this recovery. Possible values include: 'Invalid', 'OriginalLocation', + * 'AlternateLocation', 'RestoreDisks' + */ recoveryType?: string; + /** + * Fully qualified ARM ID of the VM which is being recovered. + */ sourceResourceId?: string; + /** + * This is the complete ARM Id of the VM that will be created. + * For e.g. + * /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm} + */ targetVirtualMachineId?: string; + /** + * This is the ARM Id of the resource group that you want to create for this Virtual machine and + * other artifacts. + * For e.g. /subscriptions/{subId}/resourcegroups/{rg} + */ targetResourceGroupId?: string; + /** + * Fully qualified ARM ID of the storage account to which the VM has to be restored. + */ storageAccountId?: string; + /** + * This is the virtual network Id of the vnet that will be attached to the virtual machine. + * User will be validated for join action permissions in the linked access. + */ virtualNetworkId?: string; + /** + * Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be + * {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource + * ID used to represent + * the subnet. + */ subnetId?: string; + /** + * Fully qualified ARM ID of the domain name to be associated to the VM being restored. This + * applies only to Classic + * Virtual Machines. + */ targetDomainNameId?: string; + /** + * Region in which the virtual machine is restored. + */ region?: string; + /** + * Affinity group associated to VM to be restored. Used only for Classic Compute Virtual + * Machines. + */ affinityGroup?: string; + /** + * Should a new cloud service be created while restoring the VM. If this is false, VM will be + * restored to the same + * cloud service as it was at the time of backup. + */ createNewCloudService?: boolean; + /** + * Original Storage Account Option + */ originalStorageAccountOption?: boolean; + /** + * Details needed if the VM was encrypted at the time of backup. + */ encryptionDetails?: EncryptionDetails; } /** - * @class - * Initializes a new instance of the JobQueryObject class. - * @constructor * Filters to list the jobs. - * - * @member {string} [status] Status of the job. Possible values include: - * 'Invalid', 'InProgress', 'Completed', 'Failed', 'CompletedWithWarnings', - * 'Cancelled', 'Cancelling' - * @member {string} [backupManagementType] Type of backup managmenent for the - * job. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', - * 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [operation] Type of operation. Possible values include: - * 'Invalid', 'Register', 'UnRegister', 'ConfigureBackup', 'Backup', 'Restore', - * 'DisableBackup', 'DeleteBackupData' - * @member {string} [jobId] JobID represents the job uniquely. - * @member {date} [startTime] Job has started at this time. Value is in UTC. - * @member {date} [endTime] Job has ended at this time. Value is in UTC. */ export interface JobQueryObject { + /** + * Status of the job. Possible values include: 'Invalid', 'InProgress', 'Completed', 'Failed', + * 'CompletedWithWarnings', 'Cancelled', 'Cancelling' + */ status?: string; + /** + * Type of backup management for the job. Possible values include: 'Invalid', 'AzureIaasVM', + * 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; + /** + * Type of operation. Possible values include: 'Invalid', 'Register', 'UnRegister', + * 'ConfigureBackup', 'Backup', 'Restore', 'DisableBackup', 'DeleteBackupData' + */ operation?: string; + /** + * JobID represents the job uniquely. + */ jobId?: string; + /** + * Job has started at this time. Value is in UTC. + */ startTime?: Date; + /** + * Job has ended at this time. Value is in UTC. + */ endTime?: Date; } /** - * @class - * Initializes a new instance of the Resource class. - * @constructor * ARM Resource. - * - * @member {string} [id] Resource Id represents the complete path to the - * resource. - * @member {string} [name] Resource name associated with the resource. - * @member {string} [type] Resource type represents the complete path of the - * form Namespace/ResourceType/ResourceType/... - * @member {string} [location] Resource location. - * @member {object} [tags] Resource tags. - * @member {string} [eTag] Optional ETag. */ export interface Resource extends BaseResource { + /** + * Resource Id represents the complete path to the resource. + */ readonly id?: string; + /** + * Resource name associated with the resource. + */ readonly name?: string; + /** + * Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... + */ readonly type?: string; + /** + * Resource location. + */ location?: string; + /** + * Resource tags. + */ tags?: { [propertyName: string]: string }; + /** + * Optional ETag. + */ eTag?: string; } /** - * @class - * Initializes a new instance of the JobResource class. - * @constructor * Defines workload agnostic properties for a job. - * - * @member {object} [properties] JobResource properties - * @member {string} [properties.entityFriendlyName] Friendly name of the entity - * on which the current job is executing. - * @member {string} [properties.backupManagementType] Backup management type to - * execute the current job. Possible values include: 'Invalid', 'AzureIaasVM', - * 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', - * 'AzureWorkload', 'DefaultBackup' - * @member {string} [properties.operation] The operation name. - * @member {string} [properties.status] Job status. - * @member {date} [properties.startTime] The start time. - * @member {date} [properties.endTime] The end time. - * @member {string} [properties.activityId] ActivityId of job. - * @member {string} [properties.jobType] Polymorphic Discriminator */ export interface JobResource extends Resource { + /** + * JobResource properties + */ properties?: Job; } /** - * @class - * Initializes a new instance of the LogSchedulePolicy class. - * @constructor * Log policy schedule. - * - * @member {number} [scheduleFrequencyInMins] Frequency of the log schedule - * operation of this policy in minutes. */ export interface LogSchedulePolicy extends SchedulePolicy { + /** + * Frequency of the log schedule operation of this policy in minutes. + */ scheduleFrequencyInMins?: number; } /** - * @class - * Initializes a new instance of the WeeklyRetentionSchedule class. - * @constructor * Weekly retention schedule. - * - * @member {array} [daysOfTheWeek] List of days of week for weekly retention - * policy. - * @member {array} [retentionTimes] Retention times of retention policy. - * @member {object} [retentionDuration] Retention duration of retention Policy. - * @member {number} [retentionDuration.count] Count of duration types. - * Retention duration is obtained by the counting the duration type Count - * times. - * For example, when Count = 3 and DurationType = Weeks, retention duration - * will be three weeks. - * @member {string} [retentionDuration.durationType] Retention duration type of - * retention policy. Possible values include: 'Invalid', 'Days', 'Weeks', - * 'Months', 'Years' */ export interface WeeklyRetentionSchedule { + /** + * List of days of week for weekly retention policy. + */ daysOfTheWeek?: string[]; + /** + * Retention times of retention policy. + */ retentionTimes?: Date[]; + /** + * Retention duration of retention Policy. + */ retentionDuration?: RetentionDuration; } /** - * @class - * Initializes a new instance of the WeeklyRetentionFormat class. - * @constructor * Weekly retention format. - * - * @member {array} [daysOfTheWeek] List of days of the week. - * @member {array} [weeksOfTheMonth] List of weeks of month. */ export interface WeeklyRetentionFormat { + /** + * List of days of the week. + */ daysOfTheWeek?: string[]; + /** + * List of weeks of month. + */ weeksOfTheMonth?: string[]; } /** - * @class - * Initializes a new instance of the MonthlyRetentionSchedule class. - * @constructor * Monthly retention schedule. - * - * @member {string} [retentionScheduleFormatType] Retention schedule format - * type for monthly retention policy. Possible values include: 'Invalid', - * 'Daily', 'Weekly' - * @member {object} [retentionScheduleDaily] Daily retention format for monthly - * retention policy. - * @member {array} [retentionScheduleDaily.daysOfTheMonth] List of days of the - * month. - * @member {object} [retentionScheduleWeekly] Weekly retention format for - * monthly retention policy. - * @member {array} [retentionScheduleWeekly.daysOfTheWeek] List of days of the - * week. - * @member {array} [retentionScheduleWeekly.weeksOfTheMonth] List of weeks of - * month. - * @member {array} [retentionTimes] Retention times of retention policy. - * @member {object} [retentionDuration] Retention duration of retention Policy. - * @member {number} [retentionDuration.count] Count of duration types. - * Retention duration is obtained by the counting the duration type Count - * times. - * For example, when Count = 3 and DurationType = Weeks, retention duration - * will be three weeks. - * @member {string} [retentionDuration.durationType] Retention duration type of - * retention policy. Possible values include: 'Invalid', 'Days', 'Weeks', - * 'Months', 'Years' */ export interface MonthlyRetentionSchedule { + /** + * Retention schedule format type for monthly retention policy. Possible values include: + * 'Invalid', 'Daily', 'Weekly' + */ retentionScheduleFormatType?: string; + /** + * Daily retention format for monthly retention policy. + */ retentionScheduleDaily?: DailyRetentionFormat; + /** + * Weekly retention format for monthly retention policy. + */ retentionScheduleWeekly?: WeeklyRetentionFormat; + /** + * Retention times of retention policy. + */ retentionTimes?: Date[]; + /** + * Retention duration of retention Policy. + */ retentionDuration?: RetentionDuration; } /** - * @class - * Initializes a new instance of the YearlyRetentionSchedule class. - * @constructor * Yearly retention schedule. - * - * @member {string} [retentionScheduleFormatType] Retention schedule format for - * yearly retention policy. Possible values include: 'Invalid', 'Daily', - * 'Weekly' - * @member {array} [monthsOfYear] List of months of year of yearly retention - * policy. - * @member {object} [retentionScheduleDaily] Daily retention format for yearly - * retention policy. - * @member {array} [retentionScheduleDaily.daysOfTheMonth] List of days of the - * month. - * @member {object} [retentionScheduleWeekly] Weekly retention format for - * yearly retention policy. - * @member {array} [retentionScheduleWeekly.daysOfTheWeek] List of days of the - * week. - * @member {array} [retentionScheduleWeekly.weeksOfTheMonth] List of weeks of - * month. - * @member {array} [retentionTimes] Retention times of retention policy. - * @member {object} [retentionDuration] Retention duration of retention Policy. - * @member {number} [retentionDuration.count] Count of duration types. - * Retention duration is obtained by the counting the duration type Count - * times. - * For example, when Count = 3 and DurationType = Weeks, retention duration - * will be three weeks. - * @member {string} [retentionDuration.durationType] Retention duration type of - * retention policy. Possible values include: 'Invalid', 'Days', 'Weeks', - * 'Months', 'Years' */ export interface YearlyRetentionSchedule { + /** + * Retention schedule format for yearly retention policy. Possible values include: 'Invalid', + * 'Daily', 'Weekly' + */ retentionScheduleFormatType?: string; + /** + * List of months of year of yearly retention policy. + */ monthsOfYear?: string[]; + /** + * Daily retention format for yearly retention policy. + */ retentionScheduleDaily?: DailyRetentionFormat; + /** + * Weekly retention format for yearly retention policy. + */ retentionScheduleWeekly?: WeeklyRetentionFormat; + /** + * Retention times of retention policy. + */ retentionTimes?: Date[]; + /** + * Retention duration of retention Policy. + */ retentionDuration?: RetentionDuration; } /** - * @class - * Initializes a new instance of the LongTermRetentionPolicy class. - * @constructor * Long term retention policy. - * - * @member {object} [dailySchedule] Daily retention schedule of the protection - * policy. - * @member {array} [dailySchedule.retentionTimes] Retention times of retention - * policy. - * @member {object} [dailySchedule.retentionDuration] Retention duration of - * retention Policy. - * @member {number} [dailySchedule.retentionDuration.count] Count of duration - * types. Retention duration is obtained by the counting the duration type - * Count times. - * For example, when Count = 3 and DurationType = Weeks, retention duration - * will be three weeks. - * @member {string} [dailySchedule.retentionDuration.durationType] Retention - * duration type of retention policy. Possible values include: 'Invalid', - * 'Days', 'Weeks', 'Months', 'Years' - * @member {object} [weeklySchedule] Weekly retention schedule of the - * protection policy. - * @member {array} [weeklySchedule.daysOfTheWeek] List of days of week for - * weekly retention policy. - * @member {array} [weeklySchedule.retentionTimes] Retention times of retention - * policy. - * @member {object} [weeklySchedule.retentionDuration] Retention duration of - * retention Policy. - * @member {number} [weeklySchedule.retentionDuration.count] Count of duration - * types. Retention duration is obtained by the counting the duration type - * Count times. - * For example, when Count = 3 and DurationType = Weeks, retention duration - * will be three weeks. - * @member {string} [weeklySchedule.retentionDuration.durationType] Retention - * duration type of retention policy. Possible values include: 'Invalid', - * 'Days', 'Weeks', 'Months', 'Years' - * @member {object} [monthlySchedule] Monthly retention schedule of the - * protection policy. - * @member {string} [monthlySchedule.retentionScheduleFormatType] Retention - * schedule format type for monthly retention policy. Possible values include: - * 'Invalid', 'Daily', 'Weekly' - * @member {object} [monthlySchedule.retentionScheduleDaily] Daily retention - * format for monthly retention policy. - * @member {array} [monthlySchedule.retentionScheduleDaily.daysOfTheMonth] List - * of days of the month. - * @member {object} [monthlySchedule.retentionScheduleWeekly] Weekly retention - * format for monthly retention policy. - * @member {array} [monthlySchedule.retentionScheduleWeekly.daysOfTheWeek] List - * of days of the week. - * @member {array} [monthlySchedule.retentionScheduleWeekly.weeksOfTheMonth] - * List of weeks of month. - * @member {array} [monthlySchedule.retentionTimes] Retention times of - * retention policy. - * @member {object} [monthlySchedule.retentionDuration] Retention duration of - * retention Policy. - * @member {number} [monthlySchedule.retentionDuration.count] Count of duration - * types. Retention duration is obtained by the counting the duration type - * Count times. - * For example, when Count = 3 and DurationType = Weeks, retention duration - * will be three weeks. - * @member {string} [monthlySchedule.retentionDuration.durationType] Retention - * duration type of retention policy. Possible values include: 'Invalid', - * 'Days', 'Weeks', 'Months', 'Years' - * @member {object} [yearlySchedule] Yearly retention schedule of the - * protection policy. - * @member {string} [yearlySchedule.retentionScheduleFormatType] Retention - * schedule format for yearly retention policy. Possible values include: - * 'Invalid', 'Daily', 'Weekly' - * @member {array} [yearlySchedule.monthsOfYear] List of months of year of - * yearly retention policy. - * @member {object} [yearlySchedule.retentionScheduleDaily] Daily retention - * format for yearly retention policy. - * @member {array} [yearlySchedule.retentionScheduleDaily.daysOfTheMonth] List - * of days of the month. - * @member {object} [yearlySchedule.retentionScheduleWeekly] Weekly retention - * format for yearly retention policy. - * @member {array} [yearlySchedule.retentionScheduleWeekly.daysOfTheWeek] List - * of days of the week. - * @member {array} [yearlySchedule.retentionScheduleWeekly.weeksOfTheMonth] - * List of weeks of month. - * @member {array} [yearlySchedule.retentionTimes] Retention times of retention - * policy. - * @member {object} [yearlySchedule.retentionDuration] Retention duration of - * retention Policy. - * @member {number} [yearlySchedule.retentionDuration.count] Count of duration - * types. Retention duration is obtained by the counting the duration type - * Count times. - * For example, when Count = 3 and DurationType = Weeks, retention duration - * will be three weeks. - * @member {string} [yearlySchedule.retentionDuration.durationType] Retention - * duration type of retention policy. Possible values include: 'Invalid', - * 'Days', 'Weeks', 'Months', 'Years' */ export interface LongTermRetentionPolicy extends RetentionPolicy { + /** + * Daily retention schedule of the protection policy. + */ dailySchedule?: DailyRetentionSchedule; + /** + * Weekly retention schedule of the protection policy. + */ weeklySchedule?: WeeklyRetentionSchedule; + /** + * Monthly retention schedule of the protection policy. + */ monthlySchedule?: MonthlyRetentionSchedule; + /** + * Yearly retention schedule of the protection policy. + */ yearlySchedule?: YearlyRetentionSchedule; } /** - * @class - * Initializes a new instance of the LongTermSchedulePolicy class. - * @constructor * Long term policy schedule. - * */ export interface LongTermSchedulePolicy extends SchedulePolicy { } /** - * @class - * Initializes a new instance of the MabErrorInfo class. - * @constructor * MAB workload-specific error information. - * - * @member {string} [errorString] Localized error string. - * @member {array} [recommendations] List of localized recommendations. */ export interface MabErrorInfo { + /** + * Localized error string. + */ errorString?: string; + /** + * List of localized recommendations. + */ recommendations?: string[]; } /** - * @class - * Initializes a new instance of the MabFileFolderProtectedItemExtendedInfo class. - * @constructor * Additional information on the backed up item. - * - * @member {date} [lastRefreshedAt] Last time when the agent data synced to - * service. - * @member {date} [oldestRecoveryPoint] The oldest backup copy available. - * @member {number} [recoveryPointCount] Number of backup copies associated - * with the backup item. */ export interface MabFileFolderProtectedItemExtendedInfo { + /** + * Last time when the agent data synced to service. + */ lastRefreshedAt?: Date; + /** + * The oldest backup copy available. + */ oldestRecoveryPoint?: Date; + /** + * Number of backup copies associated with the backup item. + */ recoveryPointCount?: number; } /** - * @class - * Initializes a new instance of the MabFileFolderProtectedItem class. - * @constructor * MAB workload-specific backup item. - * - * @member {string} [friendlyName] Friendly name of this backup item. - * @member {string} [computerName] Name of the computer associated with this - * backup item. - * @member {string} [lastBackupStatus] Status of last backup operation. - * @member {string} [protectionState] Protected, ProtectionStopped, IRPending - * or ProtectionError - * @member {boolean} [isScheduledForDeferredDelete] Specifies if the item is - * scheduled for deferred deletion. - * @member {number} [deferredDeleteSyncTimeInUTC] Sync time for deferred - * deletion. - * @member {object} [extendedInfo] Additional information with this backup - * item. - * @member {date} [extendedInfo.lastRefreshedAt] Last time when the agent data - * synced to service. - * @member {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy - * available. - * @member {number} [extendedInfo.recoveryPointCount] Number of backup copies - * associated with the backup item. */ export interface MabFileFolderProtectedItem extends ProtectedItem { + /** + * Friendly name of this backup item. + */ friendlyName?: string; + /** + * Name of the computer associated with this backup item. + */ computerName?: string; + /** + * Status of last backup operation. + */ lastBackupStatus?: string; + /** + * Protected, ProtectionStopped, IRPending or ProtectionError + */ protectionState?: string; + /** + * Specifies if the item is scheduled for deferred deletion. + */ isScheduledForDeferredDelete?: boolean; + /** + * Sync time for deferred deletion. + */ deferredDeleteSyncTimeInUTC?: number; + /** + * Additional information with this backup item. + */ extendedInfo?: MabFileFolderProtectedItemExtendedInfo; } /** - * @class - * Initializes a new instance of the MabJobTaskDetails class. - * @constructor * MAB workload-specific job task details. - * - * @member {string} [taskId] The task display name. - * @member {date} [startTime] The start time. - * @member {date} [endTime] The end time. - * @member {moment.duration} [duration] Time elapsed for task. - * @member {string} [status] The status. */ export interface MabJobTaskDetails { + /** + * The task display name. + */ taskId?: string; + /** + * The start time. + */ startTime?: Date; + /** + * The end time. + */ endTime?: Date; + /** + * Time elapsed for task. + */ duration?: moment.Duration; + /** + * The status. + */ status?: string; } /** - * @class - * Initializes a new instance of the MabJobExtendedInfo class. - * @constructor * Additional information for the MAB workload-specific job. - * - * @member {array} [tasksList] List of tasks for this job. - * @member {object} [propertyBag] The job properties. - * @member {string} [dynamicErrorMessage] Non localized error message specific - * to this job. */ export interface MabJobExtendedInfo { + /** + * List of tasks for this job. + */ tasksList?: MabJobTaskDetails[]; + /** + * The job properties. + */ propertyBag?: { [propertyName: string]: string }; + /** + * Non localized error message specific to this job. + */ dynamicErrorMessage?: string; } /** - * @class - * Initializes a new instance of the MabJob class. - * @constructor * MAB workload-specific job. - * - * @member {moment.duration} [duration] Time taken by job to run. - * @member {array} [actionsInfo] The state/actions applicable on jobs like - * cancel/retry. - * @member {string} [mabServerName] Name of server protecting the DS. - * @member {string} [mabServerType] Server type of MAB container. Possible - * values include: 'Invalid', 'Unknown', 'IaasVMContainer', - * 'IaasVMServiceContainer', 'DPMContainer', 'AzureBackupServerContainer', - * 'MABContainer', 'Cluster', 'AzureSqlContainer', 'Windows', 'VCenter', - * 'VMAppContainer', 'SQLAGWorkLoadContainer', 'StorageContainer', - * 'GenericContainer' - * @member {string} [workloadType] Workload type of backup item. Possible - * values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', - * 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', - * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' - * @member {array} [errorDetails] The errors. - * @member {object} [extendedInfo] Additional information on the job. - * @member {array} [extendedInfo.tasksList] List of tasks for this job. - * @member {object} [extendedInfo.propertyBag] The job properties. - * @member {string} [extendedInfo.dynamicErrorMessage] Non localized error - * message specific to this job. */ export interface MabJob extends Job { + /** + * Time taken by job to run. + */ duration?: moment.Duration; + /** + * The state/actions applicable on jobs like cancel/retry. + */ actionsInfo?: string[]; + /** + * Name of server protecting the DS. + */ mabServerName?: string; + /** + * Server type of MAB container. Possible values include: 'Invalid', 'Unknown', + * 'IaasVMContainer', 'IaasVMServiceContainer', 'DPMContainer', 'AzureBackupServerContainer', + * 'MABContainer', 'Cluster', 'AzureSqlContainer', 'Windows', 'VCenter', 'VMAppContainer', + * 'SQLAGWorkLoadContainer', 'StorageContainer', 'GenericContainer' + */ mabServerType?: string; + /** + * Workload type of backup item. Possible values include: 'Invalid', 'VM', 'FileFolder', + * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', + * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' + */ workloadType?: string; + /** + * The errors. + */ errorDetails?: MabErrorInfo[]; + /** + * Additional information on the job. + */ extendedInfo?: MabJobExtendedInfo; } /** - * @class - * Initializes a new instance of the MabProtectionPolicy class. - * @constructor * Mab container-specific backup policy. - * - * @member {object} [schedulePolicy] Backup schedule of backup policy. - * @member {string} [schedulePolicy.schedulePolicyType] Polymorphic - * Discriminator - * @member {object} [retentionPolicy] Retention policy details. - * @member {string} [retentionPolicy.retentionPolicyType] Polymorphic - * Discriminator */ export interface MabProtectionPolicy extends ProtectionPolicy { + /** + * Backup schedule of backup policy. + */ schedulePolicy?: SchedulePolicy; + /** + * Retention policy details. + */ retentionPolicy?: RetentionPolicy; } /** - * @class - * Initializes a new instance of the OperationResultInfo class. - * @constructor * Operation result info. - * - * @member {array} [jobList] List of jobs created by this operation. */ export interface OperationResultInfo extends OperationResultInfoBase { + /** + * List of jobs created by this operation. + */ jobList?: string[]; } /** - * @class - * Initializes a new instance of the OperationWorkerResponse class. - * @constructor * This is the base class for operation result responses. - * - * @member {string} [statusCode] HTTP Status Code of the operation. Possible - * values include: 'Continue', 'SwitchingProtocols', 'OK', 'Created', - * 'Accepted', 'NonAuthoritativeInformation', 'NoContent', 'ResetContent', - * 'PartialContent', 'MultipleChoices', 'Ambiguous', 'MovedPermanently', - * 'Moved', 'Found', 'Redirect', 'SeeOther', 'RedirectMethod', 'NotModified', - * 'UseProxy', 'Unused', 'TemporaryRedirect', 'RedirectKeepVerb', 'BadRequest', - * 'Unauthorized', 'PaymentRequired', 'Forbidden', 'NotFound', - * 'MethodNotAllowed', 'NotAcceptable', 'ProxyAuthenticationRequired', - * 'RequestTimeout', 'Conflict', 'Gone', 'LengthRequired', - * 'PreconditionFailed', 'RequestEntityTooLarge', 'RequestUriTooLong', - * 'UnsupportedMediaType', 'RequestedRangeNotSatisfiable', 'ExpectationFailed', - * 'UpgradeRequired', 'InternalServerError', 'NotImplemented', 'BadGateway', - * 'ServiceUnavailable', 'GatewayTimeout', 'HttpVersionNotSupported' - * @member {object} [headers] HTTP headers associated with this operation. */ export interface OperationWorkerResponse { + /** + * HTTP Status Code of the operation. Possible values include: 'Continue', 'SwitchingProtocols', + * 'OK', 'Created', 'Accepted', 'NonAuthoritativeInformation', 'NoContent', 'ResetContent', + * 'PartialContent', 'MultipleChoices', 'Ambiguous', 'MovedPermanently', 'Moved', 'Found', + * 'Redirect', 'SeeOther', 'RedirectMethod', 'NotModified', 'UseProxy', 'Unused', + * 'TemporaryRedirect', 'RedirectKeepVerb', 'BadRequest', 'Unauthorized', 'PaymentRequired', + * 'Forbidden', 'NotFound', 'MethodNotAllowed', 'NotAcceptable', 'ProxyAuthenticationRequired', + * 'RequestTimeout', 'Conflict', 'Gone', 'LengthRequired', 'PreconditionFailed', + * 'RequestEntityTooLarge', 'RequestUriTooLong', 'UnsupportedMediaType', + * 'RequestedRangeNotSatisfiable', 'ExpectationFailed', 'UpgradeRequired', 'InternalServerError', + * 'NotImplemented', 'BadGateway', 'ServiceUnavailable', 'GatewayTimeout', + * 'HttpVersionNotSupported' + */ statusCode?: string; + /** + * HTTP headers associated with this operation. + */ headers?: { [propertyName: string]: string[] }; } /** - * @class - * Initializes a new instance of the OperationResultInfoBaseResource class. - * @constructor * Base class for operation result info. - * - * @member {object} [operation] OperationResultInfoBaseResource operation - * @member {string} [operation.objectType] Polymorphic Discriminator */ export interface OperationResultInfoBaseResource extends OperationWorkerResponse { + /** + * OperationResultInfoBaseResource operation + */ operation?: OperationResultInfoBase; } /** - * @class - * Initializes a new instance of the PreValidateEnableBackupRequest class. - * @constructor - * Contract to validate if backup can be enabled on the given resource in a - * given vault and given configuration. + * Contract to validate if backup can be enabled on the given resource in a given vault and given + * configuration. * It will validate followings * 1. Vault capacity * 2. VM is already protected * 3. Any VM related configuration passed in properties. - * - * @member {string} [resourceType] ProtectedItem Type- VM, SqlDataBase, - * AzureFileShare etc. Possible values include: 'Invalid', 'VM', 'FileFolder', - * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', - * 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', - * 'SAPHanaDatabase' - * @member {string} [resourceId] ARM Virtual Machine Id - * @member {string} [properties] Configuration of VM if any needs to be - * validated like OS type etc */ export interface PreValidateEnableBackupRequest { + /** + * ProtectedItem Type- VM, SqlDataBase, AzureFileShare etc. Possible values include: 'Invalid', + * 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', + * 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', + * 'SAPHanaDatabase' + */ resourceType?: string; + /** + * ARM Virtual Machine Id + */ resourceId?: string; + /** + * Configuration of VM if any needs to be validated like OS type etc + */ properties?: string; } /** - * @class - * Initializes a new instance of the PreValidateEnableBackupResponse class. - * @constructor * Response contract for enable backup validation request - * - * @member {string} [status] Validation Status. Possible values include: - * 'Invalid', 'Succeeded', 'Failed' - * @member {string} [errorCode] Response error code - * @member {string} [errorMessage] Response error message - * @member {string} [recommendation] Recommended action for user - * @member {string} [containerName] Specifies the product specific container - * name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required - * for portal - * @member {string} [protectedItemName] Specifies the product specific ds name. - * E.g. vm;iaasvmcontainer;rgname;vmname. This is required for portal */ export interface PreValidateEnableBackupResponse { + /** + * Validation Status. Possible values include: 'Invalid', 'Succeeded', 'Failed' + */ status?: string; + /** + * Response error code + */ errorCode?: string; + /** + * Response error message + */ errorMessage?: string; + /** + * Recommended action for user + */ recommendation?: string; + /** + * Specifies the product specific container name. E.g. + * iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required + * for portal + */ containerName?: string; + /** + * Specifies the product specific ds name. E.g. vm;iaasvmcontainer;rgname;vmname. This is + * required for portal + */ protectedItemName?: string; } /** - * @class - * Initializes a new instance of the ProtectedItemQueryObject class. - * @constructor * Filters to list backup items. - * - * @member {string} [healthState] Health State for the backed up item. Possible - * values include: 'Passed', 'ActionRequired', 'ActionSuggested', 'Invalid' - * @member {string} [backupManagementType] Backup management type for the - * backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', - * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [itemType] Type of workload this item represents. Possible - * values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', - * 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', - * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' - * @member {string} [policyName] Backup policy name associated with the backup - * item. - * @member {string} [containerName] Name of the container. - * @member {string} [backupEngineName] Backup Engine name - * @member {string} [friendlyName] Friendly name of protected item - * @member {string} [fabricName] Name of the fabric. - * @member {string} [backupSetName] Name of the backup set. */ export interface ProtectedItemQueryObject { + /** + * Health State for the backed up item. Possible values include: 'Passed', 'ActionRequired', + * 'ActionSuggested', 'Invalid' + */ healthState?: string; + /** + * Backup management type for the backed up item. Possible values include: 'Invalid', + * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; + /** + * Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', + * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', + * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' + */ itemType?: string; + /** + * Backup policy name associated with the backup item. + */ policyName?: string; + /** + * Name of the container. + */ containerName?: string; + /** + * Backup Engine name + */ backupEngineName?: string; + /** + * Friendly name of protected item + */ friendlyName?: string; + /** + * Name of the fabric. + */ fabricName?: string; + /** + * Name of the backup set. + */ backupSetName?: string; } /** - * @class - * Initializes a new instance of the ProtectedItemResource class. - * @constructor * Base class for backup items. - * - * @member {object} [properties] ProtectedItemResource properties - * @member {string} [properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', - * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', - * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' - * @member {string} [properties.workloadType] Type of workload this item - * represents. Possible values include: 'Invalid', 'VM', 'FileFolder', - * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', - * 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', - * 'SAPHanaDatabase' - * @member {string} [properties.containerName] Unique name of container - * @member {string} [properties.sourceResourceId] ARM ID of the resource to be - * backed up. - * @member {string} [properties.policyId] ID of the backup policy with which - * this item is backed up. - * @member {date} [properties.lastRecoveryPoint] Timestamp when the last - * (latest) backup copy was created for this backup item. - * @member {string} [properties.backupSetName] Name of the backup set the - * backup item belongs to - * @member {string} [properties.createMode] Create mode to indicate recovery of - * existing soft deleted data source or creation of new data source. Possible - * values include: 'Invalid', 'Default', 'Recover' - * @member {string} [properties.protectedItemType] Polymorphic Discriminator */ export interface ProtectedItemResource extends Resource { + /** + * ProtectedItemResource properties + */ properties?: ProtectedItem; } /** - * @class - * Initializes a new instance of the ProtectionIntentQueryObject class. - * @constructor * Filters to list protection intent. - * - * @member {string} [backupManagementType] Backup management type for the - * backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', - * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [itemType] Type of workload this item represents. Possible - * values include: 'Invalid', 'SQLInstance', 'SQLAvailabilityGroupContainer' - * @member {string} [parentName] Parent name of the intent - * @member {string} [itemName] Item name of the intent */ export interface ProtectionIntentQueryObject { + /** + * Backup management type for the backed up item. Possible values include: 'Invalid', + * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; + /** + * Type of workload this item represents. Possible values include: 'Invalid', 'SQLInstance', + * 'SQLAvailabilityGroupContainer' + */ itemType?: string; + /** + * Parent name of the intent + */ parentName?: string; + /** + * Item name of the intent + */ itemName?: string; } /** - * @class - * Initializes a new instance of the ProtectionIntentResource class. - * @constructor * Base class for backup ProtectionIntent. - * - * @member {object} [properties] ProtectionIntentResource properties - * @member {string} [properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', - * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', - * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' - * @member {string} [properties.sourceResourceId] ARM ID of the resource to be - * backed up. - * @member {string} [properties.itemId] ID of the item which is getting - * protected, In case of Azure Vm , it is ProtectedItemId - * @member {string} [properties.policyId] ID of the backup policy with which - * this item is backed up. - * @member {string} [properties.protectionState] Backup state of this backup - * item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', - * 'Protected', 'ProtectionFailed' - * @member {string} [properties.protectionIntentItemType] Polymorphic - * Discriminator */ export interface ProtectionIntentResource extends Resource { + /** + * ProtectionIntentResource properties + */ properties?: ProtectionIntent; } /** - * @class - * Initializes a new instance of the ProtectionPolicyQueryObject class. - * @constructor * Filters the list backup policies API. - * - * @member {string} [backupManagementType] Backup management type for the - * backup policy. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', - * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [fabricName] Fabric name for filter - * @member {string} [workloadType] Workload type for the backup policy. - * Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', - * 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', - * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' */ export interface ProtectionPolicyQueryObject { + /** + * Backup management type for the backup policy. Possible values include: 'Invalid', + * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; + /** + * Fabric name for filter + */ fabricName?: string; + /** + * Workload type for the backup policy. Possible values include: 'Invalid', 'VM', 'FileFolder', + * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', + * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' + */ workloadType?: string; } /** - * @class - * Initializes a new instance of the ProtectionPolicyResource class. - * @constructor - * Base class for backup policy. Workload-specific backup policies are derived - * from this class. - * - * @member {object} [properties] ProtectionPolicyResource properties - * @member {number} [properties.protectedItemsCount] Number of items associated - * with this policy. - * @member {string} [properties.backupManagementType] Polymorphic Discriminator + * Base class for backup policy. Workload-specific backup policies are derived from this class. */ export interface ProtectionPolicyResource extends Resource { + /** + * ProtectionPolicyResource properties + */ properties?: ProtectionPolicy; } /** - * @class - * Initializes a new instance of the ResourceList class. - * @constructor * Base for all lists of resources. - * - * @member {string} [nextLink] The uri to fetch the next page of resources. - * Call ListNext() fetches next page of resources. */ export interface ResourceList { + /** + * The uri to fetch the next page of resources. Call ListNext() fetches next page of resources. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the SimpleRetentionPolicy class. - * @constructor * Simple policy retention. - * - * @member {object} [retentionDuration] Retention duration of the protection - * policy. - * @member {number} [retentionDuration.count] Count of duration types. - * Retention duration is obtained by the counting the duration type Count - * times. - * For example, when Count = 3 and DurationType = Weeks, retention duration - * will be three weeks. - * @member {string} [retentionDuration.durationType] Retention duration type of - * retention policy. Possible values include: 'Invalid', 'Days', 'Weeks', - * 'Months', 'Years' */ export interface SimpleRetentionPolicy extends RetentionPolicy { + /** + * Retention duration of the protection policy. + */ retentionDuration?: RetentionDuration; } /** - * @class - * Initializes a new instance of the SimpleSchedulePolicy class. - * @constructor * Simple policy schedule. - * - * @member {string} [scheduleRunFrequency] Frequency of the schedule operation - * of this policy. Possible values include: 'Invalid', 'Daily', 'Weekly' - * @member {array} [scheduleRunDays] List of days of week this schedule has to - * be run. - * @member {array} [scheduleRunTimes] List of times of day this schedule has to - * be run. - * @member {number} [scheduleWeeklyFrequency] At every number weeks this - * schedule has to be run. */ export interface SimpleSchedulePolicy extends SchedulePolicy { + /** + * Frequency of the schedule operation of this policy. Possible values include: 'Invalid', + * 'Daily', 'Weekly' + */ scheduleRunFrequency?: string; + /** + * List of days of week this schedule has to be run. + */ scheduleRunDays?: string[]; + /** + * List of times of day this schedule has to be run. + */ scheduleRunTimes?: Date[]; + /** + * At every number weeks this schedule has to be run. + */ scheduleWeeklyFrequency?: number; } /** - * @class - * Initializes a new instance of the ValidateOperationRequest class. - * @constructor * Base class for validate operation request. - * - * @member {string} objectType Polymorphic Discriminator */ export interface ValidateOperationRequest { + /** + * Polymorphic Discriminator + */ objectType: string; } /** - * @class - * Initializes a new instance of the ValidateRestoreOperationRequest class. - * @constructor * AzureRestoreValidation request. - * - * @member {object} [restoreRequest] Sets restore request to be validated - * @member {string} [restoreRequest.objectType] Polymorphic Discriminator */ export interface ValidateRestoreOperationRequest extends ValidateOperationRequest { + /** + * Sets restore request to be validated + */ restoreRequest?: RestoreRequest; } /** - * @class - * Initializes a new instance of the ValidateIaasVMRestoreOperationRequest class. - * @constructor * AzureRestoreValidation request. - * */ export interface ValidateIaasVMRestoreOperationRequest extends ValidateRestoreOperationRequest { } /** - * @class - * Initializes a new instance of the ValidateOperationResponse class. - * @constructor * Base class for validate operation response. - * - * @member {array} [validationResults] Gets the validation result */ export interface ValidateOperationResponse { + /** + * Gets the validation result + */ validationResults?: ErrorDetail[]; } -/** - * @class - * Initializes a new instance of the ValidateOperationsResponse class. - * @constructor - * @member {object} [validateOperationResponse] - * @member {array} [validateOperationResponse.validationResults] Gets the - * validation result - */ export interface ValidateOperationsResponse { validateOperationResponse?: ValidateOperationResponse; } /** - * @class - * Initializes a new instance of the DPMContainerExtendedInfo class. - * @constructor * Additional information of the DPMContainer. - * - * @member {date} [lastRefreshedAt] Last refresh time of the DPMContainer. - */ +*/ export interface DPMContainerExtendedInfo { + /** + * Last refresh time of the DPMContainer. + */ lastRefreshedAt?: Date; } /** - * @class - * Initializes a new instance of the ProtectionContainer class. - * @constructor - * Base class for container with backup items. Containers with specific - * workloads are derived from this class. - * - * @member {string} [friendlyName] Friendly name of the container. - * @member {string} [backupManagementType] Type of backup managemenent for the - * container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', - * 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [registrationStatus] Status of registration of the - * container with the Recovery Services Vault. - * @member {string} [healthStatus] Status of health of the container. - * @member {string} containerType Polymorphic Discriminator - */ + * Base class for container with backup items. Containers with specific workloads are derived from + * this class. +*/ export interface ProtectionContainer { + /** + * Friendly name of the container. + */ friendlyName?: string; + /** + * Type of backup management for the container. Possible values include: 'Invalid', + * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; + /** + * Status of registration of the container with the Recovery Services Vault. + */ registrationStatus?: string; + /** + * Status of health of the container. + */ healthStatus?: string; + /** + * Polymorphic Discriminator + */ containerType: string; } /** - * @class - * Initializes a new instance of the AzureBackupServerContainer class. - * @constructor * AzureBackupServer (DPMVenus) workload-specific protection container. - * - * @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. - */ +*/ export interface AzureBackupServerContainer extends ProtectionContainer { + /** + * Specifies whether the container is re-registrable. + */ canReRegister?: boolean; + /** + * ID of container. + */ containerId?: string; + /** + * Number of protected items in the BackupEngine + */ protectedItemCount?: number; + /** + * Backup engine Agent version + */ dpmAgentVersion?: string; + /** + * List of BackupEngines protecting the container + */ dpmServers?: string[]; + /** + * To check if upgrade available + */ upgradeAvailable?: boolean; + /** + * Protection status of the container. + */ protectionStatus?: string; + /** + * Extended Info of the container. + */ extendedInfo?: DPMContainerExtendedInfo; } /** - * @class - * Initializes a new instance of the BackupEngineBase class. - * @constructor - * The base backup engine class. All workload specific backup engines derive - * from this class. - * - * @member {string} [friendlyName] Friendly name of the backup engine. - * @member {string} [backupManagementType] Type of backup management for the - * backup engine. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', - * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [registrationStatus] Registration status of the backup - * engine with the Recovery Services Vault. - * @member {string} [backupEngineState] Status of the backup engine with the - * Recovery Services Vault. = {Active/Deleting/DeleteFailed} - * @member {string} [healthStatus] Backup status of the backup engine. - * @member {boolean} [canReRegister] Flag indicating if the backup engine be - * registered, once already registered. - * @member {string} [backupEngineId] ID of the backup engine. - * @member {string} [dpmVersion] Backup engine version - * @member {string} [azureBackupAgentVersion] Backup agent version - * @member {boolean} [isAzureBackupAgentUpgradeAvailable] To check if backup - * agent upgrade available - * @member {boolean} [isDpmUpgradeAvailable] To check if backup engine upgrade - * available - * @member {object} [extendedInfo] Extended info of the backupengine - * @member {string} [extendedInfo.databaseName] Database name of backup engine. - * @member {number} [extendedInfo.protectedItemsCount] Number of protected - * items in the backup engine. - * @member {number} [extendedInfo.protectedServersCount] Number of protected - * servers in the backup engine. - * @member {number} [extendedInfo.diskCount] Number of disks in the backup - * engine. - * @member {number} [extendedInfo.usedDiskSpace] Diskspace used in the backup - * engine. - * @member {number} [extendedInfo.availableDiskSpace] Diskspace currently - * available in the backup engine. - * @member {date} [extendedInfo.refreshedAt] Last refresh time in the backup - * engine. - * @member {number} [extendedInfo.azureProtectedInstances] Protected instances - * in the backup engine. - * @member {string} backupEngineType Polymorphic Discriminator - */ + * The base backup engine class. All workload specific backup engines derive from this class. +*/ export interface BackupEngineBase { + /** + * Friendly name of the backup engine. + */ friendlyName?: string; + /** + * Type of backup management for the backup engine. Possible values include: 'Invalid', + * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; + /** + * Registration status of the backup engine with the Recovery Services Vault. + */ registrationStatus?: string; + /** + * Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed} + */ backupEngineState?: string; + /** + * Backup status of the backup engine. + */ healthStatus?: string; + /** + * Flag indicating if the backup engine be registered, once already registered. + */ canReRegister?: boolean; + /** + * ID of the backup engine. + */ backupEngineId?: string; + /** + * Backup engine version + */ dpmVersion?: string; + /** + * Backup agent version + */ azureBackupAgentVersion?: string; + /** + * To check if backup agent upgrade available + */ isAzureBackupAgentUpgradeAvailable?: boolean; + /** + * To check if backup engine upgrade available + */ isDpmUpgradeAvailable?: boolean; + /** + * Extended info of the backup engine + */ extendedInfo?: BackupEngineExtendedInfo; + /** + * Polymorphic Discriminator + */ backupEngineType: string; } /** - * @class - * Initializes a new instance of the AzureBackupServerEngine class. - * @constructor * Backup engine type when Azure Backup Server is used to manage the backups. - * - */ +*/ export interface AzureBackupServerEngine extends BackupEngineBase { } /** - * @class - * Initializes a new instance of the BackupRequest class. - * @constructor - * Base class for backup request. Workload-specific backup requests are derived - * from this class. - * - * @member {string} objectType Polymorphic Discriminator - */ + * Base class for backup request. Workload-specific backup requests are derived from this class. +*/ export interface BackupRequest { + /** + * Polymorphic Discriminator + */ objectType: string; } /** - * @class - * Initializes a new instance of the AzureFileShareBackupRequest class. - * @constructor * AzureFileShare workload-specific backup request. - * - * @member {date} [recoveryPointExpiryTimeInUTC] Backup copy will expire after - * the time specified (UTC). - */ +*/ export interface AzureFileShareBackupRequest extends BackupRequest { + /** + * Backup copy will expire after the time specified (UTC). + */ recoveryPointExpiryTimeInUTC?: Date; } /** - * @class - * Initializes a new instance of the WorkloadProtectableItem class. - * @constructor - * Base class for backup item. Workload-specific backup items are derived from - * this class. - * - * @member {string} [backupManagementType] Type of backup managemenent to - * backup an item. - * @member {string} [workloadType] Type of workload for the backup management - * @member {string} [friendlyName] Friendly name of the backup item. - * @member {string} [protectionState] State of the back up item. Possible - * values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', - * 'ProtectionFailed' - * @member {string} protectableItemType Polymorphic Discriminator - */ + * Base class for backup item. Workload-specific backup items are derived from this class. +*/ export interface WorkloadProtectableItem { + /** + * Type of backup management to backup an item. + */ backupManagementType?: string; + /** + * Type of workload for the backup management + */ workloadType?: string; + /** + * Friendly name of the backup item. + */ friendlyName?: string; + /** + * State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', + * 'Protected', 'ProtectionFailed' + */ protectionState?: string; + /** + * Polymorphic Discriminator + */ protectableItemType: string; } /** - * @class - * Initializes a new instance of the AzureFileShareProtectableItem class. - * @constructor * Protectable item for Azure Fileshare workloads. - * - * @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. - * Possible values include: 'Invalid', 'XSMB', 'XSync' - */ +*/ export interface AzureFileShareProtectableItem extends WorkloadProtectableItem { + /** + * Full Fabric ID of container to which this protectable item belongs. For example, ARM ID. + */ parentContainerFabricId?: string; + /** + * Friendly name of container to which this protectable item belongs. + */ parentContainerFriendlyName?: string; + /** + * File Share type XSync or XSMB. Possible values include: 'Invalid', 'XSMB', 'XSync' + */ azureFileShareType?: string; } /** - * @class - * Initializes a new instance of the RecoveryPoint class. - * @constructor - * Base class for backup copies. Workload-specific backup copies are derived - * from this class. - * - * @member {string} objectType Polymorphic Discriminator - */ + * Base class for backup copies. Workload-specific backup copies are derived from this class. +*/ export interface RecoveryPoint { + /** + * Polymorphic Discriminator + */ objectType: string; } /** - * @class - * Initializes a new instance of the AzureFileShareRecoveryPoint class. - * @constructor * Azure File Share workload specific backup copy. - * - * @member {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 - * created. - * @member {string} [fileShareSnapshotUri] Contains Url to the snapshot of - * fileshare, if applicable - */ +*/ export interface AzureFileShareRecoveryPoint extends RecoveryPoint { + /** + * Type of the backup copy. Specifies whether it is a crash consistent backup or app consistent. + */ recoveryPointType?: string; + /** + * Time at which this backup copy was created. + */ recoveryPointTime?: Date; + /** + * Contains Url to the snapshot of fileshare, if applicable + */ fileShareSnapshotUri?: string; } /** - * @class - * Initializes a new instance of the IaaSVMContainer class. - * @constructor * IaaS VM workload-specific container. - * - * @member {string} [virtualMachineId] Fully qualified ARM url of the virtual - * machine represented by this Azure IaaS VM container. - * @member {string} [virtualMachineVersion] Specifies whether the container - * represents a Classic or an Azure Resource Manager VM. - * @member {string} [resourceGroup] Resource group name of Recovery Services - * Vault. - */ +*/ export interface IaaSVMContainer extends ProtectionContainer { + /** + * Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container. + */ virtualMachineId?: string; + /** + * Specifies whether the container represents a Classic or an Azure Resource Manager VM. + */ virtualMachineVersion?: string; + /** + * Resource group name of Recovery Services Vault. + */ resourceGroup?: string; } /** - * @class - * Initializes a new instance of the AzureIaaSClassicComputeVMContainer class. - * @constructor - * IaaS VM workload-specific backup item representing a classic virtual - * machine. - * - */ + * IaaS VM workload-specific backup item representing a classic virtual machine. +*/ export interface AzureIaaSClassicComputeVMContainer extends IaaSVMContainer { } /** - * @class - * Initializes a new instance of the IaaSVMProtectableItem class. - * @constructor * IaaS VM workload-specific backup item. - * - * @member {string} [virtualMachineId] Fully qualified ARM ID of the virtual - * machine. - */ +*/ export interface IaaSVMProtectableItem extends WorkloadProtectableItem { + /** + * Fully qualified ARM ID of the virtual machine. + */ virtualMachineId?: string; } /** - * @class - * Initializes a new instance of the AzureIaaSClassicComputeVMProtectableItem class. - * @constructor * IaaS VM workload-specific backup item representing the Classic Compute VM. - * - */ +*/ export interface AzureIaaSClassicComputeVMProtectableItem extends IaaSVMProtectableItem { } /** - * @class - * Initializes a new instance of the AzureIaaSComputeVMContainer class. - * @constructor - * IaaS VM workload-specific backup item representing an Azure Resource Manager - * virtual machine. - * - */ + * IaaS VM workload-specific backup item representing an Azure Resource Manager virtual machine. +*/ export interface AzureIaaSComputeVMContainer extends IaaSVMContainer { } /** - * @class - * Initializes a new instance of the AzureIaaSComputeVMProtectableItem class. - * @constructor - * IaaS VM workload-specific backup item representing the Azure Resource - * Manager VM. - * - */ + * IaaS VM workload-specific backup item representing the Azure Resource Manager VM. +*/ export interface AzureIaaSComputeVMProtectableItem extends IaaSVMProtectableItem { } /** - * @class - * Initializes a new instance of the AzureWorkloadContainer class. - * @constructor * Container for the workloads running inside Azure Compute or Classic Compute. - * - * @member {string} [sourceResourceId] ARM ID of the virtual machine - * represented by this Azure Workload Container - * @member {date} [lastUpdatedTime] Time stamp when this container was updated. - * @member {object} [extendedInfo] Additional details of a workload container. - * @member {string} [extendedInfo.hostServerName] Host Os Name in case of Stand - * Alone and Cluster Name in case of distributed container. - * @member {object} [extendedInfo.inquiryInfo] Inquiry Status for the - * container. - * @member {string} [extendedInfo.inquiryInfo.status] Inquiry Status for this - * container such as - * InProgress | Failed | Succeeded - * @member {object} [extendedInfo.inquiryInfo.errorDetail] Error Details if the - * Status is non-success. - * @member {string} [extendedInfo.inquiryInfo.errorDetail.code] Error code. - * @member {string} [extendedInfo.inquiryInfo.errorDetail.message] Error - * Message related to the Code. - * @member {array} [extendedInfo.inquiryInfo.errorDetail.recommendations] List - * of recommendation strings. - * @member {array} [extendedInfo.inquiryInfo.inquiryDetails] Inquiry Details - * which will have workload specific details. - * For e.g. - For SQL and oracle this will contain different details. - * @member {array} [extendedInfo.nodesList] List of the nodes in case of - * distributed container. - * @member {string} [workloadType] Workload type for which registration was - * sent. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', - * 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', - * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' - */ +*/ export interface AzureWorkloadContainer extends ProtectionContainer { + /** + * ARM ID of the virtual machine represented by this Azure Workload Container + */ sourceResourceId?: string; + /** + * Time stamp when this container was updated. + */ lastUpdatedTime?: Date; + /** + * Additional details of a workload container. + */ extendedInfo?: AzureWorkloadContainerExtendedInfo; + /** + * Workload type for which registration was sent. Possible values include: 'Invalid', 'VM', + * 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', + * 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' + */ workloadType?: string; } /** - * @class - * Initializes a new instance of the AzureSQLAGWorkloadContainerProtectionContainer class. - * @constructor * Container for SQL workloads under SQL Availability Group. - * - */ +*/ export interface AzureSQLAGWorkloadContainerProtectionContainer extends AzureWorkloadContainer { } /** - * @class - * Initializes a new instance of the AzureSqlContainer class. - * @constructor * Azure Sql workload-specific container. - * - */ +*/ export interface AzureSqlContainer extends ProtectionContainer { } /** - * @class - * Initializes a new instance of the AzureStorageContainer class. - * @constructor * Azure Storage Account workload-specific container. - * - * @member {string} [sourceResourceId] Fully qualified ARM url. - * @member {string} [storageAccountVersion] Storage account version. - * @member {string} [resourceGroup] Resource group name of Recovery Services - * Vault. - * @member {number} [protectedItemCount] Number of items backed up in this - * container. - */ +*/ export interface AzureStorageContainer extends ProtectionContainer { + /** + * Fully qualified ARM url. + */ sourceResourceId?: string; + /** + * Storage account version. + */ storageAccountVersion?: string; + /** + * Resource group name of Recovery Services Vault. + */ resourceGroup?: string; + /** + * Number of items backed up in this container. + */ protectedItemCount?: number; } /** - * @class - * Initializes a new instance of the ProtectableContainer class. - * @constructor * Protectable Container Class. - * - * @member {string} [friendlyName] Friendly name of the container. - * @member {string} [backupManagementType] Type of backup managemenent for the - * container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', - * 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [healthStatus] Status of health of the container. - * @member {string} [containerId] Fabric Id of the container such as ARM Id. - * @member {string} protectableContainerType Polymorphic Discriminator - */ +*/ export interface ProtectableContainer { + /** + * Friendly name of the container. + */ friendlyName?: string; + /** + * Type of backup management for the container. Possible values include: 'Invalid', + * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; + /** + * Status of health of the container. + */ healthStatus?: string; + /** + * Fabric Id of the container such as ARM Id. + */ containerId?: string; + /** + * Polymorphic Discriminator + */ protectableContainerType: string; } /** - * @class - * Initializes a new instance of the AzureStorageProtectableContainer class. - * @constructor * Azure Storage-specific protectable containers - * - */ +*/ export interface AzureStorageProtectableContainer extends ProtectableContainer { } /** - * @class - * Initializes a new instance of the AzureVMAppContainerProtectableContainer class. - * @constructor * Azure workload-specific container - * - */ +*/ export interface AzureVMAppContainerProtectableContainer extends ProtectableContainer { } /** - * @class - * Initializes a new instance of the AzureVMAppContainerProtectionContainer class. - * @constructor * Container for SQL workloads under Azure Virtual Machines. - * - */ +*/ export interface AzureVMAppContainerProtectionContainer extends AzureWorkloadContainer { } /** - * @class - * Initializes a new instance of the WorkloadItem class. - * @constructor - * Base class for backup item. Workload-specific backup items are derived from - * this class. - * - * @member {string} [backupManagementType] Type of backup managemenent to - * backup an item. - * @member {string} [workloadType] Type of workload for the backup management - * @member {string} [friendlyName] Friendly name of the backup item. - * @member {string} [protectionState] State of the back up item. Possible - * values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', - * 'ProtectionFailed' - * @member {string} workloadItemType Polymorphic Discriminator - */ + * Base class for backup item. Workload-specific backup items are derived from this class. +*/ export interface WorkloadItem { + /** + * Type of backup management to backup an item. + */ backupManagementType?: string; + /** + * Type of workload for the backup management + */ workloadType?: string; + /** + * Friendly name of the backup item. + */ friendlyName?: string; + /** + * State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', + * 'Protected', 'ProtectionFailed' + */ protectionState?: string; + /** + * Polymorphic Discriminator + */ workloadItemType: string; } /** - * @class - * Initializes a new instance of the AzureVmWorkloadItem class. - * @constructor * Azure VM workload-specific workload item. - * - * @member {string} [parentName] Name for instance or AG - * @member {string} [serverName] Host/Cluster Name for instance or AG - * @member {boolean} [isAutoProtectable] Indicates if workload item is - * auto-protectable - * @member {number} [subinquireditemcount] For instance or AG, indicates number - * of DB's present - * @member {number} [subWorkloadItemCount] For instance or AG, indicates number - * of DB's to be protected - */ +*/ export interface AzureVmWorkloadItem extends WorkloadItem { + /** + * Name for instance or AG + */ parentName?: string; + /** + * Host/Cluster Name for instance or AG + */ serverName?: string; + /** + * Indicates if workload item is auto-protectable + */ isAutoProtectable?: boolean; + /** + * For instance or AG, indicates number of DBs present + */ subinquireditemcount?: number; + /** + * For instance or AG, indicates number of DBs to be protected + */ subWorkloadItemCount?: number; } /** - * @class - * Initializes a new instance of the PreBackupValidation class. - * @constructor * Pre-backup validation for Azure VM Workload provider. - * - * @member {string} [status] Status of protectable item, i.e. - * InProgress,Succeeded,Failed. Possible values include: 'Invalid', 'Success', - * 'Failed' - * @member {string} [code] Error code of protectable item - * @member {string} [message] Message corresponding to the error code for the - * protectable item - */ +*/ export interface PreBackupValidation { + /** + * Status of protectable item, i.e. InProgress,Succeeded,Failed. Possible values include: + * 'Invalid', 'Success', 'Failed' + */ status?: string; + /** + * Error code of protectable item + */ code?: string; + /** + * Message corresponding to the error code for the protectable item + */ message?: string; } /** - * @class - * Initializes a new instance of the AzureVmWorkloadProtectableItem class. - * @constructor * Azure VM workload-specific protectable item. - * - * @member {string} [parentName] Name for instance or AG - * @member {string} [parentUniqueName] Parent Unique Name is added to provide - * the service formatted URI Name of the Parent - * Only Applicable for data bases where the parent would be either Instance or - * a SQL AG. - * @member {string} [serverName] Host/Cluster Name for instance or AG - * @member {boolean} [isAutoProtectable] Indicates if protectable item is - * auto-protectable - * @member {boolean} [isAutoProtected] Indicates if protectable item is - * auto-protected - * @member {number} [subinquireditemcount] For instance or AG, indicates number - * of DB's present - * @member {number} [subprotectableitemcount] For instance or AG, indicates - * number of DB's to be protected - * @member {object} [prebackupvalidation] Pre-backup validation for protectable - * objects - * @member {string} [prebackupvalidation.status] Status of protectable item, - * i.e. InProgress,Succeeded,Failed. Possible values include: 'Invalid', - * 'Success', 'Failed' - * @member {string} [prebackupvalidation.code] Error code of protectable item - * @member {string} [prebackupvalidation.message] Message corresponding to the - * error code for the protectable item - */ +*/ export interface AzureVmWorkloadProtectableItem extends WorkloadProtectableItem { + /** + * Name for instance or AG + */ parentName?: string; + /** + * Parent Unique Name is added to provide the service formatted URI Name of the Parent + * Only Applicable for data bases where the parent would be either Instance or a SQL AG. + */ parentUniqueName?: string; + /** + * Host/Cluster Name for instance or AG + */ serverName?: string; + /** + * Indicates if protectable item is auto-protectable + */ isAutoProtectable?: boolean; + /** + * Indicates if protectable item is auto-protected + */ isAutoProtected?: boolean; + /** + * For instance or AG, indicates number of DBs present + */ subinquireditemcount?: number; + /** + * For instance or AG, indicates number of DBs to be protected + */ subprotectableitemcount?: number; + /** + * Pre-backup validation for protectable objects + */ prebackupvalidation?: PreBackupValidation; } /** - * @class - * Initializes a new instance of the AzureVmWorkloadSAPHanaDatabaseProtectableItem class. - * @constructor * Azure VM workload-specific protectable item representing SAP Hana Database. - * - */ -export interface AzureVmWorkloadSAPHanaDatabaseProtectableItem extends AzureVmWorkloadProtectableItem { +*/ +export interface AzureVmWorkloadSAPHanaDatabaseProtectableItem extends +AzureVmWorkloadProtectableItem { } /** - * @class - * Initializes a new instance of the AzureVmWorkloadSAPHanaDatabaseWorkloadItem class. - * @constructor * Azure VM workload-specific workload item representing SAP Hana Database. - * - */ +*/ export interface AzureVmWorkloadSAPHanaDatabaseWorkloadItem extends AzureVmWorkloadItem { } /** - * @class - * Initializes a new instance of the AzureVmWorkloadSAPHanaSystemProtectableItem class. - * @constructor * Azure VM workload-specific protectable item representing SAP Hana System. - * - */ -export interface AzureVmWorkloadSAPHanaSystemProtectableItem extends AzureVmWorkloadProtectableItem { +*/ +export interface AzureVmWorkloadSAPHanaSystemProtectableItem extends AzureVmWorkloadProtectableItem +{ } /** - * @class - * Initializes a new instance of the AzureVmWorkloadSAPHanaSystemWorkloadItem class. - * @constructor * Azure VM workload-specific workload item representing SAP Hana System. - * - */ +*/ export interface AzureVmWorkloadSAPHanaSystemWorkloadItem extends AzureVmWorkloadItem { } /** - * @class - * Initializes a new instance of the AzureVmWorkloadSQLAvailabilityGroupProtectableItem class. - * @constructor - * Azure VM workload-specific protectable item representing SQL Availability - * Group. - * - */ -export interface AzureVmWorkloadSQLAvailabilityGroupProtectableItem extends AzureVmWorkloadProtectableItem { + * Azure VM workload-specific protectable item representing SQL Availability Group. +*/ +export interface AzureVmWorkloadSQLAvailabilityGroupProtectableItem extends +AzureVmWorkloadProtectableItem { } /** - * @class - * Initializes a new instance of the AzureVmWorkloadSQLDatabaseProtectableItem class. - * @constructor * Azure VM workload-specific protectable item representing SQL Database. - * - */ +*/ export interface AzureVmWorkloadSQLDatabaseProtectableItem extends AzureVmWorkloadProtectableItem { } /** - * @class - * Initializes a new instance of the AzureVmWorkloadSQLDatabaseWorkloadItem class. - * @constructor * Azure VM workload-specific workload item representing SQL Database. - * - */ +*/ export interface AzureVmWorkloadSQLDatabaseWorkloadItem extends AzureVmWorkloadItem { } /** - * @class - * Initializes a new instance of the AzureVmWorkloadSQLInstanceProtectableItem class. - * @constructor * Azure VM workload-specific protectable item representing SQL Instance. - * - */ +*/ export interface AzureVmWorkloadSQLInstanceProtectableItem extends AzureVmWorkloadProtectableItem { } /** - * @class - * Initializes a new instance of the SQLDataDirectory class. - * @constructor * SQLDataDirectory info - * - * @member {string} [type] Type of data directory mapping. Possible values - * include: 'Invalid', 'Data', 'Log' - * @member {string} [path] File path - * @member {string} [logicalName] Logical name of the file - */ +*/ export interface SQLDataDirectory { + /** + * Type of data directory mapping. Possible values include: 'Invalid', 'Data', 'Log' + */ type?: string; + /** + * File path + */ path?: string; + /** + * Logical name of the file + */ logicalName?: string; } /** - * @class - * Initializes a new instance of the AzureVmWorkloadSQLInstanceWorkloadItem class. - * @constructor * Azure VM workload-specific workload item representing SQL Instance. - * - * @member {array} [dataDirectoryPaths] Data Directory Paths for default - * directories - */ +*/ export interface AzureVmWorkloadSQLInstanceWorkloadItem extends AzureVmWorkloadItem { + /** + * Data Directory Paths for default directories + */ dataDirectoryPaths?: SQLDataDirectory[]; } /** - * @class - * Initializes a new instance of the AzureWorkloadBackupRequest class. - * @constructor * AzureWorkload workload-specific backup request. - * - * @member {string} [backupType] Type of backup, viz. Full, Differential, Log - * or CopyOnlyFull. Possible values include: 'Invalid', 'Full', 'Differential', - * 'Log', 'CopyOnlyFull' - * @member {boolean} [enableCompression] Bool for Compression setting - * @member {date} [recoveryPointExpiryTimeInUTC] Backup copy will expire after - * the time specified (UTC). - */ +*/ export interface AzureWorkloadBackupRequest extends BackupRequest { + /** + * Type of backup, viz. Full, Differential, Log or CopyOnlyFull. Possible values include: + * 'Invalid', 'Full', 'Differential', 'Log', 'CopyOnlyFull' + */ backupType?: string; + /** + * Bool for Compression setting + */ enableCompression?: boolean; + /** + * Backup copy will expire after the time specified (UTC). + */ recoveryPointExpiryTimeInUTC?: Date; } /** - * @class - * Initializes a new instance of the InquiryValidation class. - * @constructor * Validation for inquired protectable items under a given container. - * - * @member {string} [status] Status for the Inquiry Validation. - * @member {object} [errorDetail] Error Detail in case the status is - * non-success. - * @member {string} [errorDetail.code] Error code. - * @member {string} [errorDetail.message] Error Message related to the Code. - * @member {array} [errorDetail.recommendations] List of recommendation - * strings. - */ +*/ export interface InquiryValidation { + /** + * Status for the Inquiry Validation. + */ status?: string; + /** + * Error Detail in case the status is non-success. + */ errorDetail?: ErrorDetail; } /** - * @class - * Initializes a new instance of the WorkloadInquiryDetails class. - * @constructor * Details of an inquired protectable item. - * - * @member {string} [type] Type of the Workload such as SQL, Oracle etc. - * @member {number} [itemCount] Contains the protectable item Count inside this - * Container. - * @member {object} [inquiryValidation] Inquiry validation such as permissions - * and other backup validations. - * @member {string} [inquiryValidation.status] Status for the Inquiry - * Validation. - * @member {object} [inquiryValidation.errorDetail] Error Detail in case the - * status is non-success. - * @member {string} [inquiryValidation.errorDetail.code] Error code. - * @member {string} [inquiryValidation.errorDetail.message] Error Message - * related to the Code. - * @member {array} [inquiryValidation.errorDetail.recommendations] List of - * recommendation strings. - */ +*/ export interface WorkloadInquiryDetails { + /** + * Type of the Workload such as SQL, Oracle etc. + */ type?: string; + /** + * Contains the protectable item Count inside this Container. + */ itemCount?: number; + /** + * Inquiry validation such as permissions and other backup validations. + */ inquiryValidation?: InquiryValidation; } /** - * @class - * Initializes a new instance of the InquiryInfo class. - * @constructor * Details about inquired protectable items under a given container. - * - * @member {string} [status] Inquiry Status for this container such as - * InProgress | Failed | Succeeded - * @member {object} [errorDetail] Error Details if the Status is non-success. - * @member {string} [errorDetail.code] Error code. - * @member {string} [errorDetail.message] Error Message related to the Code. - * @member {array} [errorDetail.recommendations] List of recommendation - * strings. - * @member {array} [inquiryDetails] Inquiry Details which will have workload - * specific details. - * For e.g. - For SQL and oracle this will contain different details. - */ +*/ export interface InquiryInfo { + /** + * Inquiry Status for this container such as + * InProgress | Failed | Succeeded + */ status?: string; + /** + * Error Details if the Status is non-success. + */ errorDetail?: ErrorDetail; + /** + * Inquiry Details which will have workload specific details. + * For e.g. - For SQL and oracle this will contain different details. + */ inquiryDetails?: WorkloadInquiryDetails[]; } /** - * @class - * Initializes a new instance of the DistributedNodesInfo class. - * @constructor * This is used to represent the various nodes of the distributed container. - * - * @member {string} [nodeName] Name of the node under a distributed container. - * @member {string} [status] Status of this Node. - * Failed | Succeeded - * @member {object} [errorDetail] Error Details if the Status is non-success. - * @member {string} [errorDetail.code] Error code. - * @member {string} [errorDetail.message] Error Message related to the Code. - * @member {array} [errorDetail.recommendations] List of recommendation - * strings. - */ +*/ export interface DistributedNodesInfo { + /** + * Name of the node under a distributed container. + */ nodeName?: string; + /** + * Status of this Node. + * Failed | Succeeded + */ status?: string; + /** + * Error Details if the Status is non-success. + */ errorDetail?: ErrorDetail; } /** - * @class - * Initializes a new instance of the AzureWorkloadContainerExtendedInfo class. - * @constructor * Extended information of the container. - * - * @member {string} [hostServerName] Host Os Name in case of Stand Alone and - * Cluster Name in case of distributed container. - * @member {object} [inquiryInfo] Inquiry Status for the container. - * @member {string} [inquiryInfo.status] Inquiry Status for this container such - * as - * InProgress | Failed | Succeeded - * @member {object} [inquiryInfo.errorDetail] Error Details if the Status is - * non-success. - * @member {string} [inquiryInfo.errorDetail.code] Error code. - * @member {string} [inquiryInfo.errorDetail.message] Error Message related to - * the Code. - * @member {array} [inquiryInfo.errorDetail.recommendations] List of - * recommendation strings. - * @member {array} [inquiryInfo.inquiryDetails] Inquiry Details which will have - * workload specific details. - * For e.g. - For SQL and oracle this will contain different details. - * @member {array} [nodesList] List of the nodes in case of distributed - * container. - */ +*/ export interface AzureWorkloadContainerExtendedInfo { + /** + * Host Os Name in case of Stand Alone and Cluster Name in case of distributed container. + */ hostServerName?: string; + /** + * Inquiry Status for the container. + */ inquiryInfo?: InquiryInfo; + /** + * List of the nodes in case of distributed container. + */ nodesList?: DistributedNodesInfo[]; } /** - * @class - * Initializes a new instance of the AzureWorkloadRecoveryPoint class. - * @constructor - * Workload specific recoverypoint, specifcally encaspulates full/diff - * recoverypoint - * - * @member {date} [recoveryPointTimeInUTC] UTC time at which recoverypoint was - * created - * @member {string} [type] Type of restore point. Possible values include: - * 'Invalid', 'Full', 'Log', 'Differential' - */ + * Workload specific recovery point, specifically encapsulates full/diff recovery point +*/ export interface AzureWorkloadRecoveryPoint extends RecoveryPoint { + /** + * UTC time at which recovery point was created + */ recoveryPointTimeInUTC?: Date; + /** + * Type of restore point. Possible values include: 'Invalid', 'Full', 'Log', 'Differential' + */ type?: string; } /** - * @class - * Initializes a new instance of the PointInTimeRange class. - * @constructor * Provides details for log ranges - * - * @member {date} [startTime] Start time of the time range for log recovery. - * @member {date} [endTime] End time of the time range for log recovery. - */ +*/ export interface PointInTimeRange { + /** + * Start time of the time range for log recovery. + */ startTime?: Date; + /** + * End time of the time range for log recovery. + */ endTime?: Date; } /** - * @class - * Initializes a new instance of the AzureWorkloadSAPHanaRecoveryPoint class. - * @constructor - * SAPHana specific recoverypoint, specifcally encaspulates full/diff - * recoverypoints - * - * @member {date} [recoveryPointTimeInUTC] UTC time at which recoverypoint was - * created - * @member {string} [type] Type of restore point. Possible values include: - * 'Invalid', 'Full', 'Log', 'Differential' - */ + * SAPHana specific recovery point, specifically encapsulates full/diff recovery points +*/ export interface AzureWorkloadSAPHanaRecoveryPoint extends RecoveryPoint { + /** + * UTC time at which recovery point was created + */ recoveryPointTimeInUTC?: Date; + /** + * Type of restore point. Possible values include: 'Invalid', 'Full', 'Log', 'Differential' + */ type?: string; } /** - * @class - * Initializes a new instance of the AzureWorkloadSAPHanaPointInTimeRecoveryPoint class. - * @constructor * Recovery point specific to PointInTime in SAPHana - * - * @member {array} [timeRanges] List of log ranges - */ -export interface AzureWorkloadSAPHanaPointInTimeRecoveryPoint extends AzureWorkloadSAPHanaRecoveryPoint { +*/ +export interface AzureWorkloadSAPHanaPointInTimeRecoveryPoint extends +AzureWorkloadSAPHanaRecoveryPoint { + /** + * List of log ranges + */ timeRanges?: PointInTimeRange[]; } /** - * @class - * Initializes a new instance of the AzureWorkloadSQLRecoveryPoint class. - * @constructor - * SQL specific recoverypoint, specifcally encaspulates full/diff recoverypoint - * alongwith extended info - * - * @member {object} [extendedInfo] Extended Info that provides data directory - * details. Will be populated in two cases: - * When a specific recovery point is accessed using GetRecoveryPoint - * Or when ListRecoveryPoints is called for Log RP only with ExtendedInfo query - * filter - * @member {date} [extendedInfo.dataDirectoryTimeInUTC] UTC time at which data - * directory info was captured - * @member {array} [extendedInfo.dataDirectoryPaths] List of data directory - * paths during restore operation. - */ + * SQL specific recovery point, specifically encapsulates full/diff recovery point along with + * extended info +*/ export interface AzureWorkloadSQLRecoveryPoint extends AzureWorkloadRecoveryPoint { + /** + * Extended Info that provides data directory details. Will be populated in two cases: + * When a specific recovery point is accessed using GetRecoveryPoint + * Or when ListRecoveryPoints is called for Log RP only with ExtendedInfo query filter + */ extendedInfo?: AzureWorkloadSQLRecoveryPointExtendedInfo; } /** - * @class - * Initializes a new instance of the AzureWorkloadSQLPointInTimeRecoveryPoint class. - * @constructor * Recovery point specific to PointInTime - * - * @member {array} [timeRanges] List of log ranges - */ +*/ export interface AzureWorkloadSQLPointInTimeRecoveryPoint extends AzureWorkloadSQLRecoveryPoint { + /** + * List of log ranges + */ timeRanges?: PointInTimeRange[]; } /** - * @class - * Initializes a new instance of the AzureWorkloadSQLRecoveryPointExtendedInfo class. - * @constructor * Extended info class details - * - * @member {date} [dataDirectoryTimeInUTC] UTC time at which data directory - * info was captured - * @member {array} [dataDirectoryPaths] List of data directory paths during - * restore operation. - */ +*/ export interface AzureWorkloadSQLRecoveryPointExtendedInfo { + /** + * UTC time at which data directory info was captured + */ dataDirectoryTimeInUTC?: Date; + /** + * List of data directory paths during restore operation. + */ dataDirectoryPaths?: SQLDataDirectory[]; } /** - * @class - * Initializes a new instance of the BackupEngineExtendedInfo class. - * @constructor * Additional information on backup engine. - * - * @member {string} [databaseName] Database name of backup engine. - * @member {number} [protectedItemsCount] Number of protected items in the - * backup engine. - * @member {number} [protectedServersCount] Number of protected servers in the - * backup engine. - * @member {number} [diskCount] Number of disks in the backup engine. - * @member {number} [usedDiskSpace] Diskspace used in the backup engine. - * @member {number} [availableDiskSpace] Diskspace currently available in the - * backup engine. - * @member {date} [refreshedAt] Last refresh time in the backup engine. - * @member {number} [azureProtectedInstances] Protected instances in the backup - * engine. - */ +*/ export interface BackupEngineExtendedInfo { + /** + * Database name of backup engine. + */ databaseName?: string; + /** + * Number of protected items in the backup engine. + */ protectedItemsCount?: number; + /** + * Number of protected servers in the backup engine. + */ protectedServersCount?: number; + /** + * Number of disks in the backup engine. + */ diskCount?: number; + /** + * Disk space used in the backup engine. + */ usedDiskSpace?: number; + /** + * Disk space currently available in the backup engine. + */ availableDiskSpace?: number; + /** + * Last refresh time in the backup engine. + */ refreshedAt?: Date; + /** + * Protected instances in the backup engine. + */ azureProtectedInstances?: number; } /** - * @class - * Initializes a new instance of the BackupEngineBaseResource class. - * @constructor - * The base backup engine class. All workload specific backup engines derive - * from this class. - * - * @member {object} [properties] BackupEngineBaseResource properties - * @member {string} [properties.friendlyName] Friendly name of the backup - * engine. - * @member {string} [properties.backupManagementType] Type of backup management - * for the backup engine. Possible values include: 'Invalid', 'AzureIaasVM', - * 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', - * 'AzureWorkload', 'DefaultBackup' - * @member {string} [properties.registrationStatus] Registration status of the - * backup engine with the Recovery Services Vault. - * @member {string} [properties.backupEngineState] Status of the backup engine - * with the Recovery Services Vault. = {Active/Deleting/DeleteFailed} - * @member {string} [properties.healthStatus] Backup status of the backup - * engine. - * @member {boolean} [properties.canReRegister] Flag indicating if the backup - * engine be registered, once already registered. - * @member {string} [properties.backupEngineId] ID of the backup engine. - * @member {string} [properties.dpmVersion] Backup engine version - * @member {string} [properties.azureBackupAgentVersion] Backup agent version - * @member {boolean} [properties.isAzureBackupAgentUpgradeAvailable] To check - * if backup agent upgrade available - * @member {boolean} [properties.isDpmUpgradeAvailable] To check if backup - * engine upgrade available - * @member {object} [properties.extendedInfo] Extended info of the backupengine - * @member {string} [properties.extendedInfo.databaseName] Database name of - * backup engine. - * @member {number} [properties.extendedInfo.protectedItemsCount] Number of - * protected items in the backup engine. - * @member {number} [properties.extendedInfo.protectedServersCount] Number of - * protected servers in the backup engine. - * @member {number} [properties.extendedInfo.diskCount] Number of disks in the - * backup engine. - * @member {number} [properties.extendedInfo.usedDiskSpace] Diskspace used in - * the backup engine. - * @member {number} [properties.extendedInfo.availableDiskSpace] Diskspace - * currently available in the backup engine. - * @member {date} [properties.extendedInfo.refreshedAt] Last refresh time in - * the backup engine. - * @member {number} [properties.extendedInfo.azureProtectedInstances] Protected - * instances in the backup engine. - * @member {string} [properties.backupEngineType] Polymorphic Discriminator - */ + * The base backup engine class. All workload specific backup engines derive from this class. +*/ export interface BackupEngineBaseResource extends Resource { + /** + * BackupEngineBaseResource properties + */ properties?: BackupEngineBase; } /** - * @class - * Initializes a new instance of the BackupRequestResource class. - * @constructor - * Base class for backup request. Workload-specific backup requests are derived - * from this class. - * - * @member {object} [properties] BackupRequestResource properties - * @member {string} [properties.objectType] Polymorphic Discriminator - */ + * Base class for backup request. Workload-specific backup requests are derived from this class. +*/ export interface BackupRequestResource extends Resource { + /** + * BackupRequestResource properties + */ properties?: BackupRequest; } /** - * @class - * Initializes a new instance of the BackupResourceConfig class. - * @constructor * The resource storage details. - * - * @member {string} [storageModelType] Storage type. Possible values include: - * 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [storageType] Storage type. Possible values include: - * 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [storageTypeState] Locked or Unlocked. Once a machine is - * registered against a resource, the storageTypeState is always Locked. - * Possible values include: 'Invalid', 'Locked', 'Unlocked' - */ +*/ export interface BackupResourceConfig { + /** + * Storage type. Possible values include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' + */ storageModelType?: string; + /** + * Storage type. Possible values include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' + */ storageType?: string; + /** + * Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is + * always Locked. Possible values include: 'Invalid', 'Locked', 'Unlocked' + */ storageTypeState?: string; } /** - * @class - * Initializes a new instance of the BackupResourceConfigResource class. - * @constructor * The resource storage details. - * - * @member {object} [properties] BackupResourceConfigResource properties - * @member {string} [properties.storageModelType] Storage type. Possible values - * include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [properties.storageType] Storage type. Possible values - * include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [properties.storageTypeState] Locked or Unlocked. Once a - * machine is registered against a resource, the storageTypeState is always - * Locked. Possible values include: 'Invalid', 'Locked', 'Unlocked' - */ +*/ export interface BackupResourceConfigResource extends Resource { + /** + * BackupResourceConfigResource properties + */ properties?: BackupResourceConfig; } /** - * @class - * Initializes a new instance of the BackupResourceVaultConfig class. - * @constructor * Backup resource vault config details. - * - * @member {string} [storageModelType] Storage type. Possible values include: - * 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [storageType] Storage type. Possible values include: - * 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [storageTypeState] Locked or Unlocked. Once a machine is - * registered against a resource, the storageTypeState is always Locked. - * Possible values include: 'Invalid', 'Locked', 'Unlocked' - * @member {string} [enhancedSecurityState] Enabled or Disabled. Possible - * values include: 'Invalid', 'Enabled', 'Disabled' - */ +*/ export interface BackupResourceVaultConfig { + /** + * Storage type. Possible values include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' + */ storageModelType?: string; + /** + * Storage type. Possible values include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' + */ storageType?: string; + /** + * Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is + * always Locked. Possible values include: 'Invalid', 'Locked', 'Unlocked' + */ storageTypeState?: string; + /** + * Enabled or Disabled. Possible values include: 'Invalid', 'Enabled', 'Disabled' + */ enhancedSecurityState?: string; } /** - * @class - * Initializes a new instance of the BackupResourceVaultConfigResource class. - * @constructor * Backup resource vault config details. - * - * @member {object} [properties] BackupResourceVaultConfigResource properties - * @member {string} [properties.storageModelType] Storage type. Possible values - * include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [properties.storageType] Storage type. Possible values - * include: 'Invalid', 'GeoRedundant', 'LocallyRedundant' - * @member {string} [properties.storageTypeState] Locked or Unlocked. Once a - * machine is registered against a resource, the storageTypeState is always - * Locked. Possible values include: 'Invalid', 'Locked', 'Unlocked' - * @member {string} [properties.enhancedSecurityState] Enabled or Disabled. - * Possible values include: 'Invalid', 'Enabled', 'Disabled' - */ +*/ export interface BackupResourceVaultConfigResource extends Resource { + /** + * BackupResourceVaultConfigResource properties + */ properties?: BackupResourceVaultConfig; } /** - * @class - * Initializes a new instance of the BEKDetails class. - * @constructor - * BEK is bitlocker encrpytion key. - * - * @member {string} [secretUrl] Secret is BEK. - * @member {string} [secretVaultId] ID of the Key Vault where this Secret is - * stored. - * @member {string} [secretData] BEK data. - */ + * BEK is bitlocker encryption key. +*/ export interface BEKDetails { + /** + * Secret is BEK. + */ secretUrl?: string; + /** + * ID of the Key Vault where this Secret is stored. + */ secretVaultId?: string; + /** + * BEK data. + */ secretData?: string; } /** - * @class - * Initializes a new instance of the BMSBackupEngineQueryObject class. - * @constructor * Query parameters to fetch list of backup engines. - * - * @member {string} [expand] attribute to add extended info - */ +*/ export interface BMSBackupEngineQueryObject { + /** + * attribute to add extended info + */ expand?: string; } /** - * @class - * Initializes a new instance of the BMSBackupEnginesQueryObject class. - * @constructor * Query parameters to fetch list of backup engines. - * - * @member {string} [backupManagementType] Backup management type for the - * backup engine. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', - * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [friendlyName] Friendly name of the backup engine. - * @member {string} [expand] Attribute to add extended info. - */ +*/ export interface BMSBackupEnginesQueryObject { + /** + * Backup management type for the backup engine. Possible values include: 'Invalid', + * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; + /** + * Friendly name of the backup engine. + */ friendlyName?: string; + /** + * Attribute to add extended info. + */ expand?: string; } /** - * @class - * Initializes a new instance of the BMSContainerQueryObject class. - * @constructor * The query filters that can be used with the list containers API. - * - * @member {string} backupManagementType Backup management type for this - * container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', - * 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [containerType] Type of container for filter. Possible - * values include: 'Invalid', 'Unknown', 'IaasVMContainer', - * 'IaasVMServiceContainer', 'DPMContainer', 'AzureBackupServerContainer', - * 'MABContainer', 'Cluster', 'AzureSqlContainer', 'Windows', 'VCenter', - * 'VMAppContainer', 'SQLAGWorkLoadContainer', 'StorageContainer', - * 'GenericContainer' - * @member {string} [backupEngineName] Backup engine name - * @member {string} [fabricName] Fabric name for filter - * @member {string} [status] Status of registration of this container with the - * Recovery Services Vault. - * @member {string} [friendlyName] Friendly name of this container. - */ +*/ export interface BMSContainerQueryObject { + /** + * Backup management type for this container. Possible values include: 'Invalid', 'AzureIaasVM', + * 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType: string; + /** + * Type of container for filter. Possible values include: 'Invalid', 'Unknown', + * 'IaasVMContainer', 'IaasVMServiceContainer', 'DPMContainer', 'AzureBackupServerContainer', + * 'MABContainer', 'Cluster', 'AzureSqlContainer', 'Windows', 'VCenter', 'VMAppContainer', + * 'SQLAGWorkLoadContainer', 'StorageContainer', 'GenericContainer' + */ containerType?: string; + /** + * Backup engine name + */ backupEngineName?: string; + /** + * Fabric name for filter + */ fabricName?: string; + /** + * Status of registration of this container with the Recovery Services Vault. + */ status?: string; + /** + * Friendly name of this container. + */ friendlyName?: string; } /** - * @class - * Initializes a new instance of the BMSContainersInquiryQueryObject class. - * @constructor * The query filters that can be used with the inquire container API. - * - * @member {string} [backupManagementType] Backup management type for this - * container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', - * 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [workloadType] Workload type for this container. Possible - * values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', - * 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', - * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' - */ +*/ export interface BMSContainersInquiryQueryObject { + /** + * Backup management type for this container. Possible values include: 'Invalid', 'AzureIaasVM', + * 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; + /** + * Workload type for this container. Possible values include: 'Invalid', 'VM', 'FileFolder', + * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', + * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' + */ workloadType?: string; } /** - * @class - * Initializes a new instance of the BMSPOQueryObject class. - * @constructor * Filters to list items that can be backed up. - * - * @member {string} [backupManagementType] Backup management type. Possible - * values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', - * 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup' - * @member {string} [workloadType] Workload type. Possible values include: - * 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', - * 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', - * 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' - * @member {string} [containerName] Full name of the container whose - * Protectable Objects should be returned. - * @member {string} [status] Backup status query parameter. - * @member {string} [friendlyName] Friendly name. - */ +*/ export interface BMSPOQueryObject { + /** + * Backup management type. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', + * 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup' + */ backupManagementType?: string; + /** + * Workload type. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', + * 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', + * 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' + */ workloadType?: string; + /** + * Full name of the container whose Protectable Objects should be returned. + */ containerName?: string; + /** + * Backup status query parameter. + */ status?: string; + /** + * Friendly name. + */ friendlyName?: string; } /** - * @class - * Initializes a new instance of the BMSRefreshContainersQueryObject class. - * @constructor * The query filters that can be used with the refresh container API. - * - * @member {string} [backupManagementType] Backup management type for this - * container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', - * 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - */ +*/ export interface BMSRefreshContainersQueryObject { + /** + * Backup management type for this container. Possible values include: 'Invalid', 'AzureIaasVM', + * 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', + * 'DefaultBackup' + */ backupManagementType?: string; } /** - * @class - * Initializes a new instance of the BMSRPQueryObject class. - * @constructor * Filters to list backup copies. - * - * @member {date} [startDate] Backup copies created after this time. - * @member {date} [endDate] Backup copies created before this time. - * @member {string} [restorePointQueryType] RestorePoint type. Possible values - * include: 'Invalid', 'Full', 'Log', 'Differential', 'FullAndDifferential', - * 'All' - * @member {boolean} [extendedInfo] In Get Recovery Point, it tells whether - * extended information about recovery point is asked. - */ +*/ export interface BMSRPQueryObject { + /** + * Backup copies created after this time. + */ startDate?: Date; + /** + * Backup copies created before this time. + */ endDate?: Date; + /** + * RestorePoint type. Possible values include: 'Invalid', 'Full', 'Log', 'Differential', + * 'FullAndDifferential', 'All' + */ restorePointQueryType?: string; + /** + * In Get Recovery Point, it tells whether extended information about recovery point is asked. + */ extendedInfo?: boolean; } /** - * @class - * Initializes a new instance of the BMSWorkloadItemQueryObject class. - * @constructor * Filters to list items that can be backed up. - * - * @member {string} [backupManagementType] Backup management type. Possible - * values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', - * 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup' - * @member {string} [workloadItemType] Workload Item type. Possible values - * include: 'Invalid', 'SQLInstance', 'SQLDataBase', 'SAPHanaSystem', - * 'SAPHanaDatabase' - * @member {string} [workloadType] Workload type. Possible values include: - * 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', - * 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', - * 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' - * @member {string} [protectionStatus] Backup status query parameter. Possible - * values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', - * 'ProtectionFailed' - */ +*/ export interface BMSWorkloadItemQueryObject { + /** + * Backup management type. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', + * 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup' + */ backupManagementType?: string; + /** + * Workload Item type. Possible values include: 'Invalid', 'SQLInstance', 'SQLDataBase', + * 'SAPHanaSystem', 'SAPHanaDatabase' + */ workloadItemType?: string; + /** + * Workload type. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', + * 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', + * 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' + */ workloadType?: string; + /** + * Backup status query parameter. Possible values include: 'Invalid', 'NotProtected', + * 'Protecting', 'Protected', 'ProtectionFailed' + */ protectionStatus?: string; } /** - * @class - * Initializes a new instance of the ClientScriptForConnect class. - * @constructor * Client script details for file / folder restore. - * - * @member {string} [scriptContent] File content of the client script for file - * / folder restore. - * @member {string} [scriptExtension] File extension of the client script for - * file / folder restore - .ps1 , .sh , etc. - * @member {string} [osType] OS type - Windows, Linux etc. for which this file - * / folder restore client script works. - * @member {string} [url] URL of Executable from where to source the content. - * If this is not null then ScriptContent should not be used - * @member {string} [scriptNameSuffix] Mandator suffix that should be added to - * the name of script that is given for download to user. - * If its null or empty then , ignore it. - */ +*/ export interface ClientScriptForConnect { + /** + * File content of the client script for file / folder restore. + */ scriptContent?: string; + /** + * File extension of the client script for file / folder restore - .ps1 , .sh , etc. + */ scriptExtension?: string; + /** + * OS type - Windows, Linux etc. for which this file / folder restore client script works. + */ osType?: string; + /** + * URL of Executable from where to source the content. If this is not null then ScriptContent + * should not be used + */ url?: string; + /** + * Mandator suffix that should be added to the name of script that is given for download to user. + * If its null or empty then , ignore it. + */ scriptNameSuffix?: string; } /** - * @class - * Initializes a new instance of the ContainerIdentityInfo class. - * @constructor * Container identity information - * - * @member {string} [uniqueName] Unique name of the container - * @member {string} [aadTenantId] Protection container identity - AAD Tenant - * @member {string} [servicePrincipalClientId] Protection container identity - - * AAD Service Principal - * @member {string} [audience] Protection container identity - Audience - */ +*/ export interface ContainerIdentityInfo { + /** + * Unique name of the container + */ uniqueName?: string; + /** + * Protection container identity - AAD Tenant + */ aadTenantId?: string; + /** + * Protection container identity - AAD Service Principal + */ servicePrincipalClientId?: string; + /** + * Protection container identity - Audience + */ audience?: string; } /** - * @class - * Initializes a new instance of the DpmBackupEngine class. - * @constructor * Data Protection Manager (DPM) specific backup engine. - * - */ +*/ export interface DpmBackupEngine extends BackupEngineBase { } /** - * @class - * Initializes a new instance of the DpmContainer class. - * @constructor * DPM workload-specific protection container. - * - * @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. - */ +*/ export interface DpmContainer extends ProtectionContainer { + /** + * Specifies whether the container is re-registrable. + */ canReRegister?: boolean; + /** + * ID of container. + */ containerId?: string; + /** + * Number of protected items in the BackupEngine + */ protectedItemCount?: number; + /** + * Backup engine Agent version + */ dpmAgentVersion?: string; + /** + * List of BackupEngines protecting the container + */ dpmServers?: string[]; + /** + * To check if upgrade available + */ upgradeAvailable?: boolean; + /** + * Protection status of the container. + */ protectionStatus?: string; + /** + * Extended Info of the container. + */ extendedInfo?: DPMContainerExtendedInfo; } /** - * @class - * Initializes a new instance of the GenericContainerExtendedInfo class. - * @constructor * Container extended information - * - * @member {string} [rawCertData] Public key of container cert - * @member {object} [containerIdentityInfo] Container identity information - * @member {string} [containerIdentityInfo.uniqueName] Unique name of the - * container - * @member {string} [containerIdentityInfo.aadTenantId] Protection container - * identity - AAD Tenant - * @member {string} [containerIdentityInfo.servicePrincipalClientId] Protection - * container identity - AAD Service Principal - * @member {string} [containerIdentityInfo.audience] Protection container - * identity - Audience - * @member {object} [serviceEndpoints] Azure Backup Service Endpoints for the - * container - */ +*/ export interface GenericContainerExtendedInfo { + /** + * Public key of container cert + */ rawCertData?: string; + /** + * Container identity information + */ containerIdentityInfo?: ContainerIdentityInfo; + /** + * Azure Backup Service Endpoints for the container + */ serviceEndpoints?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the GenericContainer class. - * @constructor * Base class for generic container of backup items - * - * @member {string} [fabricName] Name of the container's fabric - * @member {object} [extendedInformation] Extended information (not returned in - * List container API calls) - * @member {string} [extendedInformation.rawCertData] Public key of container - * cert - * @member {object} [extendedInformation.containerIdentityInfo] Container - * identity information - * @member {string} [extendedInformation.containerIdentityInfo.uniqueName] - * Unique name of the container - * @member {string} [extendedInformation.containerIdentityInfo.aadTenantId] - * Protection container identity - AAD Tenant - * @member {string} - * [extendedInformation.containerIdentityInfo.servicePrincipalClientId] - * Protection container identity - AAD Service Principal - * @member {string} [extendedInformation.containerIdentityInfo.audience] - * Protection container identity - Audience - * @member {object} [extendedInformation.serviceEndpoints] Azure Backup Service - * Endpoints for the container - */ +*/ export interface GenericContainer extends ProtectionContainer { + /** + * Name of the container's fabric + */ fabricName?: string; + /** + * Extended information (not returned in List container API calls) + */ extendedInformation?: GenericContainerExtendedInfo; } /** - * @class - * Initializes a new instance of the GenericRecoveryPoint class. - * @constructor * Generic backup copy. - * - * @member {string} [friendlyName] Friendly name of the backup copy. - * @member {string} [recoveryPointType] Type of the backup copy. - * @member {date} [recoveryPointTime] Time at which this backup copy was - * created. - * @member {string} [recoveryPointAdditionalInfo] Additional information - * associated with this backup copy. - */ +*/ export interface GenericRecoveryPoint extends RecoveryPoint { + /** + * Friendly name of the backup copy. + */ friendlyName?: string; + /** + * Type of the backup copy. + */ recoveryPointType?: string; + /** + * Time at which this backup copy was created. + */ recoveryPointTime?: Date; + /** + * Additional information associated with this backup copy. + */ recoveryPointAdditionalInfo?: string; } /** - * @class - * Initializes a new instance of the GetProtectedItemQueryObject class. - * @constructor * Filters to list backup items. - * - * @member {string} [expand] Specifies if the additional information should be - * provided for this item. - */ +*/ export interface GetProtectedItemQueryObject { + /** + * Specifies if the additional information should be provided for this item. + */ expand?: string; } /** - * @class - * Initializes a new instance of the IaasVMBackupRequest class. - * @constructor * IaaS VM workload-specific backup request. - * - * @member {date} [recoveryPointExpiryTimeInUTC] Backup copy will expire after - * the time specified (UTC). - */ +*/ export interface IaasVMBackupRequest extends BackupRequest { + /** + * Backup copy will expire after the time specified (UTC). + */ recoveryPointExpiryTimeInUTC?: Date; } /** - * @class - * Initializes a new instance of the ILRRequest class. - * @constructor * Parameters to restore file/folders API. - * - * @member {string} objectType Polymorphic Discriminator - */ +*/ export interface ILRRequest { + /** + * Polymorphic Discriminator + */ objectType: string; } /** - * @class - * Initializes a new instance of the IaasVMILRRegistrationRequest class. - * @constructor * Restore files/folders from a backup copy of IaaS VM. - * - * @member {string} [recoveryPointId] ID of the IaaS VM backup copy from where - * the files/folders have to be restored. - * @member {string} [virtualMachineId] Fully qualified ARM ID of the virtual - * machine whose the files / folders have to be restored. - * @member {string} [initiatorName] iSCSI initiator name. - * @member {boolean} [renewExistingRegistration] Whether to renew existing - * registration with the iSCSI server. - */ +*/ export interface IaasVMILRRegistrationRequest extends ILRRequest { + /** + * ID of the IaaS VM backup copy from where the files/folders have to be restored. + */ recoveryPointId?: string; + /** + * Fully qualified ARM ID of the virtual machine whose the files / folders have to be restored. + */ virtualMachineId?: string; + /** + * iSCSI initiator name. + */ initiatorName?: string; + /** + * Whether to renew existing registration with the iSCSI server. + */ renewExistingRegistration?: boolean; } /** - * @class - * Initializes a new instance of the KEKDetails class. - * @constructor * KEK is encryption key for BEK. - * - * @member {string} [keyUrl] Key is KEK. - * @member {string} [keyVaultId] Key Vault ID where this Key is stored. - * @member {string} [keyBackupData] KEK data. - */ +*/ export interface KEKDetails { + /** + * Key is KEK. + */ keyUrl?: string; + /** + * Key Vault ID where this Key is stored. + */ keyVaultId?: string; + /** + * KEK data. + */ keyBackupData?: string; } /** - * @class - * Initializes a new instance of the KeyAndSecretDetails class. - * @constructor * BEK is bitlocker key. * KEK is encryption key for BEK - * If the VM was encrypted then we will store follwing details : + * If the VM was encrypted then we will store following details : * 1. Secret(BEK) - Url + Backup Data + vaultId. * 2. Key(KEK) - Url + Backup Data + vaultId. * 3. EncryptionMechanism - * BEK and KEK can potentiallty have different vault ids. - * - * @member {object} [kekDetails] KEK is encryption key for BEK. - * @member {string} [kekDetails.keyUrl] Key is KEK. - * @member {string} [kekDetails.keyVaultId] Key Vault ID where this Key is - * stored. - * @member {string} [kekDetails.keyBackupData] KEK data. - * @member {object} [bekDetails] BEK is bitlocker encrpytion key. - * @member {string} [bekDetails.secretUrl] Secret is BEK. - * @member {string} [bekDetails.secretVaultId] ID of the Key Vault where this - * Secret is stored. - * @member {string} [bekDetails.secretData] BEK data. - * @member {string} [encryptionMechanism] Encryption mechanism: None/ - * SinglePass/ DoublePass - */ + * BEK and KEK can potentially have different vault ids. +*/ export interface KeyAndSecretDetails { + /** + * KEK is encryption key for BEK. + */ kekDetails?: KEKDetails; + /** + * BEK is bitlocker encryption key. + */ bekDetails?: BEKDetails; + /** + * Encryption mechanism: None/ SinglePass/ DoublePass + */ encryptionMechanism?: string; } /** - * @class - * Initializes a new instance of the RecoveryPointTierInformation class. - * @constructor * Recovery point tier information. - * - * @member {string} [type] Recovery point tier type. Possible values include: - * 'Invalid', 'InstantRP', 'HardenedRP' - * @member {string} [status] Recovery point tier status. Possible values - * include: 'Invalid', 'Valid', 'Disabled', 'Deleted' - */ +*/ export interface RecoveryPointTierInformation { + /** + * Recovery point tier type. Possible values include: 'Invalid', 'InstantRP', 'HardenedRP' + */ type?: string; + /** + * Recovery point tier status. Possible values include: 'Invalid', 'Valid', 'Disabled', 'Deleted' + */ status?: string; } /** - * @class - * Initializes a new instance of the IaasVMRecoveryPoint class. - * @constructor * IaaS VM workload specific backup copy. - * - * @member {string} [recoveryPointType] Type of the backup copy. - * @member {date} [recoveryPointTime] Time at which this backup copy was - * created. - * @member {string} [recoveryPointAdditionalInfo] Additional information - * associated with this backup copy. - * @member {string} [sourceVMStorageType] Storage type of the VM whose backup - * copy is created. - * @member {boolean} [isSourceVMEncrypted] Identifies whether the VM was - * encrypted when the backup copy is created. - * @member {object} [keyAndSecret] Required details for recovering an encrypted - * VM. Applicable only when IsSourceVMEncrypted is true. - * @member {object} [keyAndSecret.kekDetails] KEK is encryption key for BEK. - * @member {string} [keyAndSecret.kekDetails.keyUrl] Key is KEK. - * @member {string} [keyAndSecret.kekDetails.keyVaultId] Key Vault ID where - * this Key is stored. - * @member {string} [keyAndSecret.kekDetails.keyBackupData] KEK data. - * @member {object} [keyAndSecret.bekDetails] BEK is bitlocker encrpytion key. - * @member {string} [keyAndSecret.bekDetails.secretUrl] Secret is BEK. - * @member {string} [keyAndSecret.bekDetails.secretVaultId] ID of the Key Vault - * where this Secret is stored. - * @member {string} [keyAndSecret.bekDetails.secretData] BEK data. - * @member {string} [keyAndSecret.encryptionMechanism] Encryption mechanism: - * None/ SinglePass/ DoublePass - * @member {boolean} [isInstantIlrSessionActive] Is the session to recover - * items from this backup copy still active. - * @member {array} [recoveryPointTierDetails] Recovery point tier information. - * @member {boolean} [isManagedVirtualMachine] Whether VM is with Managed Disks - * @member {string} [virtualMachineSize] Virtual Machine Size - * @member {boolean} [originalStorageAccountOption] Original Storage Account - * Option - * @member {string} [osType] OS type - */ +*/ export interface IaasVMRecoveryPoint extends RecoveryPoint { + /** + * Type of the backup copy. + */ recoveryPointType?: string; + /** + * Time at which this backup copy was created. + */ recoveryPointTime?: Date; + /** + * Additional information associated with this backup copy. + */ recoveryPointAdditionalInfo?: string; + /** + * Storage type of the VM whose backup copy is created. + */ sourceVMStorageType?: string; + /** + * Identifies whether the VM was encrypted when the backup copy is created. + */ isSourceVMEncrypted?: boolean; + /** + * Required details for recovering an encrypted VM. Applicable only when IsSourceVMEncrypted is + * true. + */ keyAndSecret?: KeyAndSecretDetails; + /** + * Is the session to recover items from this backup copy still active. + */ isInstantIlrSessionActive?: boolean; + /** + * Recovery point tier information. + */ recoveryPointTierDetails?: RecoveryPointTierInformation[]; + /** + * Whether VM is with Managed Disks + */ isManagedVirtualMachine?: boolean; + /** + * Virtual Machine Size + */ virtualMachineSize?: string; + /** + * Original Storage Account Option + */ originalStorageAccountOption?: boolean; + /** + * OS type + */ osType?: string; } /** - * @class - * Initializes a new instance of the ILRRequestResource class. - * @constructor * Parameters to restore file/folders API. - * - * @member {object} [properties] ILRRequestResource properties - * @member {string} [properties.objectType] Polymorphic Discriminator - */ +*/ export interface ILRRequestResource extends Resource { + /** + * ILRRequestResource properties + */ properties?: ILRRequest; } /** - * @class - * Initializes a new instance of the InstantItemRecoveryTarget class. - * @constructor * Target details for file / folder restore. - * - * @member {array} [clientScripts] List of client scripts. - */ +*/ export interface InstantItemRecoveryTarget { + /** + * List of client scripts. + */ clientScripts?: ClientScriptForConnect[]; } /** - * @class - * Initializes a new instance of the MabContainerExtendedInfo class. - * @constructor * Additional information of the container. - * - * @member {date} [lastRefreshedAt] Time stamp when this container was - * refreshed. - * @member {string} [backupItemType] Type of backup items associated with this - * container. Possible values include: 'Invalid', 'VM', 'FileFolder', - * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', - * 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', - * 'SAPHanaDatabase' - * @member {array} [backupItems] List of backup items associated with this - * container. - * @member {string} [policyName] Backup policy associated with this container. - * @member {string} [lastBackupStatus] Latest backup status of this container. - */ +*/ export interface MabContainerExtendedInfo { + /** + * Time stamp when this container was refreshed. + */ lastRefreshedAt?: Date; + /** + * Type of backup items associated with this container. Possible values include: 'Invalid', 'VM', + * 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', + * 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' + */ backupItemType?: string; + /** + * List of backup items associated with this container. + */ backupItems?: string[]; + /** + * Backup policy associated with this container. + */ policyName?: string; + /** + * Latest backup status of this container. + */ lastBackupStatus?: string; } /** - * @class - * Initializes a new instance of the MABContainerHealthDetails class. - * @constructor * MAB workload-specific Health Details. - * - * @member {number} [code] Health Code - * @member {string} [title] Health Title - * @member {string} [message] Health Message - * @member {array} [recommendations] Health Recommended Actions - */ +*/ export interface MABContainerHealthDetails { + /** + * Health Code + */ code?: number; + /** + * Health Title + */ title?: string; + /** + * Health Message + */ message?: string; + /** + * Health Recommended Actions + */ recommendations?: string[]; } /** - * @class - * Initializes a new instance of the MabContainer class. - * @constructor * Container with items backed up using MAB backup engine. - * - * @member {boolean} [canReRegister] Can the container be registered one more - * time. - * @member {number} [containerId] ContainerID represents the container. - * @member {number} [protectedItemCount] Number of items backed up in this - * container. - * @member {string} [agentVersion] Agent version of this container. - * @member {object} [extendedInfo] Additional information for this container - * @member {date} [extendedInfo.lastRefreshedAt] Time stamp when this container - * was refreshed. - * @member {string} [extendedInfo.backupItemType] Type of backup items - * associated with this container. Possible values include: 'Invalid', 'VM', - * 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', - * 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', - * 'AzureFileShare', 'SAPHanaDatabase' - * @member {array} [extendedInfo.backupItems] List of backup items associated - * with this container. - * @member {string} [extendedInfo.policyName] Backup policy associated with - * this container. - * @member {string} [extendedInfo.lastBackupStatus] Latest backup status of - * this container. - * @member {array} [mabContainerHealthDetails] Health details on this mab - * container. - * @member {string} [containerHealthState] Health state of mab container. - */ +*/ export interface MabContainer extends ProtectionContainer { + /** + * Can the container be registered one more time. + */ canReRegister?: boolean; + /** + * ContainerID represents the container. + */ containerId?: number; + /** + * Number of items backed up in this container. + */ protectedItemCount?: number; + /** + * Agent version of this container. + */ agentVersion?: string; + /** + * Additional information for this container + */ extendedInfo?: MabContainerExtendedInfo; + /** + * Health details on this mab container. + */ mabContainerHealthDetails?: MABContainerHealthDetails[]; + /** + * Health state of mab container. + */ containerHealthState?: string; } /** - * @class - * Initializes a new instance of the OperationStatusError class. - * @constructor * Error information associated with operation status call. - * - * @member {string} [code] Error code of the operation failure. - * @member {string} [message] Error message displayed if the operation failure. - */ +*/ export interface OperationStatusError { + /** + * Error code of the operation failure. + */ code?: string; + /** + * Error message displayed if the operation failure. + */ message?: string; } /** - * @class - * Initializes a new instance of the OperationStatusExtendedInfo class. - * @constructor * Base class for additional information of operation status. - * - * @member {string} objectType Polymorphic Discriminator - */ +*/ export interface OperationStatusExtendedInfo { + /** + * Polymorphic Discriminator + */ objectType: string; } /** - * @class - * Initializes a new instance of the OperationStatus class. - * @constructor * Operation status. - * - * @member {string} [id] ID of the operation. - * @member {string} [name] Name of the operation. - * @member {string} [status] Operation status. Possible values include: - * 'Invalid', 'InProgress', 'Succeeded', 'Failed', 'Canceled' - * @member {date} [startTime] Operation start time. Format: ISO-8601. - * @member {date} [endTime] Operation end time. Format: ISO-8601. - * @member {object} [error] Error information related to this operation. - * @member {string} [error.code] Error code of the operation failure. - * @member {string} [error.message] Error message displayed if the operation - * failure. - * @member {object} [properties] Additional information associated with this - * operation. - * @member {string} [properties.objectType] Polymorphic Discriminator - */ +*/ export interface OperationStatus { + /** + * ID of the operation. + */ id?: string; + /** + * Name of the operation. + */ name?: string; + /** + * Operation status. Possible values include: 'Invalid', 'InProgress', 'Succeeded', 'Failed', + * 'Canceled' + */ status?: string; + /** + * Operation start time. Format: ISO-8601. + */ startTime?: Date; + /** + * Operation end time. Format: ISO-8601. + */ endTime?: Date; + /** + * Error information related to this operation. + */ error?: OperationStatusError; + /** + * Additional information associated with this operation. + */ properties?: OperationStatusExtendedInfo; } /** - * @class - * Initializes a new instance of the OperationStatusJobExtendedInfo class. - * @constructor * Operation status job extended info. - * - * @member {string} [jobId] ID of the job created for this protected item. - */ +*/ export interface OperationStatusJobExtendedInfo extends OperationStatusExtendedInfo { + /** + * ID of the job created for this protected item. + */ jobId?: string; } /** - * @class - * Initializes a new instance of the OperationStatusJobsExtendedInfo class. - * @constructor * Operation status extended info for list of jobs. - * - * @member {array} [jobIds] IDs of the jobs created for the protected item. - * @member {object} [failedJobsError] Stores all the failed jobs along with the - * corresponding error codes. - */ +*/ export interface OperationStatusJobsExtendedInfo extends OperationStatusExtendedInfo { + /** + * IDs of the jobs created for the protected item. + */ jobIds?: string[]; + /** + * Stores all the failed jobs along with the corresponding error codes. + */ failedJobsError?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the OperationStatusProvisionILRExtendedInfo class. - * @constructor * Operation status extended info for ILR provision action. - * - * @member {object} [recoveryTarget] Target details for file / folder restore. - * @member {array} [recoveryTarget.clientScripts] List of client scripts. - */ +*/ export interface OperationStatusProvisionILRExtendedInfo extends OperationStatusExtendedInfo { + /** + * Target details for file / folder restore. + */ recoveryTarget?: InstantItemRecoveryTarget; } /** - * @class - * Initializes a new instance of the ProtectableContainerResource class. - * @constructor * Protectable Container Class. - * - * @member {object} [properties] ProtectableContainerResource properties - * @member {string} [properties.friendlyName] Friendly name of the container. - * @member {string} [properties.backupManagementType] Type of backup - * managemenent for the container. Possible values include: 'Invalid', - * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', - * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' - * @member {string} [properties.healthStatus] Status of health of the - * container. - * @member {string} [properties.containerId] Fabric Id of the container such as - * ARM Id. - * @member {string} [properties.protectableContainerType] Polymorphic - * Discriminator - */ +*/ export interface ProtectableContainerResource extends Resource { + /** + * ProtectableContainerResource properties + */ properties?: ProtectableContainer; } /** - * @class - * Initializes a new instance of the ProtectionContainerResource class. - * @constructor - * Base class for container with backup items. Containers with specific - * workloads are derived from this class. - * - * @member {object} [properties] ProtectionContainerResource properties - * @member {string} [properties.friendlyName] Friendly name of the container. - * @member {string} [properties.backupManagementType] Type of backup - * managemenent for the container. Possible values include: 'Invalid', - * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', - * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' - * @member {string} [properties.registrationStatus] Status of registration of - * the container with the Recovery Services Vault. - * @member {string} [properties.healthStatus] Status of health of the - * container. - * @member {string} [properties.containerType] Polymorphic Discriminator - */ + * Base class for container with backup items. Containers with specific workloads are derived from + * this class. +*/ export interface ProtectionContainerResource extends Resource { + /** + * ProtectionContainerResource properties + */ properties?: ProtectionContainer; } /** - * @class - * Initializes a new instance of the RecoveryPointResource class. - * @constructor - * Base class for backup copies. Workload-specific backup copies are derived - * from this class. - * - * @member {object} [properties] RecoveryPointResource properties - * @member {string} [properties.objectType] Polymorphic Discriminator - */ + * Base class for backup copies. Workload-specific backup copies are derived from this class. +*/ export interface RecoveryPointResource extends Resource { + /** + * RecoveryPointResource properties + */ properties?: RecoveryPoint; } /** - * @class - * Initializes a new instance of the RestoreRequestResource class. - * @constructor - * Base class for restore request. Workload-specific restore requests are - * derived from this class. - * - * @member {object} [properties] RestoreRequestResource properties - * @member {string} [properties.objectType] Polymorphic Discriminator - */ + * Base class for restore request. Workload-specific restore requests are derived from this class. +*/ export interface RestoreRequestResource extends Resource { + /** + * RestoreRequestResource properties + */ properties?: RestoreRequest; } /** - * @class - * Initializes a new instance of the TokenInformation class. - * @constructor * The token information details. - * - * @member {string} [token] Token value. - * @member {number} [expiryTimeInUtcTicks] Expiry time of token. - * @member {string} [securityPIN] Security PIN - */ +*/ export interface TokenInformation { + /** + * Token value. + */ token?: string; + /** + * Expiry time of token. + */ expiryTimeInUtcTicks?: number; + /** + * Security PIN + */ securityPIN?: string; } /** - * @class - * Initializes a new instance of the WorkloadItemResource class. - * @constructor - * Base class for backup item. Workload-specific backup items are derived from - * this class. - * - * @member {object} [properties] WorkloadItemResource properties - * @member {string} [properties.backupManagementType] Type of backup - * managemenent to backup an item. - * @member {string} [properties.workloadType] Type of workload for the backup - * management - * @member {string} [properties.friendlyName] Friendly name of the backup item. - * @member {string} [properties.protectionState] State of the back up item. - * Possible values include: 'Invalid', 'NotProtected', 'Protecting', - * 'Protected', 'ProtectionFailed' - * @member {string} [properties.workloadItemType] Polymorphic Discriminator - */ + * Base class for backup item. Workload-specific backup items are derived from this class. +*/ export interface WorkloadItemResource extends Resource { + /** + * WorkloadItemResource properties + */ properties?: WorkloadItem; } /** - * @class - * Initializes a new instance of the WorkloadProtectableItemResource class. - * @constructor - * Base class for backup item. Workload-specific backup items are derived from - * this class. - * - * @member {object} [properties] WorkloadProtectableItemResource properties - * @member {string} [properties.backupManagementType] Type of backup - * managemenent to backup an item. - * @member {string} [properties.workloadType] Type of workload for the backup - * management - * @member {string} [properties.friendlyName] Friendly name of the backup item. - * @member {string} [properties.protectionState] State of the back up item. - * Possible values include: 'Invalid', 'NotProtected', 'Protecting', - * 'Protected', 'ProtectionFailed' - * @member {string} [properties.protectableItemType] Polymorphic Discriminator - */ + * Base class for backup item. Workload-specific backup items are derived from this class. +*/ export interface WorkloadProtectableItemResource extends Resource { + /** + * WorkloadProtectableItemResource properties + */ properties?: WorkloadProtectableItem; } /** - * @class - * Initializes a new instance of the ClientDiscoveryDisplay class. - * @constructor * Localized display information of an operation. - * - * @member {string} [provider] Name of the provider for display purposes - * @member {string} [resource] ResourceType for which this Operation can be - * performed. - * @member {string} [operation] Operations Name itself. - * @member {string} [description] Description of the operation having details - * of what operation is about. - */ +*/ export interface ClientDiscoveryDisplay { + /** + * Name of the provider for display purposes + */ provider?: string; + /** + * ResourceType for which this Operation can be performed. + */ resource?: string; + /** + * Operations Name itself. + */ operation?: string; + /** + * Description of the operation having details of what operation is about. + */ description?: string; } /** - * @class - * Initializes a new instance of the ClientDiscoveryForLogSpecification class. - * @constructor * Class to represent shoebox log specification in json client discovery. - * - * @member {string} [name] Name for shoebox log specification. - * @member {string} [displayName] Localized display name - * @member {string} [blobDuration] blob duration of shoebox log specification - */ +*/ export interface ClientDiscoveryForLogSpecification { + /** + * Name for shoebox log specification. + */ name?: string; + /** + * Localized display name + */ displayName?: string; + /** + * blob duration of shoebox log specification + */ blobDuration?: string; } /** - * @class - * Initializes a new instance of the ClientDiscoveryForServiceSpecification class. - * @constructor * Class to represent shoebox service specification in json client discovery. - * - * @member {array} [logSpecifications] List of log specifications of this - * operation. - */ +*/ export interface ClientDiscoveryForServiceSpecification { + /** + * List of log specifications of this operation. + */ logSpecifications?: ClientDiscoveryForLogSpecification[]; } /** - * @class - * Initializes a new instance of the ClientDiscoveryForProperties class. - * @constructor * Class to represent shoebox properties in json client discovery. - * - * @member {object} [serviceSpecification] Operation properties. - * @member {array} [serviceSpecification.logSpecifications] List of log - * specifications of this operation. - */ +*/ export interface ClientDiscoveryForProperties { + /** + * Operation properties. + */ serviceSpecification?: ClientDiscoveryForServiceSpecification; } /** - * @class - * Initializes a new instance of the ClientDiscoveryValueForSingleApi class. - * @constructor * Available operation details. - * - * @member {string} [name] Name of the Operation. - * @member {object} [display] Contains the localized display information for - * this particular operation - * @member {string} [display.provider] Name of the provider for display - * purposes - * @member {string} [display.resource] ResourceType for which this Operation - * can be performed. - * @member {string} [display.operation] Operations Name itself. - * @member {string} [display.description] Description of the operation having - * details of what operation is about. - * @member {string} [origin] The intended executor of the operation;governs the - * display of the operation in the RBAC UX and the audit logs UX - * @member {object} [properties] ShoeBox properties for the given operation. - * @member {object} [properties.serviceSpecification] Operation properties. - * @member {array} [properties.serviceSpecification.logSpecifications] List of - * log specifications of this operation. - */ +*/ export interface ClientDiscoveryValueForSingleApi { + /** + * Name of the Operation. + */ name?: string; + /** + * Contains the localized display information for this particular operation + */ display?: ClientDiscoveryDisplay; + /** + * The intended executor of the operation;governs the display of the operation in the RBAC UX and + * the audit logs UX + */ origin?: string; + /** + * ShoeBox properties for the given operation. + */ properties?: ClientDiscoveryForProperties; } - /** - * @class - * Initializes a new instance of the JobResourceList class. - * @constructor * List of Job resources - * - */ +*/ export interface JobResourceList extends Array { } /** - * @class - * Initializes a new instance of the ProtectionPolicyResourceList class. - * @constructor * List of ProtectionPolicy resources - * - */ +*/ export interface ProtectionPolicyResourceList extends Array { } /** - * @class - * Initializes a new instance of the ProtectedItemResourceList class. - * @constructor * List of ProtectedItem resources - * - */ +*/ export interface ProtectedItemResourceList extends Array { } /** - * @class - * Initializes a new instance of the ProtectionIntentResourceList class. - * @constructor * List of ProtectionIntent resources - * - */ +*/ export interface ProtectionIntentResourceList extends Array { } /** - * @class - * Initializes a new instance of the BackupManagementUsageList class. - * @constructor * Backup management usage for vault. - * - */ +*/ export interface BackupManagementUsageList extends Array { } /** - * @class - * Initializes a new instance of the BackupEngineBaseResourceList class. - * @constructor * List of BackupEngineBase resources - * - */ +*/ export interface BackupEngineBaseResourceList extends Array { } /** - * @class - * Initializes a new instance of the ProtectableContainerResourceList class. - * @constructor * List of ProtectableContainer resources - * - */ +*/ export interface ProtectableContainerResourceList extends Array { } /** - * @class - * Initializes a new instance of the WorkloadItemResourceList class. - * @constructor * List of WorkloadItem resources - * - */ +*/ export interface WorkloadItemResourceList extends Array { } /** - * @class - * Initializes a new instance of the RecoveryPointResourceList class. - * @constructor * List of RecoveryPoint resources - * - */ +*/ export interface RecoveryPointResourceList extends Array { } /** - * @class - * Initializes a new instance of the WorkloadProtectableItemResourceList class. - * @constructor * List of WorkloadProtectableItem resources - * - */ -export interface WorkloadProtectableItemResourceList extends Array { +*/ +export interface WorkloadProtectableItemResourceList extends Array +{ } /** - * @class - * Initializes a new instance of the ProtectionContainerResourceList class. - * @constructor * List of ProtectionContainer resources - * - */ +*/ export interface ProtectionContainerResourceList extends Array { } /** - * @class - * Initializes a new instance of the ClientDiscoveryResponse class. - * @constructor * Operations List response which contains list of available APIs. - * - * @member {string} [nextLink] Link to the next chunk of Response. - */ +*/ export interface ClientDiscoveryResponse extends Array { + /** + * Link to the next chunk of Response. + */ nextLink?: string; } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/inquiryInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/inquiryInfo.js index 05437d05d6..913bdf605f 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/inquiryInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/inquiryInfo.js @@ -17,15 +17,17 @@ class InquiryInfo { /** * Create a InquiryInfo. - * @member {string} [status] Inquiry Status for this container such as + * @property {string} [status] Inquiry Status for this container such as * InProgress | Failed | Succeeded - * @member {object} [errorDetail] Error Details if the Status is non-success. - * @member {string} [errorDetail.code] Error code. - * @member {string} [errorDetail.message] Error Message related to the Code. - * @member {array} [errorDetail.recommendations] List of recommendation + * @property {object} [errorDetail] Error Details if the Status is + * non-success. + * @property {string} [errorDetail.code] Error code. + * @property {string} [errorDetail.message] Error Message related to the + * Code. + * @property {array} [errorDetail.recommendations] List of recommendation * strings. - * @member {array} [inquiryDetails] Inquiry Details which will have workload - * specific details. + * @property {array} [inquiryDetails] Inquiry Details which will have + * workload specific details. * For e.g. - For SQL and oracle this will contain different details. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/inquiryValidation.js b/lib/services/recoveryServicesBackupManagement/lib/models/inquiryValidation.js index 40503748b5..8827c29dfa 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/inquiryValidation.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/inquiryValidation.js @@ -17,12 +17,13 @@ class InquiryValidation { /** * Create a InquiryValidation. - * @member {string} [status] Status for the Inquiry Validation. - * @member {object} [errorDetail] Error Detail in case the status is + * @property {string} [status] Status for the Inquiry Validation. + * @property {object} [errorDetail] Error Detail in case the status is * non-success. - * @member {string} [errorDetail.code] Error code. - * @member {string} [errorDetail.message] Error Message related to the Code. - * @member {array} [errorDetail.recommendations] List of recommendation + * @property {string} [errorDetail.code] Error code. + * @property {string} [errorDetail.message] Error Message related to the + * Code. + * @property {array} [errorDetail.recommendations] List of recommendation * strings. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/instantItemRecoveryTarget.js b/lib/services/recoveryServicesBackupManagement/lib/models/instantItemRecoveryTarget.js index 82468614ef..002a4e1bb3 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/instantItemRecoveryTarget.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/instantItemRecoveryTarget.js @@ -17,7 +17,7 @@ class InstantItemRecoveryTarget { /** * Create a InstantItemRecoveryTarget. - * @member {array} [clientScripts] List of client scripts. + * @property {array} [clientScripts] List of client scripts. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/job.js b/lib/services/recoveryServicesBackupManagement/lib/models/job.js index 585c78c3b3..0f32248cdc 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/job.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/job.js @@ -17,18 +17,18 @@ class Job { /** * Create a Job. - * @member {string} [entityFriendlyName] Friendly name of the entity on which - * the current job is executing. - * @member {string} [backupManagementType] Backup management type to execute - * the current job. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', - * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', - * 'DefaultBackup' - * @member {string} [operation] The operation name. - * @member {string} [status] Job status. - * @member {date} [startTime] The start time. - * @member {date} [endTime] The end time. - * @member {string} [activityId] ActivityId of job. - * @member {string} jobType Polymorphic Discriminator + * @property {string} [entityFriendlyName] Friendly name of the entity on + * which the current job is executing. + * @property {string} [backupManagementType] Backup management type to + * execute the current job. Possible values include: 'Invalid', + * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', + * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' + * @property {string} [operation] The operation name. + * @property {string} [status] Job status. + * @property {date} [startTime] The start time. + * @property {date} [endTime] The end time. + * @property {string} [activityId] ActivityId of job. + * @property {string} jobType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/jobQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/jobQueryObject.js index 5f1eb887cf..9b25f43e53 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/jobQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/jobQueryObject.js @@ -17,19 +17,20 @@ class JobQueryObject { /** * Create a JobQueryObject. - * @member {string} [status] Status of the job. Possible values include: + * @property {string} [status] Status of the job. Possible values include: * 'Invalid', 'InProgress', 'Completed', 'Failed', 'CompletedWithWarnings', * 'Cancelled', 'Cancelling' - * @member {string} [backupManagementType] Type of backup managmenent for the - * job. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', + * @property {string} [backupManagementType] Type of backup management for + * the job. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', * 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', * 'DefaultBackup' - * @member {string} [operation] Type of operation. Possible values include: + * @property {string} [operation] Type of operation. Possible values include: * 'Invalid', 'Register', 'UnRegister', 'ConfigureBackup', 'Backup', * 'Restore', 'DisableBackup', 'DeleteBackupData' - * @member {string} [jobId] JobID represents the job uniquely. - * @member {date} [startTime] Job has started at this time. Value is in UTC. - * @member {date} [endTime] Job has ended at this time. Value is in UTC. + * @property {string} [jobId] JobID represents the job uniquely. + * @property {date} [startTime] Job has started at this time. Value is in + * UTC. + * @property {date} [endTime] Job has ended at this time. Value is in UTC. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/jobResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/jobResource.js index f375dc0115..caeea65c5c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/jobResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/jobResource.js @@ -20,19 +20,19 @@ const models = require('./index'); class JobResource extends models['Resource'] { /** * Create a JobResource. - * @member {object} [properties] JobResource properties - * @member {string} [properties.entityFriendlyName] Friendly name of the + * @property {object} [properties] JobResource properties + * @property {string} [properties.entityFriendlyName] Friendly name of the * entity on which the current job is executing. - * @member {string} [properties.backupManagementType] Backup management type - * to execute the current job. Possible values include: 'Invalid', + * @property {string} [properties.backupManagementType] Backup management + * type to execute the current job. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' - * @member {string} [properties.operation] The operation name. - * @member {string} [properties.status] Job status. - * @member {date} [properties.startTime] The start time. - * @member {date} [properties.endTime] The end time. - * @member {string} [properties.activityId] ActivityId of job. - * @member {string} [properties.jobType] Polymorphic Discriminator + * @property {string} [properties.operation] The operation name. + * @property {string} [properties.status] Job status. + * @property {date} [properties.startTime] The start time. + * @property {date} [properties.endTime] The end time. + * @property {string} [properties.activityId] ActivityId of job. + * @property {string} [properties.jobType] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/kEKDetails.js b/lib/services/recoveryServicesBackupManagement/lib/models/kEKDetails.js index 2c36bdba40..5d09ca48a9 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/kEKDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/kEKDetails.js @@ -17,9 +17,9 @@ class KEKDetails { /** * Create a KEKDetails. - * @member {string} [keyUrl] Key is KEK. - * @member {string} [keyVaultId] Key Vault ID where this Key is stored. - * @member {string} [keyBackupData] KEK data. + * @property {string} [keyUrl] Key is KEK. + * @property {string} [keyVaultId] Key Vault ID where this Key is stored. + * @property {string} [keyBackupData] KEK data. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/keyAndSecretDetails.js b/lib/services/recoveryServicesBackupManagement/lib/models/keyAndSecretDetails.js index 31d74e55e5..571f5892cf 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/keyAndSecretDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/keyAndSecretDetails.js @@ -13,27 +13,27 @@ /** * BEK is bitlocker key. * KEK is encryption key for BEK - * If the VM was encrypted then we will store follwing details : + * If the VM was encrypted then we will store following details : * 1. Secret(BEK) - Url + Backup Data + vaultId. * 2. Key(KEK) - Url + Backup Data + vaultId. * 3. EncryptionMechanism - * BEK and KEK can potentiallty have different vault ids. + * BEK and KEK can potentially have different vault ids. * */ class KeyAndSecretDetails { /** * Create a KeyAndSecretDetails. - * @member {object} [kekDetails] KEK is encryption key for BEK. - * @member {string} [kekDetails.keyUrl] Key is KEK. - * @member {string} [kekDetails.keyVaultId] Key Vault ID where this Key is + * @property {object} [kekDetails] KEK is encryption key for BEK. + * @property {string} [kekDetails.keyUrl] Key is KEK. + * @property {string} [kekDetails.keyVaultId] Key Vault ID where this Key is * stored. - * @member {string} [kekDetails.keyBackupData] KEK data. - * @member {object} [bekDetails] BEK is bitlocker encrpytion key. - * @member {string} [bekDetails.secretUrl] Secret is BEK. - * @member {string} [bekDetails.secretVaultId] ID of the Key Vault where this - * Secret is stored. - * @member {string} [bekDetails.secretData] BEK data. - * @member {string} [encryptionMechanism] Encryption mechanism: None/ + * @property {string} [kekDetails.keyBackupData] KEK data. + * @property {object} [bekDetails] BEK is bitlocker encryption key. + * @property {string} [bekDetails.secretUrl] Secret is BEK. + * @property {string} [bekDetails.secretVaultId] ID of the Key Vault where + * this Secret is stored. + * @property {string} [bekDetails.secretData] BEK data. + * @property {string} [encryptionMechanism] Encryption mechanism: None/ * SinglePass/ DoublePass */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/logSchedulePolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/logSchedulePolicy.js index 4626cf6558..7e19a584b1 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/logSchedulePolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/logSchedulePolicy.js @@ -20,7 +20,7 @@ const models = require('./index'); class LogSchedulePolicy extends models['SchedulePolicy'] { /** * Create a LogSchedulePolicy. - * @member {number} [scheduleFrequencyInMins] Frequency of the log schedule + * @property {number} [scheduleFrequencyInMins] Frequency of the log schedule * operation of this policy in minutes. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/longTermRetentionPolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/longTermRetentionPolicy.js index e3b45da279..e5e73608d5 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/longTermRetentionPolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/longTermRetentionPolicy.js @@ -20,92 +20,93 @@ const models = require('./index'); class LongTermRetentionPolicy extends models['RetentionPolicy'] { /** * Create a LongTermRetentionPolicy. - * @member {object} [dailySchedule] Daily retention schedule of the + * @property {object} [dailySchedule] Daily retention schedule of the * protection policy. - * @member {array} [dailySchedule.retentionTimes] Retention times of + * @property {array} [dailySchedule.retentionTimes] Retention times of * retention policy. - * @member {object} [dailySchedule.retentionDuration] Retention duration of + * @property {object} [dailySchedule.retentionDuration] Retention duration of * retention Policy. - * @member {number} [dailySchedule.retentionDuration.count] Count of duration - * types. Retention duration is obtained by the counting the duration type - * Count times. + * @property {number} [dailySchedule.retentionDuration.count] Count of + * duration types. Retention duration is obtained by the counting the + * duration type Count times. * For example, when Count = 3 and DurationType = Weeks, retention duration * will be three weeks. - * @member {string} [dailySchedule.retentionDuration.durationType] Retention - * duration type of retention policy. Possible values include: 'Invalid', - * 'Days', 'Weeks', 'Months', 'Years' - * @member {object} [weeklySchedule] Weekly retention schedule of the + * @property {string} [dailySchedule.retentionDuration.durationType] + * Retention duration type of retention policy. Possible values include: + * 'Invalid', 'Days', 'Weeks', 'Months', 'Years' + * @property {object} [weeklySchedule] Weekly retention schedule of the * protection policy. - * @member {array} [weeklySchedule.daysOfTheWeek] List of days of week for + * @property {array} [weeklySchedule.daysOfTheWeek] List of days of week for * weekly retention policy. - * @member {array} [weeklySchedule.retentionTimes] Retention times of + * @property {array} [weeklySchedule.retentionTimes] Retention times of * retention policy. - * @member {object} [weeklySchedule.retentionDuration] Retention duration of - * retention Policy. - * @member {number} [weeklySchedule.retentionDuration.count] Count of + * @property {object} [weeklySchedule.retentionDuration] Retention duration + * of retention Policy. + * @property {number} [weeklySchedule.retentionDuration.count] Count of * duration types. Retention duration is obtained by the counting the * duration type Count times. * For example, when Count = 3 and DurationType = Weeks, retention duration * will be three weeks. - * @member {string} [weeklySchedule.retentionDuration.durationType] Retention - * duration type of retention policy. Possible values include: 'Invalid', - * 'Days', 'Weeks', 'Months', 'Years' - * @member {object} [monthlySchedule] Monthly retention schedule of the + * @property {string} [weeklySchedule.retentionDuration.durationType] + * Retention duration type of retention policy. Possible values include: + * 'Invalid', 'Days', 'Weeks', 'Months', 'Years' + * @property {object} [monthlySchedule] Monthly retention schedule of the * protection policy. - * @member {string} [monthlySchedule.retentionScheduleFormatType] Retention + * @property {string} [monthlySchedule.retentionScheduleFormatType] Retention * schedule format type for monthly retention policy. Possible values * include: 'Invalid', 'Daily', 'Weekly' - * @member {object} [monthlySchedule.retentionScheduleDaily] Daily retention - * format for monthly retention policy. - * @member {array} [monthlySchedule.retentionScheduleDaily.daysOfTheMonth] + * @property {object} [monthlySchedule.retentionScheduleDaily] Daily + * retention format for monthly retention policy. + * @property {array} [monthlySchedule.retentionScheduleDaily.daysOfTheMonth] * List of days of the month. - * @member {object} [monthlySchedule.retentionScheduleWeekly] Weekly + * @property {object} [monthlySchedule.retentionScheduleWeekly] Weekly * retention format for monthly retention policy. - * @member {array} [monthlySchedule.retentionScheduleWeekly.daysOfTheWeek] + * @property {array} [monthlySchedule.retentionScheduleWeekly.daysOfTheWeek] * List of days of the week. - * @member {array} [monthlySchedule.retentionScheduleWeekly.weeksOfTheMonth] - * List of weeks of month. - * @member {array} [monthlySchedule.retentionTimes] Retention times of + * @property {array} + * [monthlySchedule.retentionScheduleWeekly.weeksOfTheMonth] List of weeks of + * month. + * @property {array} [monthlySchedule.retentionTimes] Retention times of * retention policy. - * @member {object} [monthlySchedule.retentionDuration] Retention duration of - * retention Policy. - * @member {number} [monthlySchedule.retentionDuration.count] Count of + * @property {object} [monthlySchedule.retentionDuration] Retention duration + * of retention Policy. + * @property {number} [monthlySchedule.retentionDuration.count] Count of * duration types. Retention duration is obtained by the counting the * duration type Count times. * For example, when Count = 3 and DurationType = Weeks, retention duration * will be three weeks. - * @member {string} [monthlySchedule.retentionDuration.durationType] + * @property {string} [monthlySchedule.retentionDuration.durationType] * Retention duration type of retention policy. Possible values include: * 'Invalid', 'Days', 'Weeks', 'Months', 'Years' - * @member {object} [yearlySchedule] Yearly retention schedule of the + * @property {object} [yearlySchedule] Yearly retention schedule of the * protection policy. - * @member {string} [yearlySchedule.retentionScheduleFormatType] Retention + * @property {string} [yearlySchedule.retentionScheduleFormatType] Retention * schedule format for yearly retention policy. Possible values include: * 'Invalid', 'Daily', 'Weekly' - * @member {array} [yearlySchedule.monthsOfYear] List of months of year of + * @property {array} [yearlySchedule.monthsOfYear] List of months of year of * yearly retention policy. - * @member {object} [yearlySchedule.retentionScheduleDaily] Daily retention + * @property {object} [yearlySchedule.retentionScheduleDaily] Daily retention * format for yearly retention policy. - * @member {array} [yearlySchedule.retentionScheduleDaily.daysOfTheMonth] + * @property {array} [yearlySchedule.retentionScheduleDaily.daysOfTheMonth] * List of days of the month. - * @member {object} [yearlySchedule.retentionScheduleWeekly] Weekly retention - * format for yearly retention policy. - * @member {array} [yearlySchedule.retentionScheduleWeekly.daysOfTheWeek] + * @property {object} [yearlySchedule.retentionScheduleWeekly] Weekly + * retention format for yearly retention policy. + * @property {array} [yearlySchedule.retentionScheduleWeekly.daysOfTheWeek] * List of days of the week. - * @member {array} [yearlySchedule.retentionScheduleWeekly.weeksOfTheMonth] + * @property {array} [yearlySchedule.retentionScheduleWeekly.weeksOfTheMonth] * List of weeks of month. - * @member {array} [yearlySchedule.retentionTimes] Retention times of + * @property {array} [yearlySchedule.retentionTimes] Retention times of * retention policy. - * @member {object} [yearlySchedule.retentionDuration] Retention duration of - * retention Policy. - * @member {number} [yearlySchedule.retentionDuration.count] Count of + * @property {object} [yearlySchedule.retentionDuration] Retention duration + * of retention Policy. + * @property {number} [yearlySchedule.retentionDuration.count] Count of * duration types. Retention duration is obtained by the counting the * duration type Count times. * For example, when Count = 3 and DurationType = Weeks, retention duration * will be three weeks. - * @member {string} [yearlySchedule.retentionDuration.durationType] Retention - * duration type of retention policy. Possible values include: 'Invalid', - * 'Days', 'Weeks', 'Months', 'Years' + * @property {string} [yearlySchedule.retentionDuration.durationType] + * Retention duration type of retention policy. Possible values include: + * 'Invalid', 'Days', 'Weeks', 'Months', 'Years' */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/mABContainerHealthDetails.js b/lib/services/recoveryServicesBackupManagement/lib/models/mABContainerHealthDetails.js index 3e6257334f..c2d69e0bc1 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/mABContainerHealthDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/mABContainerHealthDetails.js @@ -17,10 +17,10 @@ class MABContainerHealthDetails { /** * Create a MABContainerHealthDetails. - * @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() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/mabContainer.js b/lib/services/recoveryServicesBackupManagement/lib/models/mabContainer.js index 3c7f0a4359..5b7acf1e55 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/mabContainer.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/mabContainer.js @@ -20,29 +20,30 @@ const models = require('./index'); class MabContainer extends models['ProtectionContainer'] { /** * Create a MabContainer. - * @member {boolean} [canReRegister] Can the container be registered one more - * time. - * @member {number} [containerId] ContainerID represents the container. - * @member {number} [protectedItemCount] Number of items backed up in this + * @property {boolean} [canReRegister] Can the container be registered one + * more time. + * @property {number} [containerId] ContainerID represents the container. + * @property {number} [protectedItemCount] Number of items backed up in this * container. - * @member {string} [agentVersion] Agent version of this container. - * @member {object} [extendedInfo] Additional information for this container - * @member {date} [extendedInfo.lastRefreshedAt] Time stamp when this + * @property {string} [agentVersion] Agent version of this container. + * @property {object} [extendedInfo] Additional information for this + * container + * @property {date} [extendedInfo.lastRefreshedAt] Time stamp when this * container was refreshed. - * @member {string} [extendedInfo.backupItemType] Type of backup items + * @property {string} [extendedInfo.backupItemType] Type of backup items * associated with this container. Possible values include: 'Invalid', 'VM', * 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', * 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', * 'AzureFileShare', 'SAPHanaDatabase' - * @member {array} [extendedInfo.backupItems] List of backup items associated - * with this container. - * @member {string} [extendedInfo.policyName] Backup policy associated with + * @property {array} [extendedInfo.backupItems] List of backup items + * associated with this container. + * @property {string} [extendedInfo.policyName] Backup policy associated with * this container. - * @member {string} [extendedInfo.lastBackupStatus] Latest backup status of + * @property {string} [extendedInfo.lastBackupStatus] Latest backup status of * this container. - * @member {array} [mabContainerHealthDetails] Health details on this mab + * @property {array} [mabContainerHealthDetails] Health details on this mab * container. - * @member {string} [containerHealthState] Health state of mab container. + * @property {string} [containerHealthState] Health state of mab container. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/mabContainerExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/mabContainerExtendedInfo.js index 23121103e9..e9359011bd 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/mabContainerExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/mabContainerExtendedInfo.js @@ -17,18 +17,18 @@ class MabContainerExtendedInfo { /** * Create a MabContainerExtendedInfo. - * @member {date} [lastRefreshedAt] Time stamp when this container was + * @property {date} [lastRefreshedAt] Time stamp when this container was * refreshed. - * @member {string} [backupItemType] Type of backup items associated with + * @property {string} [backupItemType] Type of backup items associated with * this container. Possible values include: 'Invalid', 'VM', 'FileFolder', * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', * 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', * 'AzureFileShare', 'SAPHanaDatabase' - * @member {array} [backupItems] List of backup items associated with this + * @property {array} [backupItems] List of backup items associated with this * container. - * @member {string} [policyName] Backup policy associated with this + * @property {string} [policyName] Backup policy associated with this * container. - * @member {string} [lastBackupStatus] Latest backup status of this + * @property {string} [lastBackupStatus] Latest backup status of this * container. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/mabErrorInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/mabErrorInfo.js index de32b42828..22ed9c0e9e 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/mabErrorInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/mabErrorInfo.js @@ -17,8 +17,8 @@ class MabErrorInfo { /** * Create a MabErrorInfo. - * @member {string} [errorString] Localized error string. - * @member {array} [recommendations] List of localized recommendations. + * @property {string} [errorString] Localized error string. + * @property {array} [recommendations] List of localized recommendations. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/mabFileFolderProtectedItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/mabFileFolderProtectedItem.js index c0357c38f2..cf8d9d7d7f 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/mabFileFolderProtectedItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/mabFileFolderProtectedItem.js @@ -20,24 +20,24 @@ const models = require('./index'); class MabFileFolderProtectedItem extends models['ProtectedItem'] { /** * Create a MabFileFolderProtectedItem. - * @member {string} [friendlyName] Friendly name of this backup item. - * @member {string} [computerName] Name of the computer associated with this - * backup item. - * @member {string} [lastBackupStatus] Status of last backup operation. - * @member {string} [protectionState] Protected, ProtectionStopped, IRPending - * or ProtectionError - * @member {boolean} [isScheduledForDeferredDelete] Specifies if the item is - * scheduled for deferred deletion. - * @member {number} [deferredDeleteSyncTimeInUTC] Sync time for deferred + * @property {string} [friendlyName] Friendly name of this backup item. + * @property {string} [computerName] Name of the computer associated with + * this backup item. + * @property {string} [lastBackupStatus] Status of last backup operation. + * @property {string} [protectionState] Protected, ProtectionStopped, + * IRPending or ProtectionError + * @property {boolean} [isScheduledForDeferredDelete] Specifies if the item + * is scheduled for deferred deletion. + * @property {number} [deferredDeleteSyncTimeInUTC] Sync time for deferred * deletion. - * @member {object} [extendedInfo] Additional information with this backup + * @property {object} [extendedInfo] Additional information with this backup * item. - * @member {date} [extendedInfo.lastRefreshedAt] Last time when the agent + * @property {date} [extendedInfo.lastRefreshedAt] Last time when the agent * data synced to service. - * @member {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy + * @property {date} [extendedInfo.oldestRecoveryPoint] The oldest backup copy * available. - * @member {number} [extendedInfo.recoveryPointCount] Number of backup copies - * associated with the backup item. + * @property {number} [extendedInfo.recoveryPointCount] Number of backup + * copies associated with the backup item. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/mabFileFolderProtectedItemExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/mabFileFolderProtectedItemExtendedInfo.js index a601fd9e8e..114ed6dc2b 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/mabFileFolderProtectedItemExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/mabFileFolderProtectedItemExtendedInfo.js @@ -17,10 +17,10 @@ class MabFileFolderProtectedItemExtendedInfo { /** * Create a MabFileFolderProtectedItemExtendedInfo. - * @member {date} [lastRefreshedAt] Last time when the agent data synced to + * @property {date} [lastRefreshedAt] Last time when the agent data synced to * service. - * @member {date} [oldestRecoveryPoint] The oldest backup copy available. - * @member {number} [recoveryPointCount] Number of backup copies associated + * @property {date} [oldestRecoveryPoint] The oldest backup copy available. + * @property {number} [recoveryPointCount] Number of backup copies associated * with the backup item. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/mabJob.js b/lib/services/recoveryServicesBackupManagement/lib/models/mabJob.js index 780e532df3..b3e8ffd8aa 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/mabJob.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/mabJob.js @@ -20,25 +20,25 @@ const models = require('./index'); class MabJob extends models['Job'] { /** * Create a MabJob. - * @member {moment.duration} [duration] Time taken by job to run. - * @member {array} [actionsInfo] The state/actions applicable on jobs like + * @property {moment.duration} [duration] Time taken by job to run. + * @property {array} [actionsInfo] The state/actions applicable on jobs like * cancel/retry. - * @member {string} [mabServerName] Name of server protecting the DS. - * @member {string} [mabServerType] Server type of MAB container. Possible + * @property {string} [mabServerName] Name of server protecting the DS. + * @property {string} [mabServerType] Server type of MAB container. Possible * values include: 'Invalid', 'Unknown', 'IaasVMContainer', * 'IaasVMServiceContainer', 'DPMContainer', 'AzureBackupServerContainer', * 'MABContainer', 'Cluster', 'AzureSqlContainer', 'Windows', 'VCenter', * 'VMAppContainer', 'SQLAGWorkLoadContainer', 'StorageContainer', * 'GenericContainer' - * @member {string} [workloadType] Workload type of backup item. Possible + * @property {string} [workloadType] Workload type of backup item. Possible * values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', * 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' - * @member {array} [errorDetails] The errors. - * @member {object} [extendedInfo] Additional information on the job. - * @member {array} [extendedInfo.tasksList] List of tasks for this job. - * @member {object} [extendedInfo.propertyBag] The job properties. - * @member {string} [extendedInfo.dynamicErrorMessage] Non localized error + * @property {array} [errorDetails] The errors. + * @property {object} [extendedInfo] Additional information on the job. + * @property {array} [extendedInfo.tasksList] List of tasks for this job. + * @property {object} [extendedInfo.propertyBag] The job properties. + * @property {string} [extendedInfo.dynamicErrorMessage] Non localized error * message specific to this job. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/mabJobExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/mabJobExtendedInfo.js index ab3eb85eb0..7a437648a3 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/mabJobExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/mabJobExtendedInfo.js @@ -17,9 +17,9 @@ class MabJobExtendedInfo { /** * Create a MabJobExtendedInfo. - * @member {array} [tasksList] List of tasks for this job. - * @member {object} [propertyBag] The job properties. - * @member {string} [dynamicErrorMessage] Non localized error message + * @property {array} [tasksList] List of tasks for this job. + * @property {object} [propertyBag] The job properties. + * @property {string} [dynamicErrorMessage] Non localized error message * specific to this job. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/mabJobTaskDetails.js b/lib/services/recoveryServicesBackupManagement/lib/models/mabJobTaskDetails.js index 8b28bfe034..012c7487db 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/mabJobTaskDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/mabJobTaskDetails.js @@ -17,11 +17,11 @@ class MabJobTaskDetails { /** * Create a MabJobTaskDetails. - * @member {string} [taskId] The task display name. - * @member {date} [startTime] The start time. - * @member {date} [endTime] The end time. - * @member {moment.duration} [duration] Time elapsed for task. - * @member {string} [status] The status. + * @property {string} [taskId] The task display name. + * @property {date} [startTime] The start time. + * @property {date} [endTime] The end time. + * @property {moment.duration} [duration] Time elapsed for task. + * @property {string} [status] The status. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/mabProtectionPolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/mabProtectionPolicy.js index 25a64ae23d..4114b29ccb 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/mabProtectionPolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/mabProtectionPolicy.js @@ -20,11 +20,11 @@ const models = require('./index'); class MabProtectionPolicy extends models['ProtectionPolicy'] { /** * Create a MabProtectionPolicy. - * @member {object} [schedulePolicy] Backup schedule of backup policy. - * @member {string} [schedulePolicy.schedulePolicyType] Polymorphic + * @property {object} [schedulePolicy] Backup schedule of backup policy. + * @property {string} [schedulePolicy.schedulePolicyType] Polymorphic * Discriminator - * @member {object} [retentionPolicy] Retention policy details. - * @member {string} [retentionPolicy.retentionPolicyType] Polymorphic + * @property {object} [retentionPolicy] Retention policy details. + * @property {string} [retentionPolicy.retentionPolicyType] Polymorphic * Discriminator */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/monthlyRetentionSchedule.js b/lib/services/recoveryServicesBackupManagement/lib/models/monthlyRetentionSchedule.js index 0679f0af4d..5f0bccb2a9 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/monthlyRetentionSchedule.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/monthlyRetentionSchedule.js @@ -17,30 +17,30 @@ class MonthlyRetentionSchedule { /** * Create a MonthlyRetentionSchedule. - * @member {string} [retentionScheduleFormatType] Retention schedule format + * @property {string} [retentionScheduleFormatType] Retention schedule format * type for monthly retention policy. Possible values include: 'Invalid', * 'Daily', 'Weekly' - * @member {object} [retentionScheduleDaily] Daily retention format for + * @property {object} [retentionScheduleDaily] Daily retention format for * monthly retention policy. - * @member {array} [retentionScheduleDaily.daysOfTheMonth] List of days of + * @property {array} [retentionScheduleDaily.daysOfTheMonth] List of days of * the month. - * @member {object} [retentionScheduleWeekly] Weekly retention format for + * @property {object} [retentionScheduleWeekly] Weekly retention format for * monthly retention policy. - * @member {array} [retentionScheduleWeekly.daysOfTheWeek] List of days of + * @property {array} [retentionScheduleWeekly.daysOfTheWeek] List of days of * the week. - * @member {array} [retentionScheduleWeekly.weeksOfTheMonth] List of weeks of - * month. - * @member {array} [retentionTimes] Retention times of retention policy. - * @member {object} [retentionDuration] Retention duration of retention + * @property {array} [retentionScheduleWeekly.weeksOfTheMonth] List of weeks + * of month. + * @property {array} [retentionTimes] Retention times of retention policy. + * @property {object} [retentionDuration] Retention duration of retention * Policy. - * @member {number} [retentionDuration.count] Count of duration types. + * @property {number} [retentionDuration.count] Count of duration types. * Retention duration is obtained by the counting the duration type Count * times. * For example, when Count = 3 and DurationType = Weeks, retention duration * will be three weeks. - * @member {string} [retentionDuration.durationType] Retention duration type - * of retention policy. Possible values include: 'Invalid', 'Days', 'Weeks', - * 'Months', 'Years' + * @property {string} [retentionDuration.durationType] Retention duration + * type of retention policy. Possible values include: 'Invalid', 'Days', + * 'Weeks', 'Months', 'Years' */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/nameInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/nameInfo.js index 7e8b0754af..1c922add6b 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/nameInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/nameInfo.js @@ -17,8 +17,8 @@ class NameInfo { /** * Create a NameInfo. - * @member {string} [value] Value of usage. - * @member {string} [localizedValue] Localized value of usage. + * @property {string} [value] Value of usage. + * @property {string} [localizedValue] Localized value of usage. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/operationResultInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/operationResultInfo.js index 7df3b9f7b4..dd7c846068 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/operationResultInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/operationResultInfo.js @@ -20,7 +20,7 @@ const models = require('./index'); class OperationResultInfo extends models['OperationResultInfoBase'] { /** * Create a OperationResultInfo. - * @member {array} [jobList] List of jobs created by this operation. + * @property {array} [jobList] List of jobs created by this operation. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/operationResultInfoBase.js b/lib/services/recoveryServicesBackupManagement/lib/models/operationResultInfoBase.js index b63a7db5ac..3b6cb96e82 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/operationResultInfoBase.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/operationResultInfoBase.js @@ -17,7 +17,7 @@ class OperationResultInfoBase { /** * Create a OperationResultInfoBase. - * @member {string} objectType Polymorphic Discriminator + * @property {string} objectType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/operationResultInfoBaseResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/operationResultInfoBaseResource.js index 8ddc91c9aa..dbc7320231 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/operationResultInfoBaseResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/operationResultInfoBaseResource.js @@ -20,8 +20,8 @@ const models = require('./index'); class OperationResultInfoBaseResource extends models['OperationWorkerResponse'] { /** * Create a OperationResultInfoBaseResource. - * @member {object} [operation] OperationResultInfoBaseResource operation - * @member {string} [operation.objectType] Polymorphic Discriminator + * @property {object} [operation] OperationResultInfoBaseResource operation + * @property {string} [operation.objectType] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/operationStatus.js b/lib/services/recoveryServicesBackupManagement/lib/models/operationStatus.js index 1cbe2d7a90..fbbcf0fa3c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/operationStatus.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/operationStatus.js @@ -17,19 +17,19 @@ class OperationStatus { /** * Create a OperationStatus. - * @member {string} [id] ID of the operation. - * @member {string} [name] Name of the operation. - * @member {string} [status] Operation status. Possible values include: + * @property {string} [id] ID of the operation. + * @property {string} [name] Name of the operation. + * @property {string} [status] Operation status. Possible values include: * 'Invalid', 'InProgress', 'Succeeded', 'Failed', 'Canceled' - * @member {date} [startTime] Operation start time. Format: ISO-8601. - * @member {date} [endTime] Operation end time. Format: ISO-8601. - * @member {object} [error] Error information related to this operation. - * @member {string} [error.code] Error code of the operation failure. - * @member {string} [error.message] Error message displayed if the operation - * failure. - * @member {object} [properties] Additional information associated with this - * operation. - * @member {string} [properties.objectType] Polymorphic Discriminator + * @property {date} [startTime] Operation start time. Format: ISO-8601. + * @property {date} [endTime] Operation end time. Format: ISO-8601. + * @property {object} [error] Error information related to this operation. + * @property {string} [error.code] Error code of the operation failure. + * @property {string} [error.message] Error message displayed if the + * operation failure. + * @property {object} [properties] Additional information associated with + * this operation. + * @property {string} [properties.objectType] Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusError.js b/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusError.js index 3a1729fc8a..a2b28dfbcc 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusError.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusError.js @@ -17,8 +17,8 @@ class OperationStatusError { /** * Create a OperationStatusError. - * @member {string} [code] Error code of the operation failure. - * @member {string} [message] Error message displayed if the operation + * @property {string} [code] Error code of the operation failure. + * @property {string} [message] Error message displayed if the operation * failure. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusExtendedInfo.js index d213d8bb50..60c7effd77 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusExtendedInfo.js @@ -17,7 +17,7 @@ class OperationStatusExtendedInfo { /** * Create a OperationStatusExtendedInfo. - * @member {string} objectType Polymorphic Discriminator + * @property {string} objectType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusJobExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusJobExtendedInfo.js index 67b91c4a8b..4db8aa5ee5 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusJobExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusJobExtendedInfo.js @@ -20,7 +20,7 @@ const models = require('./index'); class OperationStatusJobExtendedInfo extends models['OperationStatusExtendedInfo'] { /** * Create a OperationStatusJobExtendedInfo. - * @member {string} [jobId] ID of the job created for this protected item. + * @property {string} [jobId] ID of the job created for this protected item. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusJobsExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusJobsExtendedInfo.js index b234aff3c3..4d4a1b4ff8 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusJobsExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusJobsExtendedInfo.js @@ -20,8 +20,8 @@ const models = require('./index'); class OperationStatusJobsExtendedInfo extends models['OperationStatusExtendedInfo'] { /** * Create a OperationStatusJobsExtendedInfo. - * @member {array} [jobIds] IDs of the jobs created for the protected item. - * @member {object} [failedJobsError] Stores all the failed jobs along with + * @property {array} [jobIds] IDs of the jobs created for the protected item. + * @property {object} [failedJobsError] Stores all the failed jobs along with * the corresponding error codes. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusProvisionILRExtendedInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusProvisionILRExtendedInfo.js index c3c4763dc8..8012c62601 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusProvisionILRExtendedInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/operationStatusProvisionILRExtendedInfo.js @@ -20,9 +20,9 @@ const models = require('./index'); class OperationStatusProvisionILRExtendedInfo extends models['OperationStatusExtendedInfo'] { /** * Create a OperationStatusProvisionILRExtendedInfo. - * @member {object} [recoveryTarget] Target details for file / folder + * @property {object} [recoveryTarget] Target details for file / folder * restore. - * @member {array} [recoveryTarget.clientScripts] List of client scripts. + * @property {array} [recoveryTarget.clientScripts] List of client scripts. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/operationWorkerResponse.js b/lib/services/recoveryServicesBackupManagement/lib/models/operationWorkerResponse.js index 89267fb928..f42391df6a 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/operationWorkerResponse.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/operationWorkerResponse.js @@ -17,21 +17,21 @@ class OperationWorkerResponse { /** * Create a OperationWorkerResponse. - * @member {string} [statusCode] HTTP Status Code of the operation. Possible - * values include: 'Continue', 'SwitchingProtocols', 'OK', 'Created', - * 'Accepted', 'NonAuthoritativeInformation', 'NoContent', 'ResetContent', - * 'PartialContent', 'MultipleChoices', 'Ambiguous', 'MovedPermanently', - * 'Moved', 'Found', 'Redirect', 'SeeOther', 'RedirectMethod', 'NotModified', - * 'UseProxy', 'Unused', 'TemporaryRedirect', 'RedirectKeepVerb', - * 'BadRequest', 'Unauthorized', 'PaymentRequired', 'Forbidden', 'NotFound', - * 'MethodNotAllowed', 'NotAcceptable', 'ProxyAuthenticationRequired', - * 'RequestTimeout', 'Conflict', 'Gone', 'LengthRequired', - * 'PreconditionFailed', 'RequestEntityTooLarge', 'RequestUriTooLong', - * 'UnsupportedMediaType', 'RequestedRangeNotSatisfiable', - * 'ExpectationFailed', 'UpgradeRequired', 'InternalServerError', - * 'NotImplemented', 'BadGateway', 'ServiceUnavailable', 'GatewayTimeout', - * 'HttpVersionNotSupported' - * @member {object} [headers] HTTP headers associated with this operation. + * @property {string} [statusCode] HTTP Status Code of the operation. + * Possible values include: 'Continue', 'SwitchingProtocols', 'OK', + * 'Created', 'Accepted', 'NonAuthoritativeInformation', 'NoContent', + * 'ResetContent', 'PartialContent', 'MultipleChoices', 'Ambiguous', + * 'MovedPermanently', 'Moved', 'Found', 'Redirect', 'SeeOther', + * 'RedirectMethod', 'NotModified', 'UseProxy', 'Unused', + * 'TemporaryRedirect', 'RedirectKeepVerb', 'BadRequest', 'Unauthorized', + * 'PaymentRequired', 'Forbidden', 'NotFound', 'MethodNotAllowed', + * 'NotAcceptable', 'ProxyAuthenticationRequired', 'RequestTimeout', + * 'Conflict', 'Gone', 'LengthRequired', 'PreconditionFailed', + * 'RequestEntityTooLarge', 'RequestUriTooLong', 'UnsupportedMediaType', + * 'RequestedRangeNotSatisfiable', 'ExpectationFailed', 'UpgradeRequired', + * 'InternalServerError', 'NotImplemented', 'BadGateway', + * 'ServiceUnavailable', 'GatewayTimeout', 'HttpVersionNotSupported' + * @property {object} [headers] HTTP headers associated with this operation. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/pointInTimeRange.js b/lib/services/recoveryServicesBackupManagement/lib/models/pointInTimeRange.js index 28af23dddc..4e98672a5b 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/pointInTimeRange.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/pointInTimeRange.js @@ -17,8 +17,9 @@ class PointInTimeRange { /** * Create a PointInTimeRange. - * @member {date} [startTime] Start time of the time range for log recovery. - * @member {date} [endTime] End time of the time range for log recovery. + * @property {date} [startTime] Start time of the time range for log + * recovery. + * @property {date} [endTime] End time of the time range for log recovery. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/preBackupValidation.js b/lib/services/recoveryServicesBackupManagement/lib/models/preBackupValidation.js index d527fd291d..c3077e1bcd 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/preBackupValidation.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/preBackupValidation.js @@ -17,12 +17,12 @@ class PreBackupValidation { /** * Create a PreBackupValidation. - * @member {string} [status] Status of protectable item, i.e. + * @property {string} [status] Status of protectable item, i.e. * InProgress,Succeeded,Failed. Possible values include: 'Invalid', * 'Success', 'Failed' - * @member {string} [code] Error code of protectable item - * @member {string} [message] Message corresponding to the error code for the - * protectable item + * @property {string} [code] Error code of protectable item + * @property {string} [message] Message corresponding to the error code for + * the protectable item */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/preValidateEnableBackupRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/preValidateEnableBackupRequest.js index 17036bd129..0cfdb25b1c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/preValidateEnableBackupRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/preValidateEnableBackupRequest.js @@ -22,13 +22,13 @@ class PreValidateEnableBackupRequest { /** * Create a PreValidateEnableBackupRequest. - * @member {string} [resourceType] ProtectedItem Type- VM, SqlDataBase, + * @property {string} [resourceType] ProtectedItem Type- VM, SqlDataBase, * AzureFileShare etc. Possible values include: 'Invalid', 'VM', * 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', * 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', * 'AzureFileShare', 'SAPHanaDatabase' - * @member {string} [resourceId] ARM Virtual Machine Id - * @member {string} [properties] Configuration of VM if any needs to be + * @property {string} [resourceId] ARM Virtual Machine Id + * @property {string} [properties] Configuration of VM if any needs to be * validated like OS type etc */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/preValidateEnableBackupResponse.js b/lib/services/recoveryServicesBackupManagement/lib/models/preValidateEnableBackupResponse.js index c36e2273c5..45bb45a0fc 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/preValidateEnableBackupResponse.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/preValidateEnableBackupResponse.js @@ -17,15 +17,16 @@ class PreValidateEnableBackupResponse { /** * Create a PreValidateEnableBackupResponse. - * @member {string} [status] Validation Status. Possible values include: + * @property {string} [status] Validation Status. Possible values include: * 'Invalid', 'Succeeded', 'Failed' - * @member {string} [errorCode] Response error code - * @member {string} [errorMessage] Response error message - * @member {string} [recommendation] Recommended action for user - * @member {string} [containerName] Specifies the product specific container - * name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required + * @property {string} [errorCode] Response error code + * @property {string} [errorMessage] Response error message + * @property {string} [recommendation] Recommended action for user + * @property {string} [containerName] Specifies the product specific + * container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This + * is required * for portal - * @member {string} [protectedItemName] Specifies the product specific ds + * @property {string} [protectedItemName] Specifies the product specific ds * name. E.g. vm;iaasvmcontainer;rgname;vmname. This is required for portal */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectableContainer.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectableContainer.js index 8441742dbb..4401ec2312 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectableContainer.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectableContainer.js @@ -17,14 +17,15 @@ class ProtectableContainer { /** * Create a ProtectableContainer. - * @member {string} [friendlyName] Friendly name of the container. - * @member {string} [backupManagementType] Type of backup managemenent for + * @property {string} [friendlyName] Friendly name of the container. + * @property {string} [backupManagementType] Type of backup management for * the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', * 'DefaultBackup' - * @member {string} [healthStatus] Status of health of the container. - * @member {string} [containerId] Fabric Id of the container such as ARM Id. - * @member {string} protectableContainerType Polymorphic Discriminator + * @property {string} [healthStatus] Status of health of the container. + * @property {string} [containerId] Fabric Id of the container such as ARM + * Id. + * @property {string} protectableContainerType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectableContainerResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectableContainerResource.js index b0209ce318..105f8fa219 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectableContainerResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectableContainerResource.js @@ -20,17 +20,18 @@ const models = require('./index'); class ProtectableContainerResource extends models['Resource'] { /** * Create a ProtectableContainerResource. - * @member {object} [properties] ProtectableContainerResource properties - * @member {string} [properties.friendlyName] Friendly name of the container. - * @member {string} [properties.backupManagementType] Type of backup - * managemenent for the container. Possible values include: 'Invalid', + * @property {object} [properties] ProtectableContainerResource properties + * @property {string} [properties.friendlyName] Friendly name of the + * container. + * @property {string} [properties.backupManagementType] Type of backup + * management for the container. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' - * @member {string} [properties.healthStatus] Status of health of the + * @property {string} [properties.healthStatus] Status of health of the * container. - * @member {string} [properties.containerId] Fabric Id of the container such - * as ARM Id. - * @member {string} [properties.protectableContainerType] Polymorphic + * @property {string} [properties.containerId] Fabric Id of the container + * such as ARM Id. + * @property {string} [properties.protectableContainerType] Polymorphic * Discriminator */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectedItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectedItem.js index 57a2b0d01b..f13db20580 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectedItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectedItem.js @@ -17,27 +17,27 @@ class ProtectedItem { /** * Create a ProtectedItem. - * @member {string} [backupManagementType] Type of backup managemenent for + * @property {string} [backupManagementType] Type of backup management for * the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', * 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', * 'AzureWorkload', 'DefaultBackup' - * @member {string} [workloadType] Type of workload this item represents. + * @property {string} [workloadType] Type of workload this item represents. * Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', * 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' - * @member {string} [containerName] Unique name of container - * @member {string} [sourceResourceId] ARM ID of the resource to be backed + * @property {string} [containerName] Unique name of container + * @property {string} [sourceResourceId] ARM ID of the resource to be backed * up. - * @member {string} [policyId] ID of the backup policy with which this item + * @property {string} [policyId] ID of the backup policy with which this item * is backed up. - * @member {date} [lastRecoveryPoint] Timestamp when the last (latest) backup - * copy was created for this backup item. - * @member {string} [backupSetName] Name of the backup set the backup item + * @property {date} [lastRecoveryPoint] Timestamp when the last (latest) + * backup copy was created for this backup item. + * @property {string} [backupSetName] Name of the backup set the backup item * belongs to - * @member {string} [createMode] Create mode to indicate recovery of existing - * soft deleted data source or creation of new data source. Possible values - * include: 'Invalid', 'Default', 'Recover' - * @member {string} protectedItemType Polymorphic Discriminator + * @property {string} [createMode] Create mode to indicate recovery of + * existing soft deleted data source or creation of new data source. Possible + * values include: 'Invalid', 'Default', 'Recover' + * @property {string} protectedItemType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectedItemQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectedItemQueryObject.js index 7c87a7c71c..0d20f2dab3 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectedItemQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectedItemQueryObject.js @@ -17,24 +17,24 @@ class ProtectedItemQueryObject { /** * Create a ProtectedItemQueryObject. - * @member {string} [healthState] Health State for the backed up item. + * @property {string} [healthState] Health State for the backed up item. * Possible values include: 'Passed', 'ActionRequired', 'ActionSuggested', * 'Invalid' - * @member {string} [backupManagementType] Backup management type for the + * @property {string} [backupManagementType] Backup management type for the * backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', * 'DefaultBackup' - * @member {string} [itemType] Type of workload this item represents. + * @property {string} [itemType] Type of workload this item represents. * Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', * 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' - * @member {string} [policyName] Backup policy name associated with the + * @property {string} [policyName] Backup policy name associated with the * backup item. - * @member {string} [containerName] Name of the container. - * @member {string} [backupEngineName] Backup Engine name - * @member {string} [friendlyName] Friendly name of protected item - * @member {string} [fabricName] Name of the fabric. - * @member {string} [backupSetName] Name of the backup set. + * @property {string} [containerName] Name of the container. + * @property {string} [backupEngineName] Backup Engine name + * @property {string} [friendlyName] Friendly name of protected item + * @property {string} [fabricName] Name of the fabric. + * @property {string} [backupSetName] Name of the backup set. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectedItemResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectedItemResource.js index c948d1b13e..667beffab7 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectedItemResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectedItemResource.js @@ -20,29 +20,30 @@ const models = require('./index'); class ProtectedItemResource extends models['Resource'] { /** * Create a ProtectedItemResource. - * @member {object} [properties] ProtectedItemResource properties - * @member {string} [properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', + * @property {object} [properties] ProtectedItemResource properties + * @property {string} [properties.backupManagementType] Type of backup + * management for the backed up item. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' - * @member {string} [properties.workloadType] Type of workload this item + * @property {string} [properties.workloadType] Type of workload this item * represents. Possible values include: 'Invalid', 'VM', 'FileFolder', * 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', * 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', * 'AzureFileShare', 'SAPHanaDatabase' - * @member {string} [properties.containerName] Unique name of container - * @member {string} [properties.sourceResourceId] ARM ID of the resource to + * @property {string} [properties.containerName] Unique name of container + * @property {string} [properties.sourceResourceId] ARM ID of the resource to * be backed up. - * @member {string} [properties.policyId] ID of the backup policy with which - * this item is backed up. - * @member {date} [properties.lastRecoveryPoint] Timestamp when the last + * @property {string} [properties.policyId] ID of the backup policy with + * which this item is backed up. + * @property {date} [properties.lastRecoveryPoint] Timestamp when the last * (latest) backup copy was created for this backup item. - * @member {string} [properties.backupSetName] Name of the backup set the + * @property {string} [properties.backupSetName] Name of the backup set the * backup item belongs to - * @member {string} [properties.createMode] Create mode to indicate recovery - * of existing soft deleted data source or creation of new data source. - * Possible values include: 'Invalid', 'Default', 'Recover' - * @member {string} [properties.protectedItemType] Polymorphic Discriminator + * @property {string} [properties.createMode] Create mode to indicate + * recovery of existing soft deleted data source or creation of new data + * source. Possible values include: 'Invalid', 'Default', 'Recover' + * @property {string} [properties.protectedItemType] Polymorphic + * Discriminator */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectionContainer.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectionContainer.js index d7a7502130..92117de70b 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectionContainer.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectionContainer.js @@ -18,15 +18,15 @@ class ProtectionContainer { /** * Create a ProtectionContainer. - * @member {string} [friendlyName] Friendly name of the container. - * @member {string} [backupManagementType] Type of backup managemenent for + * @property {string} [friendlyName] Friendly name of the container. + * @property {string} [backupManagementType] Type of backup management for * the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', * 'DefaultBackup' - * @member {string} [registrationStatus] Status of registration of the + * @property {string} [registrationStatus] Status of registration of the * container with the Recovery Services Vault. - * @member {string} [healthStatus] Status of health of the container. - * @member {string} containerType Polymorphic Discriminator + * @property {string} [healthStatus] Status of health of the container. + * @property {string} containerType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectionContainerResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectionContainerResource.js index 7cc7d3bc17..5b1c45e4db 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectionContainerResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectionContainerResource.js @@ -21,17 +21,18 @@ const models = require('./index'); class ProtectionContainerResource extends models['Resource'] { /** * Create a ProtectionContainerResource. - * @member {object} [properties] ProtectionContainerResource properties - * @member {string} [properties.friendlyName] Friendly name of the container. - * @member {string} [properties.backupManagementType] Type of backup - * managemenent for the container. Possible values include: 'Invalid', + * @property {object} [properties] ProtectionContainerResource properties + * @property {string} [properties.friendlyName] Friendly name of the + * container. + * @property {string} [properties.backupManagementType] Type of backup + * management for the container. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' - * @member {string} [properties.registrationStatus] Status of registration of - * the container with the Recovery Services Vault. - * @member {string} [properties.healthStatus] Status of health of the + * @property {string} [properties.registrationStatus] Status of registration + * of the container with the Recovery Services Vault. + * @property {string} [properties.healthStatus] Status of health of the * container. - * @member {string} [properties.containerType] Polymorphic Discriminator + * @property {string} [properties.containerType] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectionIntent.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectionIntent.js index e938d8c613..f721f3d070 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectionIntent.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectionIntent.js @@ -17,20 +17,20 @@ class ProtectionIntent { /** * Create a ProtectionIntent. - * @member {string} [backupManagementType] Type of backup managemenent for + * @property {string} [backupManagementType] Type of backup management for * the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', * 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', * 'AzureWorkload', 'DefaultBackup' - * @member {string} [sourceResourceId] ARM ID of the resource to be backed + * @property {string} [sourceResourceId] ARM ID of the resource to be backed * up. - * @member {string} [itemId] ID of the item which is getting protected, In + * @property {string} [itemId] ID of the item which is getting protected, In * case of Azure Vm , it is ProtectedItemId - * @member {string} [policyId] ID of the backup policy with which this item + * @property {string} [policyId] ID of the backup policy with which this item * is backed up. - * @member {string} [protectionState] Backup state of this backup item. + * @property {string} [protectionState] Backup state of this backup item. * Possible values include: 'Invalid', 'NotProtected', 'Protecting', * 'Protected', 'ProtectionFailed' - * @member {string} protectionIntentItemType Polymorphic Discriminator + * @property {string} protectionIntentItemType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectionIntentQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectionIntentQueryObject.js index 446f0f67fe..a871cf7d97 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectionIntentQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectionIntentQueryObject.js @@ -17,15 +17,15 @@ class ProtectionIntentQueryObject { /** * Create a ProtectionIntentQueryObject. - * @member {string} [backupManagementType] Backup management type for the + * @property {string} [backupManagementType] Backup management type for the * backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', * 'DefaultBackup' - * @member {string} [itemType] Type of workload this item represents. + * @property {string} [itemType] Type of workload this item represents. * Possible values include: 'Invalid', 'SQLInstance', * 'SQLAvailabilityGroupContainer' - * @member {string} [parentName] Parent name of the intent - * @member {string} [itemName] Item name of the intent + * @property {string} [parentName] Parent name of the intent + * @property {string} [itemName] Item name of the intent */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectionIntentResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectionIntentResource.js index 043569ef5b..5325dd6b04 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectionIntentResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectionIntentResource.js @@ -20,21 +20,21 @@ const models = require('./index'); class ProtectionIntentResource extends models['Resource'] { /** * Create a ProtectionIntentResource. - * @member {object} [properties] ProtectionIntentResource properties - * @member {string} [properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', + * @property {object} [properties] ProtectionIntentResource properties + * @property {string} [properties.backupManagementType] Type of backup + * management for the backed up item. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' - * @member {string} [properties.sourceResourceId] ARM ID of the resource to + * @property {string} [properties.sourceResourceId] ARM ID of the resource to * be backed up. - * @member {string} [properties.itemId] ID of the item which is getting + * @property {string} [properties.itemId] ID of the item which is getting * protected, In case of Azure Vm , it is ProtectedItemId - * @member {string} [properties.policyId] ID of the backup policy with which - * this item is backed up. - * @member {string} [properties.protectionState] Backup state of this backup - * item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', - * 'Protected', 'ProtectionFailed' - * @member {string} [properties.protectionIntentItemType] Polymorphic + * @property {string} [properties.policyId] ID of the backup policy with + * which this item is backed up. + * @property {string} [properties.protectionState] Backup state of this + * backup item. Possible values include: 'Invalid', 'NotProtected', + * 'Protecting', 'Protected', 'ProtectionFailed' + * @property {string} [properties.protectionIntentItemType] Polymorphic * Discriminator */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectionPolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectionPolicy.js index 362465b8c9..459eac0fb8 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectionPolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectionPolicy.js @@ -18,9 +18,9 @@ class ProtectionPolicy { /** * Create a ProtectionPolicy. - * @member {number} [protectedItemsCount] Number of items associated with + * @property {number} [protectedItemsCount] Number of items associated with * this policy. - * @member {string} backupManagementType Polymorphic Discriminator + * @property {string} backupManagementType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectionPolicyQueryObject.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectionPolicyQueryObject.js index a4b74896cd..130d5c4080 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectionPolicyQueryObject.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectionPolicyQueryObject.js @@ -17,12 +17,12 @@ class ProtectionPolicyQueryObject { /** * Create a ProtectionPolicyQueryObject. - * @member {string} [backupManagementType] Backup management type for the + * @property {string} [backupManagementType] Backup management type for the * backup policy. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', * 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', * 'DefaultBackup' - * @member {string} [fabricName] Fabric name for filter - * @member {string} [workloadType] Workload type for the backup policy. + * @property {string} [fabricName] Fabric name for filter + * @property {string} [workloadType] Workload type for the backup policy. * Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', * 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', * 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase' diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/protectionPolicyResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/protectionPolicyResource.js index baff2c2311..5baa83c240 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/protectionPolicyResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/protectionPolicyResource.js @@ -21,10 +21,10 @@ const models = require('./index'); class ProtectionPolicyResource extends models['Resource'] { /** * Create a ProtectionPolicyResource. - * @member {object} [properties] ProtectionPolicyResource properties - * @member {number} [properties.protectedItemsCount] Number of items + * @property {object} [properties] ProtectionPolicyResource properties + * @property {number} [properties.protectedItemsCount] Number of items * associated with this policy. - * @member {string} [properties.backupManagementType] Polymorphic + * @property {string} [properties.backupManagementType] Polymorphic * Discriminator */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/recoveryPoint.js b/lib/services/recoveryServicesBackupManagement/lib/models/recoveryPoint.js index 4bf461660e..98124bfe47 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/recoveryPoint.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/recoveryPoint.js @@ -18,7 +18,7 @@ class RecoveryPoint { /** * Create a RecoveryPoint. - * @member {string} objectType Polymorphic Discriminator + * @property {string} objectType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/recoveryPointResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/recoveryPointResource.js index 274f7f7791..1e780b067f 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/recoveryPointResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/recoveryPointResource.js @@ -21,8 +21,8 @@ const models = require('./index'); class RecoveryPointResource extends models['Resource'] { /** * Create a RecoveryPointResource. - * @member {object} [properties] RecoveryPointResource properties - * @member {string} [properties.objectType] Polymorphic Discriminator + * @property {object} [properties] RecoveryPointResource properties + * @property {string} [properties.objectType] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/recoveryPointTierInformation.js b/lib/services/recoveryServicesBackupManagement/lib/models/recoveryPointTierInformation.js index 05dd671e2f..4895386574 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/recoveryPointTierInformation.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/recoveryPointTierInformation.js @@ -17,9 +17,9 @@ class RecoveryPointTierInformation { /** * Create a RecoveryPointTierInformation. - * @member {string} [type] Recovery point tier type. Possible values include: - * 'Invalid', 'InstantRP', 'HardenedRP' - * @member {string} [status] Recovery point tier status. Possible values + * @property {string} [type] Recovery point tier type. Possible values + * include: 'Invalid', 'InstantRP', 'HardenedRP' + * @property {string} [status] Recovery point tier status. Possible values * include: 'Invalid', 'Valid', 'Disabled', 'Deleted' */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/resource.js b/lib/services/recoveryServicesBackupManagement/lib/models/resource.js index 953e4368f6..4da94e0c66 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/resource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/resource.js @@ -20,14 +20,14 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] Resource Id represents the complete path to the + * @property {string} [id] Resource Id represents the complete path to the * resource. - * @member {string} [name] Resource name associated with the resource. - * @member {string} [type] Resource type represents the complete path of the - * form Namespace/ResourceType/ResourceType/... - * @member {string} [location] Resource location. - * @member {object} [tags] Resource tags. - * @member {string} [eTag] Optional ETag. + * @property {string} [name] Resource name associated with the resource. + * @property {string} [type] Resource type represents the complete path of + * the form Namespace/ResourceType/ResourceType/... + * @property {string} [location] Resource location. + * @property {object} [tags] Resource tags. + * @property {string} [eTag] Optional ETag. */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/resourceList.js b/lib/services/recoveryServicesBackupManagement/lib/models/resourceList.js index 48ab995fad..17be8f917a 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/resourceList.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/resourceList.js @@ -17,7 +17,7 @@ class ResourceList { /** * Create a ResourceList. - * @member {string} [nextLink] The uri to fetch the next page of resources. + * @property {string} [nextLink] The uri to fetch the next page of resources. * Call ListNext() fetches next page of resources. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/restoreFileSpecs.js b/lib/services/recoveryServicesBackupManagement/lib/models/restoreFileSpecs.js index f18d8282b4..f701e8969b 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/restoreFileSpecs.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/restoreFileSpecs.js @@ -17,10 +17,10 @@ class RestoreFileSpecs { /** * Create a RestoreFileSpecs. - * @member {string} [path] Source File/Folder path - * @member {string} [fileSpecType] Indicates what the Path variable stands + * @property {string} [path] Source File/Folder path + * @property {string} [fileSpecType] Indicates what the Path variable stands * for - * @member {string} [targetFolderPath] Destination folder path in target + * @property {string} [targetFolderPath] Destination folder path in target * FileShare */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/restoreRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/restoreRequest.js index 9ded58546c..e65633e8ed 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/restoreRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/restoreRequest.js @@ -18,7 +18,7 @@ class RestoreRequest { /** * Create a RestoreRequest. - * @member {string} objectType Polymorphic Discriminator + * @property {string} objectType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/restoreRequestResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/restoreRequestResource.js index 2f3980b2d8..3993a66862 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/restoreRequestResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/restoreRequestResource.js @@ -21,8 +21,8 @@ const models = require('./index'); class RestoreRequestResource extends models['Resource'] { /** * Create a RestoreRequestResource. - * @member {object} [properties] RestoreRequestResource properties - * @member {string} [properties.objectType] Polymorphic Discriminator + * @property {object} [properties] RestoreRequestResource properties + * @property {string} [properties.objectType] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/retentionDuration.js b/lib/services/recoveryServicesBackupManagement/lib/models/retentionDuration.js index 8fb203dc6d..eed7f81dfa 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/retentionDuration.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/retentionDuration.js @@ -17,11 +17,11 @@ class RetentionDuration { /** * Create a RetentionDuration. - * @member {number} [count] Count of duration types. Retention duration is + * @property {number} [count] Count of duration types. Retention duration is * obtained by the counting the duration type Count times. * For example, when Count = 3 and DurationType = Weeks, retention duration * will be three weeks. - * @member {string} [durationType] Retention duration type of retention + * @property {string} [durationType] Retention duration type of retention * policy. Possible values include: 'Invalid', 'Days', 'Weeks', 'Months', * 'Years' */ diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/retentionPolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/retentionPolicy.js index 9ef40ea8ef..1a83802e9e 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/retentionPolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/retentionPolicy.js @@ -17,7 +17,7 @@ class RetentionPolicy { /** * Create a RetentionPolicy. - * @member {string} retentionPolicyType Polymorphic Discriminator + * @property {string} retentionPolicyType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/sQLDataDirectory.js b/lib/services/recoveryServicesBackupManagement/lib/models/sQLDataDirectory.js index f0ec92386c..7f13f40913 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/sQLDataDirectory.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/sQLDataDirectory.js @@ -17,10 +17,10 @@ class SQLDataDirectory { /** * Create a SQLDataDirectory. - * @member {string} [type] Type of data directory mapping. Possible values + * @property {string} [type] Type of data directory mapping. Possible values * include: 'Invalid', 'Data', 'Log' - * @member {string} [path] File path - * @member {string} [logicalName] Logical name of the file + * @property {string} [path] File path + * @property {string} [logicalName] Logical name of the file */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/sQLDataDirectoryMapping.js b/lib/services/recoveryServicesBackupManagement/lib/models/sQLDataDirectoryMapping.js index 8922fb91c9..f107a0960a 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/sQLDataDirectoryMapping.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/sQLDataDirectoryMapping.js @@ -17,11 +17,11 @@ class SQLDataDirectoryMapping { /** * Create a SQLDataDirectoryMapping. - * @member {string} [mappingType] Type of data directory mapping. Possible + * @property {string} [mappingType] Type of data directory mapping. Possible * values include: 'Invalid', 'Data', 'Log' - * @member {string} [sourceLogicalName] Restore source logical name path - * @member {string} [sourcePath] Restore source path - * @member {string} [targetPath] Target path + * @property {string} [sourceLogicalName] Restore source logical name path + * @property {string} [sourcePath] Restore source path + * @property {string} [targetPath] Target path */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/schedulePolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/schedulePolicy.js index ae0d4639d1..1f1efb2c62 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/schedulePolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/schedulePolicy.js @@ -17,7 +17,7 @@ class SchedulePolicy { /** * Create a SchedulePolicy. - * @member {string} schedulePolicyType Polymorphic Discriminator + * @property {string} schedulePolicyType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/settings.js b/lib/services/recoveryServicesBackupManagement/lib/models/settings.js index 925ec1c807..ac9e6698c3 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/settings.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/settings.js @@ -17,11 +17,11 @@ class Settings { /** * Create a Settings. - * @member {string} [timeZone] TimeZone optional input as string. For + * @property {string} [timeZone] TimeZone optional input as string. For * example: TimeZone = "Pacific Standard Time". - * @member {boolean} [issqlcompression] SQL compression flag - * @member {boolean} [isCompression] Workload compression flag. This has been - * added so that 'isSqlCompression' + * @property {boolean} [issqlcompression] SQL compression flag + * @property {boolean} [isCompression] Workload compression flag. This has + * been added so that 'isSqlCompression' * will be deprecated once clients upgrade to consider this flag. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/simpleRetentionPolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/simpleRetentionPolicy.js index 19897c02b1..3ff8b48c71 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/simpleRetentionPolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/simpleRetentionPolicy.js @@ -20,16 +20,16 @@ const models = require('./index'); class SimpleRetentionPolicy extends models['RetentionPolicy'] { /** * Create a SimpleRetentionPolicy. - * @member {object} [retentionDuration] Retention duration of the protection - * policy. - * @member {number} [retentionDuration.count] Count of duration types. + * @property {object} [retentionDuration] Retention duration of the + * protection policy. + * @property {number} [retentionDuration.count] Count of duration types. * Retention duration is obtained by the counting the duration type Count * times. * For example, when Count = 3 and DurationType = Weeks, retention duration * will be three weeks. - * @member {string} [retentionDuration.durationType] Retention duration type - * of retention policy. Possible values include: 'Invalid', 'Days', 'Weeks', - * 'Months', 'Years' + * @property {string} [retentionDuration.durationType] Retention duration + * type of retention policy. Possible values include: 'Invalid', 'Days', + * 'Weeks', 'Months', 'Years' */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/simpleSchedulePolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/simpleSchedulePolicy.js index 7b2ce823ab..9171d19f22 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/simpleSchedulePolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/simpleSchedulePolicy.js @@ -20,14 +20,14 @@ const models = require('./index'); class SimpleSchedulePolicy extends models['SchedulePolicy'] { /** * Create a SimpleSchedulePolicy. - * @member {string} [scheduleRunFrequency] Frequency of the schedule + * @property {string} [scheduleRunFrequency] Frequency of the schedule * operation of this policy. Possible values include: 'Invalid', 'Daily', * 'Weekly' - * @member {array} [scheduleRunDays] List of days of week this schedule has + * @property {array} [scheduleRunDays] List of days of week this schedule has * to be run. - * @member {array} [scheduleRunTimes] List of times of day this schedule has - * to be run. - * @member {number} [scheduleWeeklyFrequency] At every number weeks this + * @property {array} [scheduleRunTimes] List of times of day this schedule + * has to be run. + * @property {number} [scheduleWeeklyFrequency] At every number weeks this * schedule has to be run. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/subProtectionPolicy.js b/lib/services/recoveryServicesBackupManagement/lib/models/subProtectionPolicy.js index fa676f8811..2b72cb4a91 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/subProtectionPolicy.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/subProtectionPolicy.js @@ -17,15 +17,15 @@ class SubProtectionPolicy { /** * Create a SubProtectionPolicy. - * @member {string} [policyType] Type of backup policy type. Possible values - * include: 'Invalid', 'Full', 'Differential', 'Log', 'CopyOnlyFull' - * @member {object} [schedulePolicy] Backup schedule specified as part of + * @property {string} [policyType] Type of backup policy type. Possible + * values include: 'Invalid', 'Full', 'Differential', 'Log', 'CopyOnlyFull' + * @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 */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/targetAFSRestoreInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/targetAFSRestoreInfo.js index a4cf2594e0..56a41cee62 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/targetAFSRestoreInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/targetAFSRestoreInfo.js @@ -17,8 +17,8 @@ class TargetAFSRestoreInfo { /** * Create a TargetAFSRestoreInfo. - * @member {string} [name] File share name - * @member {string} [targetResourceId] Target file share resource ARM ID + * @property {string} [name] File share name + * @property {string} [targetResourceId] Target file share resource ARM ID */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/targetRestoreInfo.js b/lib/services/recoveryServicesBackupManagement/lib/models/targetRestoreInfo.js index 7b827cdbcd..494231d329 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/targetRestoreInfo.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/targetRestoreInfo.js @@ -17,12 +17,12 @@ class TargetRestoreInfo { /** * Create a TargetRestoreInfo. - * @member {string} [overwriteOption] Can Overwrite if Target DataBase + * @property {string} [overwriteOption] Can Overwrite if Target DataBase * already exists. Possible values include: 'Invalid', 'FailOnConflict', * 'Overwrite' - * @member {string} [containerId] Resource Id name of the container in which - * Target DataBase resides - * @member {string} [databaseName] Database name InstanceName/DataBaseName + * @property {string} [containerId] Resource Id name of the container in + * which Target DataBase resides + * @property {string} [databaseName] Database name InstanceName/DataBaseName * for SQL or System/DbName for SAP Hana */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/tokenInformation.js b/lib/services/recoveryServicesBackupManagement/lib/models/tokenInformation.js index a5d48492df..5428ce901e 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/tokenInformation.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/tokenInformation.js @@ -17,9 +17,9 @@ class TokenInformation { /** * Create a TokenInformation. - * @member {string} [token] Token value. - * @member {number} [expiryTimeInUtcTicks] Expiry time of token. - * @member {string} [securityPIN] Security PIN + * @property {string} [token] Token value. + * @property {number} [expiryTimeInUtcTicks] Expiry time of token. + * @property {string} [securityPIN] Security PIN */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/validateOperationRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/validateOperationRequest.js index d5ce02a9f6..509deb3c62 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/validateOperationRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/validateOperationRequest.js @@ -17,7 +17,7 @@ class ValidateOperationRequest { /** * Create a ValidateOperationRequest. - * @member {string} objectType Polymorphic Discriminator + * @property {string} objectType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/validateOperationResponse.js b/lib/services/recoveryServicesBackupManagement/lib/models/validateOperationResponse.js index 5732d78c4f..e4fd7e736c 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/validateOperationResponse.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/validateOperationResponse.js @@ -17,7 +17,7 @@ class ValidateOperationResponse { /** * Create a ValidateOperationResponse. - * @member {array} [validationResults] Gets the validation result + * @property {array} [validationResults] Gets the validation result */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/validateOperationsResponse.js b/lib/services/recoveryServicesBackupManagement/lib/models/validateOperationsResponse.js index b740e7d579..1ef61ed897 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/validateOperationsResponse.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/validateOperationsResponse.js @@ -16,8 +16,8 @@ class ValidateOperationsResponse { /** * Create a ValidateOperationsResponse. - * @member {object} [validateOperationResponse] - * @member {array} [validateOperationResponse.validationResults] Gets the + * @property {object} [validateOperationResponse] + * @property {array} [validateOperationResponse.validationResults] Gets the * validation result */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/validateRestoreOperationRequest.js b/lib/services/recoveryServicesBackupManagement/lib/models/validateRestoreOperationRequest.js index 9fb74fbea3..a439582d37 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/validateRestoreOperationRequest.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/validateRestoreOperationRequest.js @@ -20,8 +20,8 @@ const models = require('./index'); class ValidateRestoreOperationRequest extends models['ValidateOperationRequest'] { /** * Create a ValidateRestoreOperationRequest. - * @member {object} [restoreRequest] Sets restore request to be validated - * @member {string} [restoreRequest.objectType] Polymorphic Discriminator + * @property {object} [restoreRequest] Sets restore request to be validated + * @property {string} [restoreRequest.objectType] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/weeklyRetentionFormat.js b/lib/services/recoveryServicesBackupManagement/lib/models/weeklyRetentionFormat.js index 17597b06ff..1bf6c72dfe 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/weeklyRetentionFormat.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/weeklyRetentionFormat.js @@ -17,8 +17,8 @@ class WeeklyRetentionFormat { /** * Create a WeeklyRetentionFormat. - * @member {array} [daysOfTheWeek] List of days of the week. - * @member {array} [weeksOfTheMonth] List of weeks of month. + * @property {array} [daysOfTheWeek] List of days of the week. + * @property {array} [weeksOfTheMonth] List of weeks of month. */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/weeklyRetentionSchedule.js b/lib/services/recoveryServicesBackupManagement/lib/models/weeklyRetentionSchedule.js index 98b6412ce0..0b0a8ef3cf 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/weeklyRetentionSchedule.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/weeklyRetentionSchedule.js @@ -17,19 +17,19 @@ class WeeklyRetentionSchedule { /** * Create a WeeklyRetentionSchedule. - * @member {array} [daysOfTheWeek] List of days of week for weekly retention - * policy. - * @member {array} [retentionTimes] Retention times of retention policy. - * @member {object} [retentionDuration] Retention duration of retention + * @property {array} [daysOfTheWeek] List of days of week for weekly + * retention policy. + * @property {array} [retentionTimes] Retention times of retention policy. + * @property {object} [retentionDuration] Retention duration of retention * Policy. - * @member {number} [retentionDuration.count] Count of duration types. + * @property {number} [retentionDuration.count] Count of duration types. * Retention duration is obtained by the counting the duration type Count * times. * For example, when Count = 3 and DurationType = Weeks, retention duration * will be three weeks. - * @member {string} [retentionDuration.durationType] Retention duration type - * of retention policy. Possible values include: 'Invalid', 'Days', 'Weeks', - * 'Months', 'Years' + * @property {string} [retentionDuration.durationType] Retention duration + * type of retention policy. Possible values include: 'Invalid', 'Days', + * 'Weeks', 'Months', 'Years' */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/workloadInquiryDetails.js b/lib/services/recoveryServicesBackupManagement/lib/models/workloadInquiryDetails.js index e3d7affaa2..235ea60ac2 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/workloadInquiryDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/workloadInquiryDetails.js @@ -17,19 +17,19 @@ class WorkloadInquiryDetails { /** * Create a WorkloadInquiryDetails. - * @member {string} [type] Type of the Workload such as SQL, Oracle etc. - * @member {number} [itemCount] Contains the protectable item Count inside + * @property {string} [type] Type of the Workload such as SQL, Oracle etc. + * @property {number} [itemCount] Contains the protectable item Count inside * this Container. - * @member {object} [inquiryValidation] Inquiry validation such as + * @property {object} [inquiryValidation] Inquiry validation such as * permissions and other backup validations. - * @member {string} [inquiryValidation.status] Status for the Inquiry + * @property {string} [inquiryValidation.status] Status for the Inquiry * Validation. - * @member {object} [inquiryValidation.errorDetail] Error Detail in case the - * status is non-success. - * @member {string} [inquiryValidation.errorDetail.code] Error code. - * @member {string} [inquiryValidation.errorDetail.message] Error Message + * @property {object} [inquiryValidation.errorDetail] Error Detail in case + * the status is non-success. + * @property {string} [inquiryValidation.errorDetail.code] Error code. + * @property {string} [inquiryValidation.errorDetail.message] Error Message * related to the Code. - * @member {array} [inquiryValidation.errorDetail.recommendations] List of + * @property {array} [inquiryValidation.errorDetail.recommendations] List of * recommendation strings. */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/workloadItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/workloadItem.js index 6b83edef77..5aafd99cd6 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/workloadItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/workloadItem.js @@ -18,14 +18,15 @@ class WorkloadItem { /** * Create a WorkloadItem. - * @member {string} [backupManagementType] Type of backup managemenent to + * @property {string} [backupManagementType] Type of backup management to * backup an item. - * @member {string} [workloadType] Type of workload for the backup management - * @member {string} [friendlyName] Friendly name of the backup item. - * @member {string} [protectionState] State of the back up item. Possible + * @property {string} [workloadType] Type of workload for the backup + * management + * @property {string} [friendlyName] Friendly name of the backup item. + * @property {string} [protectionState] State of the back up item. Possible * values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', * 'ProtectionFailed' - * @member {string} workloadItemType Polymorphic Discriminator + * @property {string} workloadItemType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/workloadItemResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/workloadItemResource.js index bf96cd6c5d..cdd5e851b5 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/workloadItemResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/workloadItemResource.js @@ -21,17 +21,17 @@ const models = require('./index'); class WorkloadItemResource extends models['Resource'] { /** * Create a WorkloadItemResource. - * @member {object} [properties] WorkloadItemResource properties - * @member {string} [properties.backupManagementType] Type of backup - * managemenent to backup an item. - * @member {string} [properties.workloadType] Type of workload for the backup - * management - * @member {string} [properties.friendlyName] Friendly name of the backup + * @property {object} [properties] WorkloadItemResource properties + * @property {string} [properties.backupManagementType] Type of backup + * management to backup an item. + * @property {string} [properties.workloadType] Type of workload for the + * backup management + * @property {string} [properties.friendlyName] Friendly name of the backup * item. - * @member {string} [properties.protectionState] State of the back up item. + * @property {string} [properties.protectionState] State of the back up item. * Possible values include: 'Invalid', 'NotProtected', 'Protecting', * 'Protected', 'ProtectionFailed' - * @member {string} [properties.workloadItemType] Polymorphic Discriminator + * @property {string} [properties.workloadItemType] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/workloadProtectableItem.js b/lib/services/recoveryServicesBackupManagement/lib/models/workloadProtectableItem.js index f08bedef24..71e5abebd3 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/workloadProtectableItem.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/workloadProtectableItem.js @@ -18,14 +18,15 @@ class WorkloadProtectableItem { /** * Create a WorkloadProtectableItem. - * @member {string} [backupManagementType] Type of backup managemenent to + * @property {string} [backupManagementType] Type of backup management to * backup an item. - * @member {string} [workloadType] Type of workload for the backup management - * @member {string} [friendlyName] Friendly name of the backup item. - * @member {string} [protectionState] State of the back up item. Possible + * @property {string} [workloadType] Type of workload for the backup + * management + * @property {string} [friendlyName] Friendly name of the backup item. + * @property {string} [protectionState] State of the back up item. Possible * values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', * 'ProtectionFailed' - * @member {string} protectableItemType Polymorphic Discriminator + * @property {string} protectableItemType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/workloadProtectableItemResource.js b/lib/services/recoveryServicesBackupManagement/lib/models/workloadProtectableItemResource.js index 5d0cab6f15..2343714bad 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/workloadProtectableItemResource.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/workloadProtectableItemResource.js @@ -21,17 +21,17 @@ const models = require('./index'); class WorkloadProtectableItemResource extends models['Resource'] { /** * Create a WorkloadProtectableItemResource. - * @member {object} [properties] WorkloadProtectableItemResource properties - * @member {string} [properties.backupManagementType] Type of backup - * managemenent to backup an item. - * @member {string} [properties.workloadType] Type of workload for the backup - * management - * @member {string} [properties.friendlyName] Friendly name of the backup + * @property {object} [properties] WorkloadProtectableItemResource properties + * @property {string} [properties.backupManagementType] Type of backup + * management to backup an item. + * @property {string} [properties.workloadType] Type of workload for the + * backup management + * @property {string} [properties.friendlyName] Friendly name of the backup * item. - * @member {string} [properties.protectionState] State of the back up item. + * @property {string} [properties.protectionState] State of the back up item. * Possible values include: 'Invalid', 'NotProtected', 'Protecting', * 'Protected', 'ProtectionFailed' - * @member {string} [properties.protectableItemType] Polymorphic + * @property {string} [properties.protectableItemType] Polymorphic * Discriminator */ constructor() { diff --git a/lib/services/recoveryServicesBackupManagement/lib/models/yearlyRetentionSchedule.js b/lib/services/recoveryServicesBackupManagement/lib/models/yearlyRetentionSchedule.js index 886e7f8529..bdc1269ae0 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/models/yearlyRetentionSchedule.js +++ b/lib/services/recoveryServicesBackupManagement/lib/models/yearlyRetentionSchedule.js @@ -17,32 +17,32 @@ class YearlyRetentionSchedule { /** * Create a YearlyRetentionSchedule. - * @member {string} [retentionScheduleFormatType] Retention schedule format + * @property {string} [retentionScheduleFormatType] Retention schedule format * for yearly retention policy. Possible values include: 'Invalid', 'Daily', * 'Weekly' - * @member {array} [monthsOfYear] List of months of year of yearly retention - * policy. - * @member {object} [retentionScheduleDaily] Daily retention format for + * @property {array} [monthsOfYear] List of months of year of yearly + * retention policy. + * @property {object} [retentionScheduleDaily] Daily retention format for * yearly retention policy. - * @member {array} [retentionScheduleDaily.daysOfTheMonth] List of days of + * @property {array} [retentionScheduleDaily.daysOfTheMonth] List of days of * the month. - * @member {object} [retentionScheduleWeekly] Weekly retention format for + * @property {object} [retentionScheduleWeekly] Weekly retention format for * yearly retention policy. - * @member {array} [retentionScheduleWeekly.daysOfTheWeek] List of days of + * @property {array} [retentionScheduleWeekly.daysOfTheWeek] List of days of * the week. - * @member {array} [retentionScheduleWeekly.weeksOfTheMonth] List of weeks of - * month. - * @member {array} [retentionTimes] Retention times of retention policy. - * @member {object} [retentionDuration] Retention duration of retention + * @property {array} [retentionScheduleWeekly.weeksOfTheMonth] List of weeks + * of month. + * @property {array} [retentionTimes] Retention times of retention policy. + * @property {object} [retentionDuration] Retention duration of retention * Policy. - * @member {number} [retentionDuration.count] Count of duration types. + * @property {number} [retentionDuration.count] Count of duration types. * Retention duration is obtained by the counting the duration type Count * times. * For example, when Count = 3 and DurationType = Weeks, retention duration * will be three weeks. - * @member {string} [retentionDuration.durationType] Retention duration type - * of retention policy. Possible values include: 'Invalid', 'Days', 'Weeks', - * 'Months', 'Years' + * @property {string} [retentionDuration.durationType] Retention duration + * type of retention policy. Possible values include: 'Invalid', 'Days', + * 'Weeks', 'Months', 'Years' */ constructor() { } diff --git a/lib/services/recoveryServicesBackupManagement/lib/operations/index.d.ts b/lib/services/recoveryServicesBackupManagement/lib/operations/index.d.ts index 66f6d37d9d..fdf8fcfe07 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/operations/index.d.ts +++ b/lib/services/recoveryServicesBackupManagement/lib/operations/index.d.ts @@ -205,7 +205,7 @@ export interface ProtectionIntentOperations { * @param {object} [parameters.properties] ProtectionIntentResource properties * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', + * management for the backed up item. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * @@ -262,7 +262,7 @@ export interface ProtectionIntentOperations { * @param {object} [parameters.properties] ProtectionIntentResource properties * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', + * management for the backed up item. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * @@ -699,7 +699,7 @@ export interface JobDetails { /** - * Gets exteded information associated with the job. + * Gets extended information associated with the job. * * @param {string} vaultName The name of the recovery services vault. * @@ -722,7 +722,7 @@ export interface JobDetails { getWithHttpOperationResponse(vaultName: string, resourceGroupName: string, jobName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Gets exteded information associated with the job. + * Gets extended information associated with the job. * * @param {string} vaultName The name of the recovery services vault. * @@ -2215,7 +2215,7 @@ export interface ProtectionContainers { * container. * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the container. Possible values include: 'Invalid', + * management for the container. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * @@ -2271,7 +2271,7 @@ export interface ProtectionContainers { * container. * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the container. Possible values include: 'Invalid', + * management for the container. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * @@ -2910,7 +2910,7 @@ export interface ProtectedItems { * @param {object} [parameters.properties] ProtectedItemResource properties * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', + * management for the backed up item. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * @@ -2984,7 +2984,7 @@ export interface ProtectedItems { * @param {object} [parameters.properties] ProtectedItemResource properties * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', + * management for the backed up item. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * diff --git a/lib/services/recoveryServicesBackupManagement/lib/operations/jobDetails.js b/lib/services/recoveryServicesBackupManagement/lib/operations/jobDetails.js index e3ebd62678..cab452c3b8 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/operations/jobDetails.js +++ b/lib/services/recoveryServicesBackupManagement/lib/operations/jobDetails.js @@ -15,7 +15,7 @@ const msRestAzure = require('ms-rest-azure'); const WebResource = msRest.WebResource; /** - * Gets exteded information associated with the job. + * Gets extended information associated with the job. * * @param {string} vaultName The name of the recovery services vault. * @@ -176,7 +176,7 @@ class JobDetails { } /** - * Gets exteded information associated with the job. + * Gets extended information associated with the job. * * @param {string} vaultName The name of the recovery services vault. * @@ -211,7 +211,7 @@ class JobDetails { } /** - * Gets exteded information associated with the job. + * Gets extended information associated with the job. * * @param {string} vaultName The name of the recovery services vault. * diff --git a/lib/services/recoveryServicesBackupManagement/lib/operations/protectedItems.js b/lib/services/recoveryServicesBackupManagement/lib/operations/protectedItems.js index 0c14947fb0..f1de402996 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/operations/protectedItems.js +++ b/lib/services/recoveryServicesBackupManagement/lib/operations/protectedItems.js @@ -212,7 +212,7 @@ function _get(vaultName, resourceGroupName, fabricName, containerName, protected * @param {object} [parameters.properties] ProtectedItemResource properties * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', + * management for the backed up item. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * @@ -710,7 +710,7 @@ class ProtectedItems { * @param {object} [parameters.properties] ProtectedItemResource properties * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', + * management for the backed up item. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * @@ -796,7 +796,7 @@ class ProtectedItems { * @param {object} [parameters.properties] ProtectedItemResource properties * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', + * management for the backed up item. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * diff --git a/lib/services/recoveryServicesBackupManagement/lib/operations/protectionContainers.js b/lib/services/recoveryServicesBackupManagement/lib/operations/protectionContainers.js index a6ecdf407e..55664d726d 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/operations/protectionContainers.js +++ b/lib/services/recoveryServicesBackupManagement/lib/operations/protectionContainers.js @@ -197,7 +197,7 @@ function _get(vaultName, resourceGroupName, fabricName, containerName, options, * container. * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the container. Possible values include: 'Invalid', + * management for the container. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * @@ -955,7 +955,7 @@ class ProtectionContainers { * container. * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the container. Possible values include: 'Invalid', + * management for the container. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * @@ -1023,7 +1023,7 @@ class ProtectionContainers { * container. * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the container. Possible values include: 'Invalid', + * management for the container. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * diff --git a/lib/services/recoveryServicesBackupManagement/lib/operations/protectionIntentOperations.js b/lib/services/recoveryServicesBackupManagement/lib/operations/protectionIntentOperations.js index bb07addeaa..c8a28eae71 100644 --- a/lib/services/recoveryServicesBackupManagement/lib/operations/protectionIntentOperations.js +++ b/lib/services/recoveryServicesBackupManagement/lib/operations/protectionIntentOperations.js @@ -364,7 +364,7 @@ function _get(vaultName, resourceGroupName, fabricName, intentObjectName, option * @param {object} [parameters.properties] ProtectionIntentResource properties * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', + * management for the backed up item. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * @@ -942,7 +942,7 @@ class ProtectionIntentOperations { * @param {object} [parameters.properties] ProtectionIntentResource properties * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', + * management for the backed up item. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * @@ -1011,7 +1011,7 @@ class ProtectionIntentOperations { * @param {object} [parameters.properties] ProtectionIntentResource properties * * @param {string} [parameters.properties.backupManagementType] Type of backup - * managemenent for the backed up item. Possible values include: 'Invalid', + * management for the backed up item. Possible values include: 'Invalid', * 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', * 'AzureStorage', 'AzureWorkload', 'DefaultBackup' * diff --git a/lib/services/recoveryServicesBackupManagement/package.json b/lib/services/recoveryServicesBackupManagement/package.json index 112994c1f1..48b8b030d6 100644 --- a/lib/services/recoveryServicesBackupManagement/package.json +++ b/lib/services/recoveryServicesBackupManagement/package.json @@ -22,4 +22,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +}