Skip to content

updated Reimage API documentation in compute json for ephemeral os disks #4644

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.

Sign up for GitHub

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

Merged
lmazuel merged 16 commits into from
Dec 1, 2018
Merged

updated Reimage API documentation in compute json for ephemeral os disks #4644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
fa03850
Added diffDiskSettings property as part of Swagger changes needed for…
hari-bodicherla Sep 18, 2018
2f52195
updated comment
hari-bodicherla Sep 18, 2018
3286411
updated swagger specs for diffdisksettings property
hari-bodicherla Sep 19, 2018
f8934d4
updated swagger spec comments for diff disk settings [property
hari-bodicherla Sep 21, 2018
6fdc54f
added example to create Diff OS disk scaleset
hari-bodicherla Sep 21, 2018
1adb5e3
Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs
hari-bodicherla Sep 21, 2018
474d5b0
updated 2018-10-01 version specs with diffdisk property
hari-bodicherla Sep 21, 2018
59315ed
added example file for creating VM with diffdisksettings property
hari-bodicherla Sep 24, 2018
4f1e089
Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs
hari-bodicherla Sep 24, 2018
41e9b0d
Merge remote-tracking branch 'upstream/master'
hari-bodicherla Oct 18, 2018
80e525c
updated swagger changes for reimage operation in single vm
hari-bodicherla Oct 19, 2018
27378b6
update examples
hari-bodicherla Oct 24, 2018
af7abc6
udpated examples
hari-bodicherla Oct 24, 2018
adb0812
fixed validation errors
hari-bodicherla Oct 24, 2018
5dfa8d2
Merge remote-tracking branch 'upstream/master'
hari-bodicherla Dec 1, 2018
4711b30
updated comments for reimage operation documentation
hari-bodicherla Dec 1, 2018
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
20 changes: 10 additions & 10 deletions specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1566,7 +1566,7 @@
"Create a custom-image vm from an unmanaged generalized os image.": {
"$ref": "./examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json"
},
"Create a vm with differencing os disk.": {
"Create a vm with ephemeral os disk.": {
"$ref": "./examples/CreateAVmWithADiffOsDisk.json"
}
}
Expand Down Expand Up @@ -2143,7 +2143,7 @@
"VirtualMachines"
],
"operationId": "VirtualMachines_Reimage",
"description": "Reimages (upgrade the operating system) virtual machine. This operation is only supported for differencing OS disks.",
"description": "Reimages the virtual machine which has an ephemeral OS disk back to its initial state.",
"parameters": [
{
"name": "resourceGroupName",
Expand Down Expand Up @@ -2321,7 +2321,7 @@
"Create a scale set with virtual machines in different zones.": {
"$ref": "./examples/CreateAScaleSetWithVMsInDifferentZones.json"
},
"Create a scale set with differencing os disks.": {
"Create a scale set with ephemeral os disks.": {
"$ref": "./examples/CreateAScaleSetWithDiffOsDisk.json"
}
}
Expand Down Expand Up @@ -3239,7 +3239,7 @@
"VirtualMachineScaleSets"
],
"operationId": "VirtualMachineScaleSets_Reimage",
"description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.",
"description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.",
"parameters": [
{
"name": "resourceGroupName",
Expand Down Expand Up @@ -4918,7 +4918,7 @@
"properties": {
"tempDisk": {
"type": "boolean",
"description": "Specified whether to reimage temp disk. Default value: false."
"description": "Specifies whether to reimage temp disk. Default value: false."
}
},
"description": "Paramaters for Reimaging Virtual Machine. Default value for OSDisk : true."
Expand Down Expand Up @@ -5309,7 +5309,7 @@
},
"DiffDiskOption": {
"type": "string",
"description": "Specifies the differencing disk option for operating system disk.",
"description": "Specifies the ephemeral disk option for operating system disk.",
"enum": [
"Local"
],
Expand All @@ -5322,10 +5322,10 @@
"properties": {
"option": {
"$ref": "#/definitions/DiffDiskOption",
"description": "Specifies the differencing disk settings for operating system disk."
"description": "Specifies the ephemeral disk settings for operating system disk."
}
},
"description": "Describes the parameters of differencing disk settings that can be be specified for operating system disk. <br><br> NOTE: The differencing disk settings can only be specified for managed disk."
"description": "Describes the parameters of ephemeral disk settings that can be be specified for operating system disk. <br><br> NOTE: The ephemeral disk settings can only be specified for managed disk."
},
"ManagedDiskParameters": {
"properties": {
Expand Down Expand Up @@ -5381,7 +5381,7 @@
},
"diffDiskSettings": {
"$ref": "#/definitions/DiffDiskSettings",
"description": "Specifies the differencing Disk Settings for the operating system disk used by the virtual machine."
"description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine."
},
"createOption": {
"$ref": "#/definitions/CreateOption",
Expand Down Expand Up @@ -6552,7 +6552,7 @@
},
"diffDiskSettings": {
"$ref": "#/definitions/DiffDiskSettings",
"description": "Specifies the differencing Disk Settings for the operating system disk used by the virtual machine scale set."
"description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set."
},
"diskSizeGB": {
"type": "integer",
Expand Down
24 changes: 12 additions & 12 deletions specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1566,7 +1566,7 @@
"Create a custom-image vm from an unmanaged generalized os image.": {
"$ref": "./examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json"
},
"Create a vm with differencing os disk.": {
"Create a vm with ephemeral os disk.": {
"$ref": "./examples/CreateAVmWithADiffOsDisk.json"
}
}
Expand Down Expand Up @@ -2143,7 +2143,7 @@
"VirtualMachines"
],
"operationId": "VirtualMachines_Reimage",
"description": "Reimages (upgrade the operating system) virtual machine. This operation is only supported for differencing OS disks.",
"description": "Reimages the virtual machine which has an ephemeral OS disk back to its initial state.",
"parameters": [
{
"name": "resourceGroupName",
Expand All @@ -2152,7 +2152,7 @@
"type": "string",
"description": "The name of the resource group."
},
{
{
"name": "vmName",
"in": "path",
"required": true,
Expand Down Expand Up @@ -2321,7 +2321,7 @@
"Create a scale set with virtual machines in different zones.": {
"$ref": "./examples/CreateAScaleSetWithVMsInDifferentZones.json"
},
"Create a scale set with differencing os disks.": {
"Create a scale set with ephemeral os disks.": {
"$ref": "./examples/CreateAScaleSetWithDiffOsDisk.json"
}
}
Expand Down Expand Up @@ -3239,7 +3239,7 @@
"VirtualMachineScaleSets"
],
"operationId": "VirtualMachineScaleSets_Reimage",
"description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.",
"description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.",
"parameters": [
{
"name": "resourceGroupName",
Expand Down Expand Up @@ -4933,10 +4933,10 @@
"properties": {
"tempDisk": {
"type": "boolean",
"description": "Specified whether to reimage temp disk. Default value: false."
"description": "Specifies whether to reimage temp disk. Default value: false."
}
},
"description": "Paramaters for Reimaging Virtual Machine. Default value for OSDisk : true."
"description": "Paramaters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged"
},
"VirtualMachineCaptureParameters": {
"properties": {
Expand Down Expand Up @@ -5324,7 +5324,7 @@
},
"DiffDiskOption": {
"type": "string",
"description": "Specifies the differencing disk option for operating system disk.",
"description": "Specifies the ephemeral disk option for operating system disk.",
"enum": [
"Local"
],
Expand All @@ -5337,10 +5337,10 @@
"properties": {
"option": {
"$ref": "#/definitions/DiffDiskOption",
"description": "Specifies the differencing disk settings for operating system disk."
"description": "Specifies the ephemeral disk settings for operating system disk."
}
},
"description": "Describes the parameters of differencing disk settings that can be be specified for operating system disk. <br><br> NOTE: The differencing disk settings can only be specified for managed disk."
"description": "Describes the parameters of ephemeral disk settings that can be be specified for operating system disk. <br><br> NOTE: The ephemeral disk settings can only be specified for managed disk."
},
"ManagedDiskParameters": {
"properties": {
Expand Down Expand Up @@ -5396,7 +5396,7 @@
},
"diffDiskSettings": {
"$ref": "#/definitions/DiffDiskSettings",
"description": "Specifies the differencing Disk Settings for the operating system disk used by the virtual machine."
"description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine."
},
"createOption": {
"$ref": "#/definitions/CreateOption",
Expand Down Expand Up @@ -6567,7 +6567,7 @@
},
"diffDiskSettings": {
"$ref": "#/definitions/DiffDiskSettings",
"description": "Specifies the differencing Disk Settings for the operating system disk used by the virtual machine scale set."
"description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set."
},
"diskSizeGB": {
"type": "integer",
Expand Down