Skip to content

Commit b23eb68

Browse files
author
Kalpesh Chavan
committed
Updated documentation for 2021-04-01-preview version.
1 parent e77ce60 commit b23eb68

File tree

1 file changed

+137
-13
lines changed
  • specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview

1 file changed

+137
-13
lines changed

‎specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/Maintenance.json‎

Lines changed: 137 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
{
7878
"name": "resourceName",
7979
"in": "path",
80-
"description": "Resource Identifier",
80+
"description": "Maintenance Configuration Name",
8181
"required": true,
8282
"type": "string"
8383
},
@@ -1129,7 +1129,7 @@
11291129
{
11301130
"name": "resourceName",
11311131
"in": "path",
1132-
"description": "Resource Identifier",
1132+
"description": "Maintenance Configuration Name",
11331133
"required": true,
11341134
"type": "string"
11351135
},
@@ -1189,7 +1189,7 @@
11891189
{
11901190
"name": "resourceName",
11911191
"in": "path",
1192-
"description": "Resource Identifier",
1192+
"description": "Maintenance Configuration Name",
11931193
"required": true,
11941194
"type": "string"
11951195
},
@@ -1250,7 +1250,7 @@
12501250
{
12511251
"name": "resourceName",
12521252
"in": "path",
1253-
"description": "Resource Identifier",
1253+
"description": "Maintenance Configuration Name",
12541254
"required": true,
12551255
"type": "string"
12561256
},
@@ -1307,7 +1307,7 @@
13071307
{
13081308
"name": "resourceName",
13091309
"in": "path",
1310-
"description": "Resource Identifier",
1310+
"description": "Maintenance Configuration Name",
13111311
"required": true,
13121312
"type": "string"
13131313
},
@@ -1791,7 +1791,29 @@
17911791
"type": "string",
17921792
"x-ms-enum": {
17931793
"name": "UpdateStatus",
1794-
"modelAsString": true
1794+
"modelAsString": true,
1795+
"values": [
1796+
{
1797+
"value": "Pending",
1798+
"description": "There are pending updates to be installed."
1799+
},
1800+
{
1801+
"value": "InProgress",
1802+
"description": "Updates installation are in progress."
1803+
},
1804+
{
1805+
"value": "Completed",
1806+
"description": "All updates are successfully applied."
1807+
},
1808+
{
1809+
"value": "RetryNow",
1810+
"description": "Updates installation failed but are ready to retry again."
1811+
},
1812+
{
1813+
"value": "RetryLater",
1814+
"description": "Updates installation failed and should be retried later."
1815+
}
1816+
]
17951817
}
17961818
},
17971819
"resourceId": {
@@ -1930,7 +1952,7 @@
19301952
"type": "string"
19311953
},
19321954
"recurEvery": {
1933-
"description": "Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday]. Monthly schedule examples are recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday.",
1955+
"description": "Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6.",
19341956
"type": "string"
19351957
}
19361958
}
@@ -1963,7 +1985,33 @@
19631985
"type": "string",
19641986
"x-ms-enum": {
19651987
"name": "MaintenanceScope",
1966-
"modelAsString": true
1988+
"modelAsString": true,
1989+
"values": [
1990+
{
1991+
"value": "Host",
1992+
"description": "This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs."
1993+
},
1994+
{
1995+
"value": "OSImage",
1996+
"description": "This maintenance scope controls os image installation on VM/VMSS"
1997+
},
1998+
{
1999+
"value": "Extension",
2000+
"description": "This maintenance scope controls extension installation on VM/VMSS"
2001+
},
2002+
{
2003+
"value": "InGuestPatch",
2004+
"description": "This maintenance scope controls installation of windows and linux packages on VM/VMSS"
2005+
},
2006+
{
2007+
"value": "SQLDB",
2008+
"description": "This maintenance scope controls installation of SQL server platform updates."
2009+
},
2010+
{
2011+
"value": "SQLManagedInstance",
2012+
"description": "This maintenance scope controls installation of SQL managed instance platform update."
2013+
}
2014+
]
19672015
}
19682016
},
19692017
"maintenanceWindow": {
@@ -1972,15 +2020,25 @@
19722020
"x-ms-client-flatten": true
19732021
},
19742022
"visibility": {
1975-
"description": "Gets or sets the visibility of the configuration",
2023+
"description": "Gets or sets the visibility of the configuration. The default value is 'Custom'",
19762024
"enum": [
19772025
"Custom",
19782026
"Public"
19792027
],
19802028
"type": "string",
19812029
"x-ms-enum": {
19822030
"name": "Visibility",
1983-
"modelAsString": true
2031+
"modelAsString": true,
2032+
"values": [
2033+
{
2034+
"value": "Custom",
2035+
"description": "Only visible to users with permissions."
2036+
},
2037+
{
2038+
"value": "Public",
2039+
"description": "Visible to all users."
2040+
}
2041+
]
19842042
}
19852043
},
19862044
"installPatches": {
@@ -2287,7 +2345,33 @@
22872345
"type": "string",
22882346
"x-ms-enum": {
22892347
"name": "MaintenanceScope",
2290-
"modelAsString": true
2348+
"modelAsString": true,
2349+
"values": [
2350+
{
2351+
"value": "Host",
2352+
"description": "This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs."
2353+
},
2354+
{
2355+
"value": "OSImage",
2356+
"description": "This maintenance scope controls os image installation on VM/VMSS"
2357+
},
2358+
{
2359+
"value": "Extension",
2360+
"description": "This maintenance scope controls extension installation on VM/VMSS"
2361+
},
2362+
{
2363+
"value": "InGuestPatch",
2364+
"description": "This maintenance scope controls installation of windows and linux packages on VM/VMSS"
2365+
},
2366+
{
2367+
"value": "SQLDB",
2368+
"description": "This maintenance scope controls installation of SQL server platform updates."
2369+
},
2370+
{
2371+
"value": "SQLManagedInstance",
2372+
"description": "This maintenance scope controls installation of SQL managed instance platform update."
2373+
}
2374+
]
22912375
}
22922376
},
22932377
"impactType": {
@@ -2301,7 +2385,25 @@
23012385
"type": "string",
23022386
"x-ms-enum": {
23032387
"name": "ImpactType",
2304-
"modelAsString": true
2388+
"modelAsString": true,
2389+
"values": [
2390+
{
2391+
"value": "None",
2392+
"description": "Pending updates has no impact on resource."
2393+
},
2394+
{
2395+
"value": "Freeze",
2396+
"description": "Pending updates can freeze network or disk io operation on resource."
2397+
},
2398+
{
2399+
"value": "Restart",
2400+
"description": "Pending updates can cause resource to restart."
2401+
},
2402+
{
2403+
"value": "Redeploy",
2404+
"description": "Pending updates can redeploy resource."
2405+
}
2406+
]
23052407
}
23062408
},
23072409
"status": {
@@ -2316,7 +2418,29 @@
23162418
"type": "string",
23172419
"x-ms-enum": {
23182420
"name": "UpdateStatus",
2319-
"modelAsString": true
2421+
"modelAsString": true,
2422+
"values": [
2423+
{
2424+
"value": "Pending",
2425+
"description": "There are pending updates to be installed."
2426+
},
2427+
{
2428+
"value": "InProgress",
2429+
"description": "Updates installation are in progress."
2430+
},
2431+
{
2432+
"value": "Completed",
2433+
"description": "All updates are successfully applied."
2434+
},
2435+
{
2436+
"value": "RetryNow",
2437+
"description": "Updates installation failed but are ready to retry again."
2438+
},
2439+
{
2440+
"value": "RetryLater",
2441+
"description": "Updates installation failed and should be retried later."
2442+
}
2443+
]
23202444
}
23212445
},
23222446
"impactDurationInSec": {

0 commit comments

Comments
 (0)