[Compute] ppg show: add --colocation-status to Enable fetching the colocation status of all the resources in the proximity placement group

[qwordy]

#11420

History Notes:
(Fill in the following template if multiple notes are needed, otherwise PR title will be used for history note.)

[Component Name 1] (BREAKING CHANGE:) (az command:) make some customer-facing change.
[Component Name 2] (BREAKING CHANGE:) (az command:) make some customer-facing change.

---

This checklist is used to make sure that common guidelines for a pull request are followed.

• The PR title and description has followed the guideline in Submitting Pull Requests.

• I adhere to the Command Guidelines.

[jiasli]

How about checking the returned JSON?

[jiasli]

Verified the usage of SDK is correct: Lib/site-packages/azure/mgmt/compute/v2019_07_01/operations/_proximity_placement_groups_operations.py:238

    def get(
            self, resource_group_name, proximity_placement_group_name, include_colocation_status=None, custom_headers=None, raw=False, **operation_config):

[mmyyrroonn]

just one question. Should we use g.custom_command? Based on your implementation, I think we can still use command.

[mmyyrroonn]

well. I got your point. It's a required filed. Right? I think you can also set required=False to use it. But this one is fine.

[mmyyrroonn]

if this filed is not required in SDK. I don't think you need change this one. You can just rewrite the c.argument.

[jiasli]

I agree. We don't need to use custom_command. Also we should use show_command and custom_show_command so that the exit code is correctly set to 3 on a 404.

[qwordy]

@myronfanqiu Agree. command() is enough. I didn't realize that there is such an argument. Then I added a new one.

[qwordy]

@jiasli Good advice. An interesting fact is that there is no show_command() is vm module's params. I'll try it.

[arrownj]

In 2.1.0, there is already a --include-colocation-status parameter, why we change the name to --colocation-status ?

(Version 2.1.0)
PS C:\Users\xiaojxu.FAREAST> az ppg show -h

Command
    az ppg show : Get a proximity placement group.

Arguments
    --name -n           [Required] : The name of the proximity placement group.
    --resource-group -g [Required] : Name of resource group. You can configure the default group
                                     using `az configure --defaults group=<name>`.
    --include-colocation-status    : IncludeColocationStatus=true enables fetching the colocation
                                     status of all the resources in the proximity placement group.

Actually the colocation status is already in the REST api response, however we didn't return the value to user.

(Version 2.1.0)
PS C:\Users\xiaojxu.FAREAST> az ppg show -g xiaojianxu -n xxj-ppg-1 --include-colocation-status true --debug
......................
... unrelated logs ...
......................
msrest.http_logger : Request URL: 'https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/xiaojianxu/providers/Microsoft.Compute/proximityPlacementGroups/xxj-ppg-1?includeColocationStatus=true&api-version=2019-07-01'
......................
... unrelated logs ...
......................
msrest.http_logger : {
  "name": "xxj-ppg-1",
  "id": "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/xiaojianxu/providers/Microsoft.Compute/proximityPlacementGroups/xxj-ppg-1",
  "type": "Microsoft.Compute/proximityPlacementGroups",
  "location": "eastasia",
  "tags": {},
  "properties": {
    "proximityPlacementGroupType": "Standard",
    "virtualMachines": [],
    "virtualMachineScaleSets": [],
    "availabilitySets": [],
    "colocationStatus": {
      "code": "ColocationStatus/Aligned",
      "level": "Info",
      "displayStatus": "Aligned",
      "message": "All resources in the proximity placement group are aligned."
    }
  }
}
......................
... unrelated logs ...
......................

We can see that the current REST request already has a includeColocationStatus=true parameter and colocationStatus is already in the response body(properties sections).

After these code changes, I find that the problem still exists. ColocationStatus is still not returned to user. All the behaviors are same with before except we changed the parameter name.

@qwordy , so I think the main work here is how to transfer the value from properties to user.

[qwordy]

@arrownj Your comment has deep insight. Thanks for finding the problem.

[qwordy]

@arrownj This colocation field was added to swagger 2 months ago. The root cause is Python SDK is not up-to-date. CLI will not output response directly, instead, it creates an object using SDK class then output JSON. I need to find someone to publish a new version of SDK.

Latest SDK version is 10.0.0 (2019-11-18).
The field is added on Dec 21, 2019.

[qwordy]

I have requested a Python SDK update.

[arrownj]

We need to wait azure-mgmt-compute upgraded and update the version number in our side. Also it's better to add the check for colocation status property in test.

[qwordy]

We need to wait azure-mgmt-compute upgraded and update the version number in our side. Also it's better to add the check for colocation status property in test.

Done. Upgraded compute SDK to 11.0.0. And added checks in test.