[DO NOT MERGE] Add software update specs by abhinav-ghai · Pull Request #4950 · Azure/azure-rest-api-specs

abhinav-ghai · 2018-12-20T00:31:46Z

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and have all been fixed in this PR.
The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
adding/removing APIs.
adding/removing properties.
adding/removing API-version.
adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Please follow the link to find more details on API review process.

Merge from master

Merge from upstream Azure

openapi-portal-comment · 2018-12-20T00:31:47Z

If you're a MSFT employee, click this link
to view this PR's validation status on our new OpenAPI Hub spec management tool.

AutorestCI · 2018-12-20T00:32:05Z

Automation for azure-sdk-for-js

Nothing to generate for azure-sdk-for-js

azuresdkci · 2018-12-20T00:32:08Z

Can one of the admins verify this patch?

AutorestCI · 2018-12-20T00:32:11Z

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

AutorestCI · 2018-12-20T00:32:12Z

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

AutorestCI · 2018-12-20T00:32:20Z

Automation for azure-sdk-for-python

Nothing to generate for azure-sdk-for-python

AutorestCI · 2018-12-20T00:32:32Z

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

AutorestCI · 2018-12-20T00:32:43Z

Automation for azure-sdk-for-java

Nothing to generate for azure-sdk-for-java

azuresdkci · 2018-12-20T00:32:53Z

Hello!!

The Rest API Specs team wishes everyone a happy holiday and would like to kindly inform you that responses and review to Pull request will be delayed during the holiday period (now -> 2nds of January) to allow for Awesome reviewers to have an awesome time with their families during the holidays!

Thanks and Have a WONDERFUL HOLIDAY

...ger/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftwareUpdates.json

...crosoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftwareUpdateProfile.json

...ger/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftwareUpdates.json

mirichmo · 2018-12-21T19:31:49Z

...crosoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftwareUpdateProfile.json

+          "securityCount": "0",
+          "otherCount": "0",
+          "approvalSource": "",
+          "latestAssessmentTimeTaken": "2018-10-30T17:31:02Z",


This also changed. See https://msazure.visualstudio.com/One/_git/mgmt-automation-agentdataservice?path=%2Fsrc%2FSamples%2FPayload%2FSoftwareUpdatesPayload.json&version=GBmaster

Same for SoftwareUpdateProfile. GuestConfig RP is the source of truth.
https://msazure.visualstudio.com/One/_git/Mgmt-Automation-GuestConfiguration?path=%2Fsrc%2FGuestConfiguration.ViewModel%2FSoftwareUpdateProfileV1.cs&version=GBmaster

Task applies here too.

jianghaolu · 2019-01-07T22:43:52Z

...urce-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

+                "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
+              },
+              {
+                "name": "softwareUpdateId",


This parameter does not exist in the path.

jianghaolu · 2019-01-07T22:45:49Z

...urce-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

      "description": "Reason and code for the compliance of the guest configuration assignment resource."
+    },
+    "SoftwareUpdateProfile": {
+        "description": "The profile of the computer in the context of software updates.",


Please fix the indentations to indent 2 spaces all the way to line 1171.

jianghaolu · 2019-01-07T22:47:14Z

...crosoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftwareUpdateProfile.json

+    "200": {
+      "headers": {},
+      "body": {
+        "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/softwareUpdateProfile/default",


SoftwareUpdateProfile defined here: https://github.com/Azure/azure-rest-api-specs/pull/4950/files#diff-e53a4ef9e8ceed16b91a1997e37815e6R1017 does not have properties "id", "name", "type". Did you forget to inherit it from Resource?

Inherited from Proxy resource now

Inherited from proxy now

ravbhatnagar

@abhinav-ghai please take a look at some minor comments.

ravbhatnagar · 2019-01-14T20:27:52Z

...urce-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

+      "SoftwareUpdateProperties": {
+        "description": "Properties of the software update object.",
+        "properties": {
+          "updateState": {


lets make this as an enum. will work better.

ravbhatnagar · 2019-01-14T20:28:30Z

...urce-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

+            "readOnly": true,
+            "description": "Needed / Installed"
+          },
+          "availableOnComputerSince": {


i think this should be ISO 8601 compliant, please add format property with value as date-time.

ravbhatnagar · 2019-01-14T20:29:24Z

...urce-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

+            "readOnly": true,
+            "description": "Point in time when this update was first seen on this computer"
+          },
+          "approved": {


string enums work much better than bools in the longer run. May be call it "status" with values as approved, rejected etc.

OS specific, might be empty for certain cases. Keeping it string.

ravbhatnagar · 2019-01-14T20:30:35Z

...urce-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

+            "readOnly": true,
+            "description": "Superseded Update Ids"
+          },
+          "isSupercededUpdate": {


this is modeled as a string but looks like you wanted a bool. If yes, same comment as above about bools. string enum will work better.

ravbhatnagar · 2019-01-14T20:30:51Z

...urce-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

+            "readOnly": true,
+            "description": "KB revision number"
+          },
+          "publishedDate": {


format date-time

ravbhatnagar · 2019-01-14T20:32:16Z

...urce-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

+            "readOnly": true,
+            "description": "Reboot behavior"
+          },
+          "optional": {


did you intend this to be a bool? string enum works better.

OS specific, might be empty for certain cases. Keeping it string.

ravbhatnagar · 2019-01-14T20:32:26Z

...urce-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

+            "readOnly": true,
+            "description": "Browse only"
+          },
+          "lastRefreshDate": {


ravbhatnagar · 2019-01-14T20:34:53Z

...urce-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

        ]
      }
+    },
+      "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/softwareUpdateProfile": {


if this is a singleton, add a segment to the URL as below
.../softwareUpdateProfile/{profileName}. Now profileName can be made as an enum with just one possible value which can be called "default". So the name of this singleton would be "default"

ravbhatnagar · 2019-01-14T20:36:03Z

...urce-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

      },
      "description": "Reason and code for the compliance of the guest configuration assignment resource."
+    },
+    "SoftwareUpdateProfile": {


id, name and type top level properties missing. Did you miss a reference to ProxyResource?

Referenced from Proxy now

Added Proxy reference now

ravbhatnagar · 2019-01-14T20:37:22Z

...urce-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json

      },
      "description": "Reason and code for the compliance of the guest configuration assignment resource."
+    },
+    "SoftwareUpdateProfile": {


in the properties, any property which can take a value from a fixed set should be modeled as an enum. Any bools should be modeled as string enum. And and dates, should have "format": "date-time"

date-time reference added where possible, enums considered where possible

Done where possible

jianghaolu · 2019-01-22T19:30:10Z

...crosoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftwareUpdateProfile.json

+    "resourceGroupName": "myResourceGroupName",
+    "vmName": "myVMName",
+    "api-version": "2018-06-30-preview"
+  },


Missing parameter profileName

jianghaolu · 2019-01-22T19:31:31Z

...crosoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftwareUpdateProfile.json

+          "assessmentRuntime": "2018-10-30T17:31:02Z",
+          "oldestMissingSecurityUpdateInDays": "35",
+          "oldestMissingSecurityUpdateBucket": "30 days ago",
+          "lastUpdateApplied": "",


"" is not a valid value for a date-time property

Removed date-time format for this property because this can actually not be a valid date-time in the when updates have never been applied to VM.

jianghaolu · 2019-01-22T19:31:38Z

...crosoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftwareUpdateProfile.json

+          "lastUpdateApplied": "",
+          "updateAssessmentErrors": "The service cannot be started, either because it is disabled or because it has no enabled devices associated with it. (Exception from HRESULT: 0x80070422)",
+          "updateAssessmentErrorStackTrace": "System.Runtime.InteropServices.COMException (0x80070422): ... at Microsoft.EnterpriseManagement.Mom.Modules.ChangeTracking.WUA.UpdateInstallerClass.get_IsBusy() at .....acknowledgeImmediately)",
+          "lastRefreshDate": ""


jianghaolu · 2019-01-22T19:32:06Z

...ager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftwareUpdate.json

+    "vmName": "myVMName",
+    "updateId": "35428702-5784-4ba4-a6e0-5222258b5411",
+    "api-version": "2018-06-30-preview"
+  },


Missing parameter softwareUpdateId.

ravbhatnagar · 2019-01-23T19:21:52Z

Looks good. Signing off from ARM side.

jianghaolu · 2019-01-24T23:36:15Z

Sorry I missed the do not merge notice. Reverting.

This reverts commit b131e9e.

* Add list and get software to GuestConfiguration * Use newer API version for software * Revert software Swagger spec since these are private preview only * Add specs for software update and software profile * Address comments for property type and proxy reference * Address comments for softwareUpdateProfile * Address comments for softwareUpdate

…#5090) This reverts commit b131e9e.

* Onboarding OEP * Fixing CI error * Fixing Prettier * Fixing Linter * Fixing Linter * Fixing Linter issues * Fixing prettier for oep.json * Fixing delete example * Prettier fix * Deleting * Adding * Updating readme.go.md * updated dataPartitionNames with list (#4950) * Review comments * Review comment * Tracked Resource update * Tracked resource name update * Fixing Update Example * Review comment Co-authored-by: ankurrawat66 <91181916+ankurrawat66@users.noreply.github.com>

Abhinav Ghai and others added 6 commits October 26, 2018 17:12

Add list and get software to GuestConfiguration

64b3a99

Use newer API version for software

35a781b

Merge pull request #1 from Azure/master

20198d2

Merge from master

Revert software Swagger spec since these are private preview only

476bbe9

Merge pull request #2 from Azure/master

1527e47

Merge from upstream Azure

Add specs for software update and software profile

ef69c5b

kpajdzik added the review label Dec 20, 2018

azuresdkci assigned jianghaolu Dec 20, 2018

azuresdkci requested a review from jianghaolu December 20, 2018 00:33

sourabhguha reviewed Dec 21, 2018

View reviewed changes

...ger/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftwareUpdates.json Outdated Show resolved Hide resolved

mirichmo reviewed Dec 21, 2018

View reviewed changes

...crosoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftwareUpdateProfile.json Show resolved Hide resolved

mirichmo reviewed Dec 21, 2018

View reviewed changes

...crosoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftwareUpdateProfile.json Show resolved Hide resolved

mirichmo suggested changes Dec 21, 2018

View reviewed changes

jianghaolu suggested changes Jan 7, 2019

View reviewed changes

ravbhatnagar added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 14, 2019

abhinav-ghai changed the title ~~Add software update specs~~ [DO NOT MERGE] Add software update specs Jan 14, 2019

ravbhatnagar reviewed Jan 14, 2019

View reviewed changes

KrisBash added the ARMChangesRequested label Jan 16, 2019

Address comments for property type and proxy reference

ab0cab9

jianghaolu suggested changes Jan 22, 2019

View reviewed changes

Address comments for softwareUpdateProfile

5a2ba55

Address comments for softwareUpdate

b7b4cf8

ravbhatnagar added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 23, 2019

jianghaolu approved these changes Jan 24, 2019

View reviewed changes

jianghaolu merged commit b131e9e into Azure:master Jan 24, 2019

jianghaolu added a commit that referenced this pull request Jan 24, 2019

Revert "[DO NOT MERGE] Add software update specs (#4950)"

3cb6b10

This reverts commit b131e9e.

praries880 pushed a commit that referenced this pull request Jan 25, 2019

Revert "[DO NOT MERGE] Add software update specs (#4950)" (#5090)

28fb8a9

This reverts commit b131e9e.

TalluriAnusha pushed a commit to AsrOneSdk/azure-rest-api-specs that referenced this pull request Feb 6, 2019

Revert "[DO NOT MERGE] Add software update specs (Azure#4950)" (Azure…

696d582

…#5090) This reverts commit b131e9e.

Conversation

abhinav-ghai commented Dec 20, 2018

Latest improvements:

Contribution checklist:

ARM API Review Checklist

Uh oh!

openapi-portal-comment bot commented Dec 20, 2018

Uh oh!

AutorestCI commented Dec 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-js

Uh oh!

azuresdkci commented Dec 20, 2018

Uh oh!

AutorestCI commented Dec 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

AutorestCI commented Dec 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-ruby

Uh oh!

AutorestCI commented Dec 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

AutorestCI commented Dec 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-node

Uh oh!

AutorestCI commented Dec 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-java

Uh oh!

azuresdkci commented Dec 20, 2018

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ravbhatnagar left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

AutorestCI commented Dec 20, 2018 •

edited

Loading

AutorestCI commented Dec 20, 2018 •

edited

Loading

AutorestCI commented Dec 20, 2018 •

edited

Loading

AutorestCI commented Dec 20, 2018 •

edited

Loading

AutorestCI commented Dec 20, 2018 •

edited

Loading

AutorestCI commented Dec 20, 2018 •

edited

Loading