Skip to content

Commit c8891f8

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

File tree

4 files changed

+289
-2
lines changed

4 files changed

+289
-2
lines changed

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/CommonModels/Enums.cs

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,61 +20,168 @@
2020

2121
namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
2222
{
23+
/// <summary>
24+
/// Type of the container that maybe managed by the recovery services vault.
25+
/// </summary>
2326
public enum ContainerType
2427
{
28+
/// <summary>
29+
/// Represents the Azure Virtual Machine (both Classic and Compute versions).
30+
/// </summary>
2531
AzureVM = 1,
32+
33+
/// <summary>
34+
/// Represents any windows containers such as those managed by the MAB device etc.
35+
/// </summary>
2636
Windows
2737
}
2838

39+
/// <summary>
40+
/// Type of the backup management agent.
41+
/// </summary>
2942
public enum BackupManagementType
3043
{
44+
/// <summary>
45+
/// Represents the Azure Virtual Machine agent (both Classic and Compute versions).
46+
/// </summary>
3147
AzureVM = 1,
48+
49+
/// <summary>
50+
/// Represents the Microsoft Azure Recovery Services agent.
51+
/// </summary>
3252
MARS,
53+
54+
/// <summary>
55+
/// Represents the Service Center Data Protection Manager agent.
56+
/// </summary>
3357
SCDPM,
58+
59+
/// <summary>
60+
/// Represents the Azure Backup Server agent.
61+
/// </summary>
3462
AzureBackupServer,
3563
}
3664

65+
/// <summary>
66+
/// Type of the backup engine.
67+
/// </summary>
3768
public enum BackupEngineType
3869
{
70+
/// <summary>
71+
/// Represents the Data Protection Manager backup engine.
72+
/// </summary>
3973
DpmBackupEngine = 1,
74+
75+
/// <summary>
76+
/// Represents the Azure Backup Server backup engine.
77+
/// </summary>
4078
AzureBackupServerEngine
4179
}
4280

81+
/// <summary>
82+
/// Type of the workload running in an item.
83+
/// </summary>
4384
public enum WorkloadType
4485
{
86+
/// <summary>
87+
/// Represents the Azure Virtual Machine (both Classic and Compute versions).
88+
/// </summary>
4589
AzureVM = 1,
4690
}
4791

92+
/// <summary>
93+
/// Types of the PowerShell providers for the cmdlet implementation.
94+
/// </summary>
4895
public enum PsBackupProviderTypes
4996
{
97+
/// <summary>
98+
/// Represents the IaaS VM provider for powershell cmdlets.
99+
/// </summary>
50100
IaasVm = 1,
101+
102+
/// <summary>
103+
/// Represents the Azure SQL provider for powershell cmdlets.
104+
/// </summary>
51105
AzureSql,
106+
107+
/// <summary>
108+
/// Represents the Microsoft Azure Backup provider for powershell cmdlets.
109+
/// </summary>
52110
Mab,
111+
112+
/// <summary>
113+
/// Represents the Data Protection Manager provider for powershell cmdlets.
114+
/// </summary>
53115
Dpm
54116
}
55117

118+
/// <summary>
119+
/// Status of the registration of the container with the recovery services vault.
120+
/// </summary>
56121
public enum ContainerRegistrationStatus
57122
{
123+
/// <summary>
124+
/// Represents the registered state of the container with the recovery services vault.
125+
/// </summary>
58126
Registered = 1,
59127
}
60128

129+
/// <summary>
130+
/// Status of the registration of the backup engine with the recovery services vault.
131+
/// </summary>
61132
public enum BackupEngineRegistrationStatus
62133
{
134+
/// <summary>
135+
/// Represents the registered state of the backup engine with the recovery services vault.
136+
/// </summary>
63137
Registered = 1,
138+
139+
/// <summary>
140+
/// Represents the state after the registration process has started but the registration
141+
/// is not yet complete.
142+
/// </summary>
64143
Registering,
65144
}
66145

146+
/// <summary>
147+
/// Status of the protection of the item by the recovery services vault.
148+
/// </summary>
67149
public enum ItemProtectionStatus
68150
{
151+
/// <summary>
152+
/// Represents the healthy state of the protection.
153+
/// </summary>
69154
Healthy = 1,
155+
156+
/// <summary>
157+
/// Represents a state of the protection which is unhealthy.
158+
/// </summary>
70159
Unhealthy,
71160
}
72161

162+
/// <summary>
163+
/// State of the protection of the item by the recovery services vault.
164+
/// </summary>
73165
public enum ItemProtectionState
74166
{
167+
/// <summary>
168+
/// Initial backup is pending
169+
/// </summary>
75170
IRPending = 1,
171+
172+
/// <summary>
173+
/// Error during protection
174+
/// </summary>
76175
ProtectionError,
176+
177+
/// <summary>
178+
/// Protected
179+
/// </summary>
77180
Protected,
181+
182+
/// <summary>
183+
/// Protection was disabled
184+
/// </summary>
78185
ProtectionStopped
79186
}
80187

@@ -103,12 +210,18 @@ public enum Month
103210
December = 12
104211
}
105212

213+
/// <summary>
214+
/// Represents how the policy can be scheduled.
215+
/// </summary>
106216
public enum ScheduleRunType
107217
{
108218
Daily = 1,
109219
Weekly = 2,
110220
}
111221

222+
/// <summary>
223+
/// Type of the duration for which the recovery points can be retained.
224+
/// </summary>
112225
public enum RetentionDurationType
113226
{
114227
Days = 1,
@@ -117,6 +230,9 @@ public enum RetentionDurationType
117230
Years = 4
118231
}
119232

233+
/// <summary>
234+
/// Represents the format of the schedule
235+
/// </summary>
120236
public enum RetentionScheduleFormat
121237
{
122238
Daily = 1,
@@ -127,15 +243,40 @@ public enum RetentionScheduleFormat
127243

128244
#region jobs
129245

246+
/// <summary>
247+
/// Types of operations which create jobs
248+
/// </summary>
130249
public enum JobOperation
131250
{
251+
/// <summary>
252+
/// Trigger backup
253+
/// </summary>
132254
Backup,
255+
256+
/// <summary>
257+
/// Trigger restore
258+
/// </summary>
133259
Restore,
260+
261+
/// <summary>
262+
/// Enable protection
263+
/// </summary>
134264
ConfigureBackup,
265+
266+
/// <summary>
267+
/// Disable protection with retain data
268+
/// </summary>
135269
DisableBackup,
270+
271+
/// <summary>
272+
/// Disable protection with delete data
273+
/// </summary>
136274
DeleteBackupData
137275
}
138276

277+
/// <summary>
278+
/// Status of the job
279+
/// </summary>
139280
public enum JobStatus
140281
{
141282
InProgress,

0 commit comments

Comments
 (0)