Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Microsoft.DataProtection swagger changes #13235

Merged
merged 17 commits into from
Mar 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,11 @@
}
],
"responses": {
"204": {
"description": "NoContent"
"200": {
"description": "Contains additional information like job Id",
"schema": {
"$ref": "#/definitions/OperationJobExtendedInfo"
}
},
"default": {
"description": "Error response describing why the operation failed.",
Expand Down Expand Up @@ -1095,8 +1098,11 @@
}
],
"responses": {
"204": {
"description": "NoContent"
"200": {
"description": "Contains additional information like job Id",
"schema": {
"$ref": "#/definitions/OperationJobExtendedInfo"
}
},
"202": {
"description": "The operation will be completed asynchronously.",
Expand Down Expand Up @@ -1165,6 +1171,12 @@
}
],
"responses": {
"200": {
"description": "Contains additional information like job Id",
"schema": {
"$ref": "#/definitions/OperationJobExtendedInfo"
}
},
"202": {
"description": "The operation will be completed asynchronously.",
"headers": {
Expand All @@ -1183,9 +1195,6 @@
}
}
},
"204": {
"description": "NoContent"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
Expand Down Expand Up @@ -1230,6 +1239,20 @@
"in": "path",
"required": true,
"type": "string"
},
{
"name": "$filter",
"in": "query",
"description": "OData filter options.",
"required": false,
"type": "string"
},
{
"name": "$skipToken",
"in": "query",
"description": "skipToken Filter.",
"required": false,
"type": "string"
}
],
"responses": {
Expand All @@ -1249,6 +1272,7 @@
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-odata": "#/definitions/RecoveryPointsFilters",
"x-ms-examples": {
"List Recovery Points in a Vault": {
"$ref": "./examples/BackupInstanceOperations/ListRecoveryPoints.json"
Expand Down Expand Up @@ -1431,6 +1455,12 @@
}
],
"responses": {
"200": {
"description": "Contains additional information like job Id",
"schema": {
"$ref": "#/definitions/OperationJobExtendedInfo"
}
},
"202": {
"description": "The operation will be completed asynchronously.",
"headers": {
Expand All @@ -1449,9 +1479,6 @@
}
}
},
"204": {
"description": "NoContent"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
Expand Down Expand Up @@ -1514,6 +1541,12 @@
}
],
"responses": {
"200": {
"description": "Contains additional information like job Id",
"schema": {
"$ref": "#/definitions/OperationJobExtendedInfo"
}
},
"202": {
"description": "The operation will be completed asynchronously.",
"headers": {
Expand All @@ -1532,9 +1565,6 @@
}
}
},
"204": {
"description": "NoContent"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
Expand Down Expand Up @@ -1776,6 +1806,29 @@
"type": "object",
"x-ms-discriminator-value": "AbsoluteDeleteOption"
},
"RecoveryPointsFilters": {
"type": "object",
"properties": {
"restorePointDataStoreId": {
"type": "string"
},
"isVisible": {
"type": "boolean"
},
"startDate": {
"type": "string"
},
"endDate": {
"type": "string"
},
"extendedInfo": {
"type": "boolean"
},
"restorePointState": {
"type": "string"
}
}
},
"AdHocBackupRuleOptions": {
"description": "Adhoc backup rules",
"properties": {
Expand Down Expand Up @@ -1856,6 +1909,15 @@
"format": "date-time",
"type": "string"
},
"policyName": {
"type": "string"
},
"policyVersion": {
"type": "string"
},
"recoveryPointId": {
"type": "string"
},
"recoveryPointType": {
"type": "string"
},
Expand Down Expand Up @@ -1911,8 +1973,6 @@
},
"duration": {
"description": "Total run time of the job. ISO 8601 format.",
"format": "duration",
"readOnly": true,
"type": "string"
},
"endTime": {
Expand Down Expand Up @@ -1944,17 +2004,7 @@
},
"operationCategory": {
"description": "It indicates the type of Job i.e. Backup/Restore/Tiering/Management",
"type": "string",
"enum": [
"Backup",
"Restore",
"Management",
"Tiering"
],
"x-ms-enum": {
"modelAsString": true,
"name": "JobOperationCategory"
}
"type": "string"
},
"policyId": {
"description": "ARM ID of the policy",
Expand Down Expand Up @@ -2011,6 +2061,15 @@
"vaultName": {
"description": "Name of the vault",
"type": "string"
},
"etag": {
"type": "string"
},
"sourceDataStoreName": {
"type": "string"
},
"destinationDataStoreName": {
"type": "string"
}
},
"required": [
Expand Down Expand Up @@ -2330,8 +2389,19 @@
"type": "object"
},
"BackupInstance": {
"description": "Backup instance",
"description": "Backup Instance",
"required": [
"friendlyName",
"dataSourceInfo",
"policyInfo",
"objectType"
],
"type": "object",
"properties": {
"friendlyName": {
"description": "Gets or sets the Backup Instance friendly name.",
"type": "string"
},
"dataSourceInfo": {
"$ref": "#/definitions/Datasource",
"description": "Gets or sets the data source information."
Expand All @@ -2340,9 +2410,6 @@
"$ref": "#/definitions/DatasourceSet",
"description": "Gets or sets the data source set information."
},
"objectType": {
"type": "string"
},
"policyInfo": {
"$ref": "#/definitions/PolicyInfo",
"description": "Gets or sets the policy information."
Expand All @@ -2352,18 +2419,43 @@
"description": "Specifies the protection status of the resource",
"readOnly": true
},
"currentProtectionState": {
"description": "Specifies the current protection state of the resource",
"enum": [
"Invalid",
"NotProtected",
"ConfiguringProtection",
"ProtectionConfigured",
"BackupSchedulesSuspended",
"RetentionSchedulesSuspended",
"ProtectionStopped",
"ProtectionError",
"ConfiguringProtectionFailed",
"SoftDeleting",
"SoftDeleted",
"UpdatingProtection"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "CurrentProtectionState",
"modelAsString": true
}
},
"protectionErrorDetails": {
"$ref": "#/definitions/UserFacingError",
"description": "Specifies the protection error of the resource",
"readOnly": true
},
"provisioningState": {
"description": "Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed",
"readOnly": true,
"type": "string",
"readOnly": true
},
"objectType": {
"type": "string"
}
},
"required": [
"dataSourceInfo",
"policyInfo"
],
"title": "BackupInstance",
"type": "object"
}
},
"BackupInstanceResource": {
"allOf": [
Expand Down Expand Up @@ -3905,7 +3997,7 @@
"StorageSetting": {
"description": "Storage setting",
"properties": {
"dataStoreType": {
"datastoreType": {
"description": "Gets or sets the type of the datastore.",
"enum": [
"ArchiveStore",
Expand Down Expand Up @@ -4105,6 +4197,13 @@
"description": "Whether the operation is due to a user error or service error",
"type": "boolean"
},
"properties": {
"description": "Any key value pairs that can be injected inside error object",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"message": {
"type": "string"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"name": "harshitbi2",
"type": "Microsoft.DataProtection/backupVaults/backupInstances",
"properties": {
"friendlyName": "harshitbi2",
"dataSourceInfo": {
"resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
"resourceUri": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"name": "harshitbi2",
"type": "Microsoft.DataProtection/backupVaults/backupInstances",
"properties": {
"friendlyName": "harshitbi2",
"dataSourceInfo": {
"resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
"resourceUri": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"parameters": {
"properties": {
"objectType": "BackupInstance",
"friendlyName": "harshitbi2",
"dataSourceSetInfo": {
"objectType": "DatasourceSet",
"resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
Expand Down Expand Up @@ -52,6 +53,7 @@
"name": "harshitbi2",
"type": "Microsoft.DataProtection/backupVaults/backupInstances",
"properties": {
"friendlyName": "harshitbi2",
"dataSourceInfo": {
"resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
"resourceUri": "",
Expand Down Expand Up @@ -97,6 +99,7 @@
"name": "harshitbi2",
"type": "Microsoft.DataProtection/backupVaults/backupInstances",
"properties": {
"friendlyName": "harshitbi2",
"dataSourceInfo": {
"resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
"resourceUri": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
"Retry-After": "60"
}
},
"204": {}
"200": {
"body": {
"jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae"
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@
"Retry-After": "60"
}
},
"204": {}
"200": {
"body": {
"jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae"
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@
"Retry-After": "60"
}
},
"204": {}
"200": {
"body": {
"jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae"
}
}
}
}
Loading