Skip to content

Commit 21842f7

Browse files
pragrawapragrawa
committed
Addinng comment section on classes
1 parent 250e454 commit 21842f7

18 files changed

+214
-12
lines changed

‎src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Helpers/Conversions/ConversionHelpers.cs

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,16 @@
2323

2424
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Helpers
2525
{
26+
/// <summary>
27+
/// Conversion helpers.
28+
/// </summary>
2629
public class ConversionHelpers
2730
{
2831
#region containers
32+
33+
/// <summary>
34+
/// Helper function to convert ps backup container model from service response.
35+
/// </summary>
2936
public static AzureRmRecoveryServicesBackupContainerBase GetContainerModel(ProtectionContainerResource protectionContainer)
3037
{
3138
AzureRmRecoveryServicesBackupContainerBase containerModel = null;
@@ -46,6 +53,9 @@ public static AzureRmRecoveryServicesBackupContainerBase GetContainerModel(Prote
4653
return containerModel;
4754
}
4855

56+
/// <summary>
57+
/// Helper function to convert ps backup engine model from service response.
58+
/// </summary>
4959
public static AzureRmRecoveryServicesBackupEngineBase GetBackupEngineModel(BackupEngineResource backupEngine)
5060
{
5161
AzureRmRecoveryServicesBackupEngineBase backupEngineModel = null;
@@ -66,6 +76,9 @@ public static AzureRmRecoveryServicesBackupEngineBase GetBackupEngineModel(Backu
6676
return backupEngineModel;
6777
}
6878

79+
/// <summary>
80+
/// Helper function to convert ps backup container model list from service response.
81+
/// </summary>
6982
public static List<AzureRmRecoveryServicesBackupContainerBase> GetContainerModelList(IEnumerable<ProtectionContainerResource> protectionContainers)
7083
{
7184
List<AzureRmRecoveryServicesBackupContainerBase> containerModels = new List<AzureRmRecoveryServicesBackupContainerBase>();
@@ -78,6 +91,9 @@ public static List<AzureRmRecoveryServicesBackupContainerBase> GetContainerModel
7891
return containerModels;
7992
}
8093

94+
/// <summary>
95+
/// Helper function to convert ps backup engine model list from service response.
96+
/// </summary>
8197
public static List<AzureRmRecoveryServicesBackupEngineBase> GetBackupEngineModelList(IEnumerable<BackupEngineResource> backupEngines)
8298
{
8399
List<AzureRmRecoveryServicesBackupEngineBase> backupEngineModel = new List<AzureRmRecoveryServicesBackupEngineBase>();
@@ -93,6 +109,10 @@ public static List<AzureRmRecoveryServicesBackupEngineBase> GetBackupEngineModel
93109
#endregion
94110

95111
#region policy
112+
113+
/// <summary>
114+
/// Helper function to convert ps backup policy model from service response.
115+
/// </summary>
96116
public static AzureRmRecoveryServicesBackupPolicyBase GetPolicyModel(ProtectionPolicyResource hydraResponse)
97117
{
98118
AzureRmRecoveryServicesBackupPolicyBase policyModel = null;
@@ -148,6 +168,9 @@ public static AzureRmRecoveryServicesBackupPolicyBase GetPolicyModel(ProtectionP
148168
return policyModel;
149169
}
150170

171+
/// <summary>
172+
/// Helper function to convert ps backup policy list model from service response.
173+
/// </summary>
151174
public static List<AzureRmRecoveryServicesBackupPolicyBase> GetPolicyModelList(
152175
ProtectionPolicyListResponse hydraListResponse)
153176
{
@@ -178,6 +201,9 @@ public static List<AzureRmRecoveryServicesBackupPolicyBase> GetPolicyModelList(
178201

179202
#region Item
180203

204+
/// <summary>
205+
/// Helper function to convert ps backup policy item from service response.
206+
/// </summary>
181207
public static AzureRmRecoveryServicesBackupItemBase GetItemModel(ProtectedItemResource protectedItem)
182208
{
183209
AzureRmRecoveryServicesBackupItemBase itemModel = null;
@@ -211,6 +237,9 @@ public static AzureRmRecoveryServicesBackupItemBase GetItemModel(ProtectedItemRe
211237
return itemModel;
212238
}
213239

240+
/// <summary>
241+
/// Helper function to convert ps backup policy item list from service response.
242+
/// </summary>
214243
public static List<AzureRmRecoveryServicesBackupItemBase> GetItemModelList(IEnumerable<ProtectedItemResource> protectedItems)
215244
{
216245
List<AzureRmRecoveryServicesBackupItemBase> itemModels = new List<AzureRmRecoveryServicesBackupItemBase>();

‎src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Helpers/Conversions/JobConversions.cs

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020

2121
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Helpers
2222
{
23+
/// <summary>
24+
/// Job conversions helper.
25+
/// </summary>
2326
public class JobConversions
2427
{
2528
#region Hydra to PS convertors
@@ -37,6 +40,9 @@ public static CmdletModel.AzureRmRecoveryServicesBackupJobBase GetPSJob(JobRespo
3740
return GetPSJob(hydraJob.Item);
3841
}
3942

43+
/// <summary>
44+
/// Helper function to convert ps backup job model from service response.
45+
/// </summary>
4046
public static CmdletModel.AzureRmRecoveryServicesBackupJobBase GetPSJob(JobResource hydraJob)
4147
{
4248
CmdletModel.AzureRmRecoveryServicesBackupJobBase response = null;
@@ -54,6 +60,9 @@ public static CmdletModel.AzureRmRecoveryServicesBackupJobBase GetPSJob(JobResou
5460
return response;
5561
}
5662

63+
/// <summary>
64+
/// Helper function to convert ps backup job list model from service response.
65+
/// </summary>
5766
public static void AddHydraJobsToPSList(JobListResponse hydraJobs, List<CmdletModel.AzureRmRecoveryServicesBackupJobBase> psJobs, ref int jobsCount)
5867
{
5968
if (hydraJobs.ItemList != null && hydraJobs.ItemList.Value != null)
@@ -72,6 +81,9 @@ public static void AddHydraJobsToPSList(JobListResponse hydraJobs, List<CmdletMo
7281

7382
#region AzureVm job private helpers
7483

84+
/// <summary>
85+
/// Helper function to convert ps auzre vm backup policy job from service response.
86+
/// </summary>
7587
private static CmdletModel.AzureRmRecoveryServicesBackupAzureVmJob GetPSAzureVmJob(JobResource hydraJob)
7688
{
7789
CmdletModel.AzureRmRecoveryServicesBackupAzureVmJob response;
@@ -140,6 +152,9 @@ private static CmdletModel.AzureRmRecoveryServicesBackupAzureVmJob GetPSAzureVmJ
140152
return response;
141153
}
142154

155+
/// <summary>
156+
/// Helper function to convert ps auzre vm backup policy job error info from service response.
157+
/// </summary>
143158
private static CmdletModel.AzureRmRecoveryServicesBackupAzureVmJobErrorInfo GetPSAzureVmErrorInfo(AzureIaaSVMErrorInfo hydraError)
144159
{
145160
CmdletModel.AzureRmRecoveryServicesBackupAzureVmJobErrorInfo psErrorInfo = new CmdletModel.AzureRmRecoveryServicesBackupAzureVmJobErrorInfo();
@@ -154,6 +169,9 @@ private static CmdletModel.AzureRmRecoveryServicesBackupAzureVmJobErrorInfo GetP
154169
return psErrorInfo;
155170
}
156171

172+
/// <summary>
173+
/// Helper function to get last index value from full id.
174+
/// </summary>
157175
public static string GetLastIdFromFullId(string fullId)
158176
{
159177
string[] splitArr = fullId.Split("/".ToCharArray());
@@ -166,6 +184,10 @@ public static string GetLastIdFromFullId(string fullId)
166184

167185
#region Enum translators
168186

187+
188+
/// <summary>
189+
/// Helper function to get job type from ps backupmanagement type.
190+
/// </summary>
169191
public static string GetJobTypeForService(CmdletModel.BackupManagementType mgmtType)
170192
{
171193
switch (mgmtType)
@@ -177,6 +199,9 @@ public static string GetJobTypeForService(CmdletModel.BackupManagementType mgmtT
177199
}
178200
}
179201

202+
/// <summary>
203+
/// Helper function to get ps backup management type from job type.
204+
/// </summary>
180205
public static string GetPSBackupManagementType(string jobType)
181206
{
182207
if (jobType == BackupManagementType.AzureIaasVM.ToString())

‎src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Helpers/Conversions/RecoveryPointConversions.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,14 @@
2121

2222
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Helpers
2323
{
24+
/// <summary>
25+
/// Recovery Point conversion helper.
26+
/// </summary>
2427
public class RecoveryPointConversions
2528
{
29+
/// <summary>
30+
/// Helper function to convert ps recovery points list model from service response.
31+
/// </summary>
2632
public static List<AzureRmRecoveryServicesBackupRecoveryPointBase> GetPSAzureRecoveryPoints(RecoveryPointListResponse rpList, AzureRmRecoveryServicesBackupIaasVmItem item)
2733
{
2834
if (rpList == null || rpList.RecoveryPointList == null || rpList.RecoveryPointList.RecoveryPoints == null)
@@ -60,6 +66,9 @@ public static List<AzureRmRecoveryServicesBackupRecoveryPointBase> GetPSAzureRec
6066
return result;
6167
}
6268

69+
// <summary>
70+
/// Helper function to convert ps recovery point model from service response.
71+
/// </summary>
6372
public static AzureRmRecoveryServicesBackupRecoveryPointBase GetPSAzureRecoveryPoints(RecoveryPointResponse rpResponse, AzureRmRecoveryServicesBackupIaasVmItem item)
6473
{
6574
if (rpResponse == null || rpResponse.RecPoint == null)

‎src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Helpers/Conversions/RetentionPolicyConversions.cs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,18 @@
2323

2424
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Helpers
2525
{
26+
/// <summary>
27+
/// Backup policy conversion helper
28+
/// </summary>
2629
public partial class PolicyHelpers
2730
{
2831
#region HydraToPSObject conversions
2932

3033
#region public
34+
35+
// <summary>
36+
/// Helper function to convert ps long term retention policy from service response.
37+
/// </summary>
3138
public static AzureRmRecoveryServicesBackupLongTermRetentionPolicy GetPSLongTermRetentionPolicy(
3239
HydraModels.LongTermRetentionPolicy hydraRetPolicy)
3340
{
@@ -68,6 +75,9 @@ public static AzureRmRecoveryServicesBackupLongTermRetentionPolicy GetPSLongTerm
6875
return ltrPolicy;
6976
}
7077

78+
// <summary>
79+
/// Helper function to convert ps simple retention policy from service response.
80+
/// </summary>
7181
public static AzureRmRecoveryServicesBackupLongTermRetentionPolicy GetPSSimpleRetentionPolicy(
7282
HydraModels.SimpleRetentionPolicy hydraRetPolicy)
7383
{
@@ -323,6 +333,10 @@ private static WeeklyRetentionFormat GetPSLTRWeeklyRetentionFormat(
323333
#endregion
324334

325335
#region PStoHydraObject conversions
336+
337+
// <summary>
338+
/// Helper function to convert service long term retention policy from ps retention policy.
339+
/// </summary>
326340
public static HydraModels.LongTermRetentionPolicy GetHydraLongTermRetentionPolicy(
327341
AzureRmRecoveryServicesBackupLongTermRetentionPolicy psRetPolicy)
328342
{
@@ -356,6 +370,9 @@ public static HydraModels.LongTermRetentionPolicy GetHydraLongTermRetentionPolic
356370
return hydraRetPolicy;
357371
}
358372

373+
// <summary>
374+
/// Helper function to convert service simple retention policy from ps simple policy.
375+
/// </summary>
359376
public static HydraModels.SimpleRetentionPolicy GetHydraSimpleRetentionPolicy(
360377
AzureRmRecoveryServicesBackupSimpleSchedulePolicy psRetPolicy)
361378
{

‎src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Helpers/Conversions/SchedulePolicyConversions.cs

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,16 @@
2222

2323
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Helpers
2424
{
25+
/// <summary>
26+
/// Backup policy conversion helper
27+
/// </summary>
2528
public partial class PolicyHelpers
2629
{
2730
#region HydraToPSObject conversions
2831

32+
// <summary>
33+
/// Helper function to convert ps simple schedule policy from service response.
34+
/// </summary>
2935
public static AzureRmRecoveryServicesBackupSimpleSchedulePolicy GetPSSimpleSchedulePolicy(
3036
SimpleSchedulePolicy hydraPolicy)
3137
{
@@ -51,6 +57,9 @@ public static AzureRmRecoveryServicesBackupSimpleSchedulePolicy GetPSSimpleSched
5157

5258
#region PStoHydraObject conversions
5359

60+
// <summary>
61+
/// Helper function to parse utc time from local time.
62+
/// </summary>
5463
public static List<DateTime> ParseDateTimesToUTC(IList<DateTime> localTimes)
5564
{
5665
if (localTimes == null || localTimes.Count == 0)
@@ -72,8 +81,11 @@ public static List<DateTime> ParseDateTimesToUTC(IList<DateTime> localTimes)
7281
}
7382

7483
return utcTimes;
75-
}
84+
}
7685

86+
// <summary>
87+
/// Helper function to convert service simple schedule policy from ps scheduel policy.
88+
/// </summary>
7789
public static SimpleSchedulePolicy GetHydraSimpleSchedulePolicy(
7890
AzureRmRecoveryServicesBackupSimpleSchedulePolicy psPolicy)
7991
{

‎src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Helpers/Validations/PolicyValidations.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Helpers
2525
{
2626
public partial class PolicyHelpers
2727
{
28+
// <summary>
29+
/// Helper function to validate long term rentention policy and simple schedule policy.
30+
/// </summary>
2831
public static void ValidateLongTermRetentionPolicyWithSimpleRetentionPolicy(
2932
AzureRmRecoveryServicesBackupLongTermRetentionPolicy ltrPolicy,
3033
AzureRmRecoveryServicesBackupSimpleSchedulePolicy schPolicy)

‎src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureRmRecoveryServicesAzureVmContainer.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121

2222
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
2323
{
24+
/// <summary>
25+
/// IaasVm specific container class.
26+
/// </summary>
2427
public class AzureRmRecoveryServicesBackupIaasVmContainer : AzureRmRecoveryServicesBackupContainerBase
2528
{
2629
/// <summary>

‎src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureRmRecoveryServicesAzureVmItem.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
2323
{
2424
/// <summary>
25-
/// Represents IaaSVM Item Class
25+
/// IaaSVM Item Class
2626
/// </summary>
2727
public class AzureRmRecoveryServicesBackupIaasVmItem : AzureRmRecoveryServicesBackupItemBase
2828
{
@@ -67,7 +67,7 @@ public AzureRmRecoveryServicesBackupIaasVmItem(ProtectedItemResource protectedIt
6767
}
6868

6969
/// <summary>
70-
/// Represents IaaSVM Item ExtendedInfo Class
70+
/// IaaSVM Item ExtendedInfo Class
7171
/// </summary>
7272
public class AzureRmRecoveryServicesBackupIaasVmItemExtendedInfo : AzureRmRecoveryServicesBackupItemExtendedInfoBase
7373
{

‎src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureRmRecoveryServicesAzureVmJob.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616

1717
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
1818
{
19+
/// <summary>
20+
/// Represents IaasVm specific job class.
21+
/// </summary>
1922
public class AzureRmRecoveryServicesBackupAzureVmJob : AzureRmRecoveryServicesBackupJobBase
2023
{
2124
public bool IsCancellable { get; set; }
@@ -27,6 +30,9 @@ public class AzureRmRecoveryServicesBackupAzureVmJob : AzureRmRecoveryServicesBa
2730
public List<AzureRmRecoveryServicesBackupAzureVmJobErrorInfo> ErrorDetails { get; set; }
2831
}
2932

33+
/// <summary>
34+
/// IaasVm specific job details class.
35+
/// </summary>
3036
public class AzureRmRecoveryServicesBackupAzureVmJobDetails : AzureRmRecoveryServicesBackupAzureVmJob
3137
{
3238
/// <summary>
@@ -40,11 +46,17 @@ public class AzureRmRecoveryServicesBackupAzureVmJobDetails : AzureRmRecoverySer
4046
public List<AzureRmRecoveryServicesBackupAzureVmJobSubTask> SubTasks { get; set; }
4147
}
4248

49+
/// <summary>
50+
/// IaasVm specific job error info class.
51+
/// </summary>
4352
public class AzureRmRecoveryServicesBackupAzureVmJobErrorInfo : AzureRmRecoveryServicesBackupJobErrorInfoBase
4453
{
4554
public int ErrorCode { get; set; }
4655
}
4756

57+
/// <summary>
58+
/// IaasVm specific job sub-task class.
59+
/// </summary>
4860
public class AzureRmRecoveryServicesBackupAzureVmJobSubTask : AzureRmRecoveryServicesBackupJobSubTaskBase
4961
{
5062
}

‎src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureRmRecoveryServicesAzureVmPolicy.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020

2121
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
2222
{
23+
/// <summary>
24+
/// IaasVm specific backup policy class.
25+
/// </summary>
2326
public class AzureRmRecoveryServicesBackupIaasVmPolicy : AzureRmRecoveryServicesBackupPolicyBase
2427
{
2528
public AzureRmRecoveryServicesBackupSchedulePolicyBase SchedulePolicy { get; set; }

‎src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureRmRecoveryServicesAzureVmRecoveryPoint.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020

2121
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
2222
{
23+
/// <summary>
24+
/// IaasVm specific recovery point class.
25+
/// </summary>
2326
public class AzureRmRecoveryServicesBackupIaasVmRecoveryPoint : AzureRmRecoveryServicesBackupRecoveryPointBase
2427
{
2528
public string RecoveryPointAdditionalInfo { get; set; }

0 commit comments

Comments
 (0)