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

Compute Swagger changes to include cross-region Restore Points scenarios #16682

Merged
Show file tree
Hide file tree
Changes from 9 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 @@ -3578,6 +3578,9 @@
"x-ms-examples": {
"Create or update a restore point collection.": {
"$ref": "./examples/compute/CreateOrUpdateARestorePointCollection.json"
},
"Create or update a restore point collection for cross region copy.": {
"$ref": "./examples/compute/CreateOrUpdateARestorePointCollectionForCrossRegionCopy.json"
}
},
"parameters": [
Expand Down Expand Up @@ -3889,6 +3892,9 @@
"x-ms-examples": {
"Create a restore point": {
"$ref": "./examples/compute/CreateARestorePoint.json"
},
"Copy a restore point to a different region": {
"$ref": "./examples/compute/CopyRestorePointBetweenRegions.json"
}
},
"parameters": [
Expand Down Expand Up @@ -4024,13 +4030,30 @@
"type": "string",
"description": "The name of the restore point."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
"description": "The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point.",
"enum": [
"instanceView"
],
"x-ms-enum": {
"name": "RestorePointExpandOptions",
"modelAsString": true
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"x-ms-examples": {
"Get a restore point": {
"$ref": "./examples/compute/GetRestorePoint.json"
},
"Get restore point instance view": {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+with.. it should be "Get restore point with instance view"

"$ref": "./examples/compute/GetRestorePointInstanceView.json"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also update file name... GetRestorePointWithInstanceView

}
},
"responses": {
Expand Down Expand Up @@ -8340,6 +8363,56 @@
],
"description": "Restore Point details."
},
"RestorePointInstanceView": {
"type": "object",
"properties": {
"diskRestorePoints": {
"type": "array",
"items": {
"$ref": "#/definitions/DiskRestorePointInstanceView"
},
"description": "The disk restore points information."
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/definitions/InstanceViewStatus"
},
"description": "The resource status information."
}
},
"description": "The instance view of a restore point."
},
"DiskRestorePointInstanceView": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Disk restore point Id."
},
"replicationStatus": {
"type": "object",
"items": {
"$ref": "#/definitions/DiskRestorePointReplicationStatus"
},
"description": "The disk restore point replication status information."
}
},
"description": "The instance view of a disk restore point."
},
"DiskRestorePointReplicationStatus": {
"type": "object",
"properties": {
"status": {
"type": "object",
"items": {
"$ref": "#/definitions/InstanceViewStatus"
},
"description": "The resource status information."
}
},
"description": "The instance view of a disk restore point."
},
"RestorePointProperties": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -8378,6 +8451,15 @@
"type": "string",
"format": "date-time",
"description": "Gets the creation time of the restore point."
},
"sourceRestorePoint": {
"$ref": "#/definitions/ApiEntityReference",
"description": "Resource Id of the source restore point from which a copy needs to be created."
},
"instanceView": {
"$ref": "#/definitions/RestorePointInstanceView",
"readOnly": true,
"description": "The restore point instance view."
}
},
"description": "The restore point properties."
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
{
"parameters": {
"subscriptionId": "{subscription-id}",
"resourceGroupName": "myResourceGroup",
"restorePointCollectionName": "rpcName",
"restorePointName": "rpName",
"api-version": "2021-11-01",
"parameters": {
"properties": {
"sourceRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
}
}
}
},
"responses": {
"201": {
"body": {
"name": "rpName",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
"properties": {
"sourceRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
},
"sourceMetadata": {
"vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
"hardwareProfile": {
"vmSize": "Standard_B1s"
},
"storageProfile": {
"osDisk": {
"osType": "Windows",
"name": "osDisk123",
"caching": "ReadWrite",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123"
},
"diskRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
}
},
"dataDisks": [
{
"lun": 1,
"name": "dataDisk123",
"caching": "None",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123"
},
"diskRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_68785190-1acb-4d5e-a8ae-705b45f3dca5"
}
}
]
},
"osProfile": {
"computerName": "computerName",
"adminUsername": "admin",
"windowsConfiguration": {
"provisionVMAgent": true,
"enableAutomaticUpdates": true
},
"secrets": [],
"allowExtensionOperations": true,
"requireGuestProvisionSignal": true
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": true
}
},
"location": "westus"
},
"provisioningState": "Creating",
"consistencyMode": "ApplicationConsistent",
"timeCreated": "2021-10-25T23:54:29.2796325+00:00"
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
{
"parameters": {
"subscriptionId": "{subscription-id}",
"resourceGroupName": "myResourceGroup",
"restorePointCollectionName": "myRpc",
"api-version": "2021-11-01",
"parameters": {
"location": "norwayeast",
"properties": {
"source": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName"
}
},
"tags": {
"myTag1": "tagValue1"
}
}
},
"responses": {
"200": {
"body": {
"name": "myRpc",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
"type": "Microsoft.Compute/restorePointCollections",
"location": "norwayeast",
"tags": {
"myTag1": "tagValue1"
},
"properties": {
"source": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
"location": "eastus"
},
"restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c",
"provisioningState": "Successful"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

provisioningState ==> Change Successful to Succeeded.

}
}
},
"201": {
"body": {
"name": "myRpc",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
"type": "Microsoft.Compute/restorePointCollections",
"location": "norwayeast",
"tags": {
"myTag1": "tagValue1"
},
"properties": {
"source": {
"id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName",
"location": "eastus"
},
"restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c",
"provisioningState": "Successful"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

provisioningState ==> Change Successful to Succeeded.

}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
{
"parameters": {
"subscriptionId": "{subscription-id}",
"resourceGroupName": "myResourceGroup",
"restorePointCollectionName": "rpcName",
"restorePointName": "rpName",
"api-version": "2021-11-01",
"expand": "instanceView"
},
"responses": {
"200": {
"body": {
"name": "rpName",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
"properties": {
"excludeDisks": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f"
}
],
"sourceMetadata": {
"vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
"hardwareProfile": {
"vmSize": "Standard_B1s"
},
"storageProfile": {
"osDisk": {
"osType": "Windows",
"name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f",
"caching": "ReadWrite",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
},
"diskRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
}
},
"dataDisks": [
{
"lun": 1,
"name": "testingexcludedisk_DataDisk_1",
"caching": "None",
"managedDisk": {
"storageAccountType": "Standard_LRS",
"id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"
},
"diskRestorePoint": {
"id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"
}
}
]
},
"osProfile": {
"computerName": "computerName",
"adminUsername": "admin",
"windowsConfiguration": {
"provisionVMAgent": true,
"enableAutomaticUpdates": true
},
"secrets": [],
"allowExtensionOperations": true,
"requireGuestProvisionSignal": true
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": true
}
},
"location": "westus"
},
"provisioningState": "Succeeded",
"consistencyMode": "ApplicationConsistent",
"timeCreated": "2021-01-27T20:35:05.8401519+00:00",
"instanceView": {
"diskRestorePoints": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57",
"replicationStatus": {
"status": {
"code": "ReplicationState/succeeded",
"level": "Info",
"displayStatus": "Succeeded"
},
"completionPercent": 100
}
},
{
"id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5",
"replicationStatus": {
"status": {
"code": "ReplicationState/succeeded",
"level": "Info",
"displayStatus": "Succeeded"
},
"completionPercent": 100
}
}
],
"statuses": [
{
"code": "ReplicationState/succeeded",
"level": "Info",
"displayStatus": "Succeeded"
}
]
}
}
}
}
}
}