Skip to content

Commit 12b2a95

Browse files
yanqiongchenyanqiongchen
authored
Backup admin update (Azure#16151)
* Move preview-2018-09-01 to stable * Add new api version 2021-09-01
1 parent 75abfdb commit 12b2a95

File tree

30 files changed

+1851
-7
lines changed

30 files changed

+1851
-7
lines changed

‎specification/azsadmin/resource-manager/backup/Microsoft.Backup.Admin/preview/2021-09-01/BackupLocations.json‎

Lines changed: 539 additions & 0 deletions
Large diffs are not rendered by default.

‎specification/azsadmin/resource-manager/backup/Microsoft.Backup.Admin/preview/2021-09-01/Backups.json‎

Lines changed: 377 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,377 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "2021-09-01",
5+
"title": "BackupManagementClient",
6+
"description": "The Admin Backup Management Client."
7+
},
8+
"host": "management.azure.com",
9+
"schemes": [
10+
"https"
11+
],
12+
"produces": [
13+
"application/json"
14+
],
15+
"consumes": [
16+
"application/json"
17+
],
18+
"paths": {
19+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Backup.Admin/backupLocations/{location}/backups": {
20+
"get": {
21+
"x-ms-examples": {
22+
"Returns a list of backups from a location.": {
23+
"$ref": "./examples/Backups/List.json"
24+
}
25+
},
26+
"description": "Returns a list of backups from a location.",
27+
"tags": [
28+
"Backups"
29+
],
30+
"operationId": "Backups_List",
31+
"parameters": [
32+
{
33+
"$ref": "../../stable/2018-09-01/Backup.json#/parameters/SubscriptionIdParameter"
34+
},
35+
{
36+
"$ref": "../../stable/2018-09-01/Backup.json#/parameters/ResourceGroupParameter"
37+
},
38+
{
39+
"$ref": "BackupLocations.json#/parameters/BackupLocationParameter"
40+
},
41+
{
42+
"$ref": "#/parameters/ApiVersionParameter"
43+
},
44+
{
45+
"$ref": "../../stable/2018-09-01/Backup.json#/parameters/TopParameter"
46+
},
47+
{
48+
"$ref": "../../stable/2018-09-01/Backup.json#/parameters/SkipParameter"
49+
}
50+
],
51+
"responses": {
52+
"200": {
53+
"description": "OK",
54+
"schema": {
55+
"$ref": "#/definitions/BackupList"
56+
}
57+
},
58+
"default": {
59+
"description": "Error response.",
60+
"schema": {
61+
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
62+
}
63+
}
64+
},
65+
"x-ms-pageable": {
66+
"nextLinkName": null
67+
}
68+
}
69+
},
70+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Backup.Admin/backupLocations/{location}/backups/{backup}": {
71+
"get": {
72+
"x-ms-examples": {
73+
"Returns a backup from a location based on name.": {
74+
"$ref": "./examples/Backups/Get.json"
75+
}
76+
},
77+
"description": "Returns a backup from a location based on name.",
78+
"tags": [
79+
"Backups"
80+
],
81+
"operationId": "Backups_Get",
82+
"parameters": [
83+
{
84+
"$ref": "../../stable/2018-09-01/Backup.json#/parameters/SubscriptionIdParameter"
85+
},
86+
{
87+
"$ref": "../../stable/2018-09-01/Backup.json#/parameters/ResourceGroupParameter"
88+
},
89+
{
90+
"$ref": "BackupLocations.json#/parameters/BackupLocationParameter"
91+
},
92+
{
93+
"$ref": "#/parameters/BackupParameter"
94+
},
95+
{
96+
"$ref": "#/parameters/ApiVersionParameter"
97+
}
98+
],
99+
"responses": {
100+
"200": {
101+
"description": "OK",
102+
"schema": {
103+
"$ref": "#/definitions/Backup"
104+
}
105+
},
106+
"default": {
107+
"description": "Error response.",
108+
"schema": {
109+
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
110+
}
111+
}
112+
}
113+
}
114+
},
115+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Backup.Admin/backupLocations/{location}/backups/{backup}/restore": {
116+
"post": {
117+
"x-ms-examples": {
118+
"Restore a backup.": {
119+
"$ref": "./examples/Backups/Restore.json"
120+
},
121+
"Restore a single role from backup.": {
122+
"$ref": "./examples/Backups/SingleRepoRestore.json"
123+
}
124+
},
125+
"description": "Restore a backup.",
126+
"tags": [
127+
"Backups"
128+
],
129+
"operationId": "Backups_Restore",
130+
"parameters": [
131+
{
132+
"$ref": "../../stable/2018-09-01/Backup.json#/parameters/SubscriptionIdParameter"
133+
},
134+
{
135+
"$ref": "BackupLocations.json#/parameters/BackupLocationParameter"
136+
},
137+
{
138+
"$ref": "../../stable/2018-09-01/Backup.json#/parameters/ResourceGroupParameter"
139+
},
140+
{
141+
"$ref": "#/parameters/BackupParameter"
142+
},
143+
{
144+
"$ref": "#/parameters/ApiVersionParameter"
145+
},
146+
{
147+
"$ref": "#/parameters/RestoreOptionsParameter"
148+
}
149+
],
150+
"responses": {
151+
"200": {
152+
"description": "OK"
153+
},
154+
"202": {
155+
"description": "ACCEPTED"
156+
},
157+
"default": {
158+
"description": "Error response.",
159+
"schema": {
160+
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
161+
}
162+
}
163+
},
164+
"x-ms-long-running-operation": true,
165+
"x-ms-long-running-operation-options": {
166+
"final-state-via": "location"
167+
}
168+
}
169+
}
170+
},
171+
"definitions": {
172+
"Backup": {
173+
"description": "Information related to a backup.",
174+
"type": "object",
175+
"properties": {
176+
"properties": {
177+
"description": "Properties for a backup.",
178+
"$ref": "#/definitions/BackupModel",
179+
"x-ms-client-flatten": true
180+
}
181+
},
182+
"allOf": [
183+
{
184+
"$ref": "../../stable/2018-09-01/Backup.json#/definitions/Resource"
185+
}
186+
]
187+
},
188+
"BackupModel": {
189+
"type": "object",
190+
"description": "Properties for a backup.",
191+
"properties": {
192+
"backupInfo": {
193+
"description": "Holds information for a backup.",
194+
"x-ms-client-flatten": true,
195+
"$ref": "#/definitions/BackupInfo"
196+
}
197+
}
198+
},
199+
"BackupInfo": {
200+
"type": "object",
201+
"description": "Holds information for a backup.",
202+
"properties": {
203+
"backupDataVersion": {
204+
"description": "Version of the backup data.",
205+
"type": "string",
206+
"readOnly": true
207+
},
208+
"roleStatus": {
209+
"description": "Backup status for each role.",
210+
"$ref": "#/definitions/RoleOperationStatusList",
211+
"readOnly": true
212+
},
213+
"status": {
214+
"description": "Current status of the backup.",
215+
"$ref": "#/definitions/OperationStatus",
216+
"readOnly": true
217+
},
218+
"createdDateTime": {
219+
"description": "Creation time of the backup.",
220+
"type": "string",
221+
"format": "date-time",
222+
"readOnly": true
223+
},
224+
"timeTakenToCreate": {
225+
"description": "Duration to create the backup.",
226+
"type": "string",
227+
"readOnly": true
228+
},
229+
"deploymentID": {
230+
"description": "Deployment Id of the stamp.",
231+
"type": "string",
232+
"readOnly": true
233+
},
234+
"stampVersion": {
235+
"description": "Azure Stack stamp version of the backup.",
236+
"type": "string",
237+
"readOnly": true
238+
},
239+
"oemVersion": {
240+
"description": "OEM version.",
241+
"type": "string",
242+
"readOnly": true
243+
},
244+
"isCloudRecoveryReady": {
245+
"description": "True if the backup can be used for cloud recovery scenario.",
246+
"type": "boolean",
247+
"readOnly": true
248+
},
249+
"encryptionCertThumbprint": {
250+
"description": "The thumbprint of the certificate used to encrypt the backup encryption key.",
251+
"type": "string",
252+
"readOnly": true
253+
}
254+
}
255+
},
256+
"OperationStatus": {
257+
"description": "Status of an operation.",
258+
"type": "string",
259+
"enum": [
260+
"Creating",
261+
"Queued",
262+
"Running",
263+
"Deleted",
264+
"Failed",
265+
"Skipped",
266+
"PartialSucceeded",
267+
"Succeeded"
268+
],
269+
"x-ms-enum": {
270+
"name": "OperationStatus",
271+
"modelAsString": false
272+
}
273+
},
274+
"RoleOperationStatusList": {
275+
"description": "object",
276+
"type": "array",
277+
"items": {
278+
"$ref": "#/definitions/RoleOperationStatus"
279+
}
280+
},
281+
"RoleOperationStatus": {
282+
"description": "Backup status for a role.",
283+
"type": "object",
284+
"properties": {
285+
"roleName": {
286+
"description": "Name of the role.",
287+
"type": "string"
288+
},
289+
"status": {
290+
"description": "Status of the role.",
291+
"$ref": "#/definitions/OperationStatus"
292+
}
293+
}
294+
},
295+
"BackupList": {
296+
"type": "object",
297+
"description": "List of backups.",
298+
"properties": {
299+
"value": {
300+
"description": "List of backups.",
301+
"type": "array",
302+
"items": {
303+
"$ref": "#/definitions/Backup"
304+
}
305+
},
306+
"nextLink": {
307+
"description": "URI to the next page.",
308+
"type": "string"
309+
}
310+
}
311+
},
312+
"RestoreOptions": {
313+
"type": "object",
314+
"description": "Properties for restore options.",
315+
"properties": {
316+
"roleName": {
317+
"description": "The Azure Stack role name for restore, set it to empty for all infrastructure role",
318+
"type": "string"
319+
},
320+
"decryptionCertBase64": {
321+
"description": "The certificate file raw data in Base64 string. This should be the .pfx file with the private key.",
322+
"type": "string"
323+
},
324+
"decryptionCertPassword": {
325+
"description": "The password for the decryption certificate.",
326+
"type": "string"
327+
}
328+
}
329+
}
330+
},
331+
"parameters": {
332+
"ApiVersionParameter": {
333+
"name": "api-version",
334+
"in": "query",
335+
"description": "Client API version.",
336+
"required": true,
337+
"type": "string",
338+
"default": "2021-09-01"
339+
},
340+
"BackupParameter": {
341+
"name": "backup",
342+
"in": "path",
343+
"description": "Name of the backup.",
344+
"required": true,
345+
"type": "string",
346+
"x-ms-parameter-location": "method"
347+
},
348+
"RestoreOptionsParameter": {
349+
"name": "restoreOptions",
350+
"in": "body",
351+
"description": "Restore options.",
352+
"required": true,
353+
"schema": {
354+
"$ref": "#/definitions/RestoreOptions"
355+
},
356+
"x-ms-parameter-location": "method"
357+
}
358+
},
359+
"securityDefinitions": {
360+
"azure_auth": {
361+
"type": "oauth2",
362+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
363+
"flow": "implicit",
364+
"description": "Authorization uses an Azure Active Directory OAuth2 flow.",
365+
"scopes": {
366+
"user_impersonation": "impersonate your user account"
367+
}
368+
}
369+
},
370+
"security": [
371+
{
372+
"azure_auth": [
373+
"user_impersonation"
374+
]
375+
}
376+
]
377+
}

0 commit comments

Comments
 (0)