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

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

Merged
merged 16 commits into from
Dec 1, 2018
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 @@ -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
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