Skip to content

Commit 67e5576

Browse files
author
dragonfly91
committed
[RS Backup] Fixing 7349803 (documentation fixes) for Azure VM in Models Layer
1 parent 885d31b commit 67e5576

File tree

5 files changed

+46
-0
lines changed

5 files changed

+46
-0
lines changed

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureVmContainer.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ public class AzureVmContainer : ContainerBase
4141
/// </summary>
4242
public ContainerRegistrationStatus Status { get; set; }
4343

44+
/// <summary>
45+
/// Constructor. Takes the service client object representing the container
46+
/// and converts it in to the PS container model
47+
/// </summary>
48+
/// <param name="protectionContainer">Service client object representing the container</param>
4449
public AzureVmContainer(ProtectionContainerResource protectionContainer)
4550
: base(protectionContainer)
4651
{

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureVmItem.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,14 @@ public class AzureVmItem : ItemBase
5353
/// </summary
5454
public AzureVmItemExtendedInfo ExtendedInfo { get; set; }
5555

56+
/// <summary>
57+
/// Constructor. Takes the service client object representing the protected item
58+
/// and converts it in to the PS protected item model
59+
/// </summary>
60+
/// <param name="protectedItemResource">Service client object representing the protected item resource</param>
61+
/// <param name="containerName">Name of the container associated with this protected item</param>
62+
/// <param name="containerType">Type of the container associated with this protected item</param>
63+
/// <param name="policyName">Name of the protection policy associated with this protected item</param>
5664
public AzureVmItem(ProtectedItemResource protectedItemResource,
5765
string containerName, ContainerType containerType, string policyName)
5866
: base(protectedItemResource, containerName, containerType)

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureVmJob.cs

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,24 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
2121
/// </summary>
2222
public class AzureVmJob : JobBase
2323
{
24+
/// <summary>
25+
/// Represents whether this job is cancellable.
26+
/// </summary>
2427
public bool IsCancellable { get; set; }
2528

29+
/// <summary>
30+
/// Represents whether this job is retriable.
31+
/// </summary>
2632
public bool IsRetriable { get; set; }
2733

34+
/// <summary>
35+
/// The VM version of the Azure VM associated with this job.
36+
/// </summary>
2837
public string VmVersion { get; set; }
2938

39+
/// <summary>
40+
/// Error details associated with this job.
41+
/// </summary>
3042
public List<AzureVmJobErrorInfo> ErrorDetails { get; set; }
3143
}
3244

@@ -41,8 +53,14 @@ public class AzureVmJobDetails : AzureVmJob
4153
/// </summary>
4254
public string DynamicErrorMessage { get; set; }
4355

56+
/// <summary>
57+
/// Property bag consisting of the some Azure VM specific job details.
58+
/// </summary>
4459
public Dictionary<string, string> Properties { get; set; }
4560

61+
/// <summary>
62+
/// List of sub tasks triggered as part of this job's operation.
63+
/// </summary>
4664
public List<AzureVmJobSubTask> SubTasks { get; set; }
4765
}
4866

@@ -51,6 +69,9 @@ public class AzureVmJobDetails : AzureVmJob
5169
/// </summary>
5270
public class AzureVmJobErrorInfo : JobErrorInfoBase
5371
{
72+
/// <summary>
73+
/// Error code of this job's error.
74+
/// </summary>
5475
public int ErrorCode { get; set; }
5576
}
5677

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureVmPolicy.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,14 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
2525
/// </summary>
2626
public class AzureVmPolicy : PolicyBase
2727
{
28+
/// <summary>
29+
/// Object defining the schedule associated with this policy.
30+
/// </summary>
2831
public SchedulePolicyBase SchedulePolicy { get; set; }
2932

33+
/// <summary>
34+
/// Object defining the retention behavior of this policy.
35+
/// </summary>
3036
public RetentionPolicyBase RetentionPolicy { get; set; }
3137

3238
public override void Validate()

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureVmRecoveryPoint.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,14 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
2525
/// </summary>
2626
public class AzureVmRecoveryPoint : RecoveryPointBase
2727
{
28+
/// <summary>
29+
/// Additional info associated with this recovery point serialized into a string.
30+
/// </summary>
2831
public string RecoveryPointAdditionalInfo { get; set; }
2932

33+
/// <summary>
34+
/// Storage type of the VM whose backup operation has created this recovery point.
35+
/// </summary>
3036
public string SourceVMStorageType { get; set; }
3137

3238
public AzureVmRecoveryPoint()

0 commit comments

Comments
 (0)