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.

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

OS History API - Swagger #2743

Merged
merged 4 commits into from
Apr 11, 2018
Merged

OS History API - Swagger #2743

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1d00c59
added OS History for 12-01
Mar 23, 2018
fd4e857
modified Json file
Apr 9, 2018
2c66a61
changed description
Apr 9, 2018
169017e
removed PIR to use exiting ImageRef
Apr 10, 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
181 changes: 181 additions & 0 deletions specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2709,6 +2709,48 @@
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory": {
"get": {
"tags": [
"VirtualMachineScaleSets"
],
"operationId": "VirtualMachineScaleSets_GetOSUpgradeHistory",
"description": "Gets list of OS upgrades on a VM scale set instance.",
"parameters": [
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group."
},
{
"name": "vmScaleSetName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the VM scale set."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/VirtualMachineScaleSetListOSUpgradeHistory"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff": {
"post": {
Expand Down Expand Up @@ -7121,6 +7163,145 @@
],
"description": "The Virtual Machine Scale Set List Skus operation response."
},
"UpgradeOperationHistoryStatus": {
"properties": {
"code": {
"type": "string",
"readOnly": true,
"description": "Code indicating the current status of the upgrade.",
"enum": [
"RollingForward",
"Cancelled",
"Completed",
"Faulted"
],
"x-ms-enum": {
"name": "UpgradeState",
"modelAsString": false
}
},
"startTime": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "Start time of the upgrade."
},
"endTime": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "Start time of the upgrade."
Copy link
Contributor

Choose a reason for hiding this comment

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

"End time of the upgrade"

}
},
"description": "Information about the current running state of the overall upgrade."
},
"PlatformImageReference": {
"properties": {
"publisher": {
"readOnly": true,
"type": "string",
"description": "Image publisher"
},
"offer": {
"readOnly": true,
"type": "string",
"description": "Offer type"
},
"sku": {
"readOnly": true,
"type": "string",
"description": "Sku type"
},
"version": {
"readOnly": true,
"type": "string",
"description": "Version of the image"
},
"uri": {
"readOnly": true,
"type": "string",
"description": "Specifies the virtual hard disk's uri."
}
},
"description": "A reference that identifies a CRP-PIR image or a UserVMImage."
},
"UpgradeOperationHistoricalStatusInfoProperties": {
"properties": {
"runningStatus": {
"$ref": "#/definitions/UpgradeOperationHistoryStatus",
"readOnly": true,
"description": "Information about the overall status of the upgrade operation."
},
"progress": {
"$ref": "#/definitions/RollingUpgradeProgressInfo",
"readOnly": true,
"description": "Counts of the VM's in each state."
},
"error": {
"$ref": "#/definitions/ApiError",
"readOnly": true,
"description": "Error Details for this upgrade if there are any."
},
"startedBy": {
"readOnly": true,
"type": "string",
"description": "Error Details for this upgrade if there are any.",
Copy link
Contributor

Choose a reason for hiding this comment

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

Update the description

"enum": [
"Unknown",
"User",
"Platform"
],
"x-ms-enum": {
"name": "UpgradeOperationInvoker",
"modelAsString": false
}
},
"targetImageReference": {
"$ref": "#/definitions/PlatformImageReference",
"readOnly": true,
"description": "Error Details for this upgrade if there are any."
}
},
"description": "Describes each OS upgrade on the Virtual Machine Scale Set."
},
"UpgradeOperationHistoricalStatusInfo": {
"properties": {
"properties": {
"$ref": "#/definitions/UpgradeOperationHistoricalStatusInfoProperties",
"readOnly": true,
"description": "Information about the properties of the upgrade operation."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Resource type"
},
"location": {
"type": "string",
Copy link
Contributor

Choose a reason for hiding this comment

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

"readOnly": true,

"description": "Resource location"
}
},
"description": "Virtual Machine Scale Set OS Upgrade History operation response."
Copy link
Contributor

Choose a reason for hiding this comment

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

NIT: fix indent

},
"VirtualMachineScaleSetListOSUpgradeHistory": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/UpgradeOperationHistoricalStatusInfo"
},
"description": "The list of OS upgrades performed on the virtual machine scale set."
},
"nextLink": {
"type": "string",
"description": "The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades."
}
},
"required": [
"value"
],
"description": "List of Virtual Machine Scale Set OS Upgrade History operation response."
},
"VirtualMachineScaleSetVMProperties": {
"properties": {
"latestModelApplied": {
Expand Down