Skip to content

Adding swagger change for virtual machine patching instance view #10216

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
merged 9 commits into from
Aug 5, 2020
Merged

Adding swagger change for virtual machine patching instance view #10216

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c30a5e9
Adding swagger change for virtual machine patching instance view
jemex Jul 21, 2020
8026630
adding fix for the check
jemex Jul 22, 2020
cd0c90e
change after runing the prettier check
jemex Jul 23, 2020
503f5e4
updating the descriptions
jemex Jul 24, 2020
805ca3c
Adding missing property for installation Summary
jemex Jul 24, 2020
1fc482e
updating the name of the property
jemex Jul 28, 2020
f6716ba
fixing the validation check failure
jemex Jul 28, 2020
bada88a
addressing feedback
jemex Jul 30, 2020
96fe111
removing the configurePatchSummary
jemex Aug 4, 2020
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
210 changes: 209 additions & 1 deletion specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8884,6 +8884,10 @@
"$ref": "#/definitions/InstanceViewStatus"
},
"description": "The resource status information."
},
"patchStatus": {
"$ref": "#/definitions/VirtualMachinePatchStatus",
"description": "The status of virtual machine patch operations."
}
},
"description": "The instance view of a virtual machine."
Expand Down Expand Up @@ -11537,7 +11541,7 @@
"properties": {
"patchMode": {
"type": "string",
"description": "Specifies the mode of in-guest patching to IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false<br /><br /> **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. <br /><br /> ** AutomaticByPlatform** - the virtual machine will automatically updated by the OS. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ",
"description": "Specifies the mode of in-guest patching to IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false<br /><br /> **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. <br /><br /> ** AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ",
"enum": [
"Manual",
"AutomaticByOS",
Expand All @@ -11549,6 +11553,210 @@
}
}
}
},
"VirtualMachinePatchStatus": {
"properties": {
"availablePatchSummary": {
"$ref": "#/definitions/AvailablePatchSummary",
"description": "The available patch summary of the latest assessment operation for the virtual machine."
},
"lastPatchInstallationSummary": {
"$ref": "#/definitions/LastPatchInstallationSummary",
"description": "The installation summary of the latest installation operation for the virtual machine."
},
"configurationStatusSummary": {
"$ref": "#/definitions/ConfigurationStatusSummary",
"description": "The configuration status summary for the virtual machine."
}
},
"description": "The status of virtual machine patch operations."
},
"AvailablePatchSummary": {
"properties": {
"status": {
"type": "string",
"readOnly": true,
"description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"",
"enum": [
"InProgress",
"Failed",
"Succeeded",
"CompletedWithWarnings"
],
"x-ms-enum": {
"name": "PatchOperationStatus",
"modelAsString": true
}
},
"assessmentActivityId": {
"type": "string",
"readOnly": true,
"description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs."
Copy link
Contributor

@mirichmo mirichmo Jul 28, 2020

Choose a reason for hiding this comment

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

Remove the second sentence. That is a note for our code, not a generic API user.

},
"rebootPending": {
"type": "boolean",
"readOnly": true,
"description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred."
Copy link
Contributor

@mirichmo mirichmo Jul 28, 2020

Choose a reason for hiding this comment

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

"Whether a reboot was pending due to an installation operation, but the reboot had not yet taken place at the time of the assessment. When true, it indicates that partially installed patches require a reboot to complete their installation."

},
"criticalAndSecurityPatchCount": {
"type": "integer",
"readOnly": true,
"format": "int32",
"description": "The number of critical or security patches that have been detected as available and not yet installed."
},
"otherPatchCount": {
"type": "integer",
"readOnly": true,
"format": "int32",
"description": "The number of all available patches excluding critical and security."
},
"startTime": {
"type": "string",
"readOnly": true,
"format": "date-time",
"description": "The UTC timestamp when the operation began."
},
"lastModifiedTime": {
"type": "string",
"readOnly": true,
"format": "date-time",
"description": "The UTC timestamp when the operation began."
Copy link
Contributor

@mirichmo mirichmo Jul 28, 2020

Choose a reason for hiding this comment

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

"The UTC timestamp of the last update of the operation results."

Applies to all "lastModifiedTime" descriptions

},
"error": {
"$ref": "#/definitions/ApiError",
"readOnly": true,
"description": "The errors that were encountered during execution of the operation. The details array contains the list of them."
}
},
"description": "Describes the properties of an virtual machine instance view for available patch summary."
},
"LastPatchInstallationSummary": {
"properties": {
"status": {
"type": "string",
"readOnly": true,
"description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"",
"enum": [
"InProgress",
"Failed",
"Succeeded",
"CompletedWithWarnings"
],
"x-ms-enum": {
"name": "PatchOperationStatus",
"modelAsString": true
}
},
"installationActivityId": {
"type": "string",
"readOnly": true,
"description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs."
Copy link
Contributor

@mirichmo mirichmo Jul 28, 2020

Choose a reason for hiding this comment

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

Remove the second sentence

},
"maintenanceWindowExceeded": {
"type": "boolean",
"readOnly": true,
"description": "Describes whether the operation ran out of time before it completed all its intended actions"
Copy link
Contributor

@mirichmo mirichmo Jul 28, 2020

Choose a reason for hiding this comment

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

Add a "." at the end

},
"rebootStatus": {
"type": "string",
"readOnly": true,
"description": "The reboot status of the machine after the patch operation. It will be in \"NotNeeded\" status if reboot is not needed after the patch operation. \"Required\" will be the status once the patch is applied and machine is required to reboot. \"Started\" will be the reboot status when the machine has started to reboot. \"Failed\" will be the status if the machine is failed to reboot. \"Completed\" will be the status once the machine is rebooted successfully",
"enum": [
"NotNeeded",
"Required",
"Started",
"Failed",
"Completed"
],
"x-ms-enum": {
"name": "RebootStatus",
"modelAsString": true
}
},
"notSelectedPatchCount": {
"type": "integer",
"readOnly": true,
"format": "int32",
"description": "The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry."
Copy link
Contributor

@mirichmo mirichmo Jul 28, 2020

Choose a reason for hiding this comment

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

"The count of available patches that didn't match a classification or inclusion list entry of the operation. Unmatched available patches are not selected for installation."

},
"excludedPatchCount": {
"type": "integer",
"readOnly": true,
"format": "int32",
"description": "The number of all available patches but excluded explicitly by a customer-specified exclusion list match."
Copy link
Contributor

@mirichmo mirichmo Jul 28, 2020

Choose a reason for hiding this comment

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

"The count of available patches explicitly excluded through and exclusion list."

},
"pendingPatchCount": {
"type": "integer",
"readOnly": true,
"format": "int32",
"description": "The number of all available patches expected to be installed over the course of the patch installation operation."
Copy link
Contributor

@mirichmo mirichmo Jul 28, 2020

Choose a reason for hiding this comment

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

For this description and the rest of the counts:
Use the term "count" instead of number.

},
"installedPatchCount": {
"type": "integer",
"readOnly": true,
"format": "int32",
"description": "The count of patches that successfully installed."
},
"failedPatchCount": {
"type": "integer",
"readOnly": true,
"format": "int32",
"description": "The count of patches that failed installation."
},
"startTime": {
"type": "string",
"readOnly": true,
"format": "date-time",
"description": "The UTC timestamp when the operation began."
},
"lastModifiedTime": {
"type": "string",
"readOnly": true,
"format": "date-time",
"description": "The UTC timestamp when the operation began."
},
"startedBy": {
"type": "string",
"readOnly": true,
"description": "The person or system account that started the operation"
},
"error": {
"$ref": "#/definitions/ApiError",
"readOnly": true,
"description": "The errors that were encountered during execution of the operation. The details array contains the list of them."
}
},
"description": "Describes the properties of the last installed patch summary."
},
"ConfigurationStatusSummary": {
"properties": {
"patchModeProvisioningState": {
"type": "string",
"readOnly": true,
"description": "Describes the enablement status of the specified patchMode of a VM.. \"Unknown\" is the state when the status is unknown. \"Pending\" indicates that required configuration of the VM has not yet completed. \"Ready\" indicates that the VM is configured as specified by its patchMode.",
"enum": [
"Unknown",
"Pending",
"Ready"
],
"x-ms-enum": {
"name": "patchModeProvisioningState",
"modelAsString": true
}
},
"lastModifiedTime": {
"type": "string",
"readOnly": true,
"format": "date-time",
"description": "The UTC timestamp when the operation began."
},
"error": {
"$ref": "#/definitions/ApiError",
"readOnly": true,
"description": "The errors that were encountered during execution of the operation. The details array contains the list of them."
}
},
"description": "Describes the properties of the last detected patch configuration status."
}
},
"parameters": {
Expand Down
29 changes: 29 additions & 0 deletions ...e-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineInstanceView.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,35 @@
}
],
"hyperVGeneration": "V1",
"patchStatus": {
"availablePatchSummary": {
"status": "Succeeded",
"assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968",
"rebootPending": true,
"criticalAndSecurityPatchCount": 1,
"otherPatchCount": 2,
"startTime": "2020-04-24T21:02:04.2556154Z",
"error": null
},
"lastPatchInstallationSummary": {
"status": "Succeeded",
"maintenanceWindowExceeded": false,
"rebootStatus": "Completed",
"notSelectedPatchCount": 1,
"excludedPatchCount": 1,
"pendingPatchCount": 1,
"installedPatchCount": 1,
"failedPatchCount": 1,
"startTime": "2020-04-24T21:02:04.2556154Z",
"lastModifiedTime": "2020-04-24T21:02:04.2556154Z",
"startedBy": "platform",
"error": null
},
"configurationStatusSummary": {
"lastModifiedTime": "2020-04-24T21:02:04.2556154Z",
"patchModeProvisioningState": "Ready"
}
},
"statuses": [
{
"code": "ProvisioningState/succeeded",
Expand Down