compute VirtualMachines_ListAll OBJECT_MISSING_REQUIRED_PROPERTY

[ctaggart]

The latest specs for compute #14223 #12334 have Swagger correctness bugs that break deserialization with the Azure SDK for Rust Azure/azure-sdk-for-rust#54. In this case, it looks to be a bug in the Swagger spec. The API does not send back the required location.. The definition should probably be SubResourceReadOnly instead of Resource. See #14458.

[ghost]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @Drewm3, @amjads1.

Issue Details

---

The latest specs for compute #14223 #12334 have Swagger correctness bugs that break deserialization with the Azure SDK for Rust Azure/azure-sdk-for-rust#54. In this case, it looks to be a bug in the Swagger spec. The API does not send back the required location.. The definition should probably be SubResourceReadOnly instead of Resource. See #14458.

Author:	ctaggart
Assignees:	akning-ms, Sandido
Labels:	Compute - Extensions, Compute - VM, Service Attention
Milestone:	-

[Vaibhav-Agar]

@avirishuv can you please have a look?

[avirishuv]

Following up to investigate this.

[avirishuv]

quick update: this is added to the backlog for bugfix, will provide an update here when it gets picked up.

[avirishuv]

quick update: the fix is still in progress.

[avirishuv]

fix rollout is yet to be completed for this issue.

[cataggar]

I'm able to reproduce the api-version 2021-11-01. I'll try to break down the problem a bit more. The operation VirtualMachines_ListAll returns a list of VirtualMachine definitions.

azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/compute.json

Lines 13880 to 13897 in f635d0f

	"VirtualMachine": {
	"properties": {
	"plan": {
	"$ref": "#/definitions/Plan",
	"description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**."
	},
	"properties": {
	"x-ms-client-flatten": true,
	"$ref": "#/definitions/VirtualMachineProperties"
	},
	"resources": {
	"readOnly": true,
	"type": "array",
	"items": {
	"$ref": "#/definitions/VirtualMachineExtension"
	},
	"description": "The virtual machine child extension resources."
	},

Each VirtualMachine has a resources element that contains an array of VirtualMachineExtensionImage:

azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/compute.json

Lines 11089 to 11106 in f635d0f

	"VirtualMachineExtensionImage": {
	"properties": {
	"properties": {
	"x-ms-client-flatten": true,
	"$ref": "#/definitions/VirtualMachineExtensionImageProperties"
	}
	},
	"required": [
	"name",
	"location"
	],
	"allOf": [
	{
	"$ref": "#/definitions/Resource"
	}
	],
	"description": "Describes a Virtual Machine Extension Image."
	},

Use your favorite tool or SDK to list VMs. An example request is
GET /subscriptions/7f1fae41-7708-4fa4-89b3-f6552cad2fc1/providers/Microsoft.Compute/virtualMachines?api-version=2021-11-01

One of the resources starts off like this:

      "resources": [
        {
          "id": "/subscriptions/7f1fae41-7708-4fa4-89b3-f6552cad2fc1/resourceGroups/AAGILLCS/providers/Microsoft.Compute/virtualMachines/tnt42-mgmt-p01-eastus2-incumbentVm/extensions/Microsoft.Azure.Monitor.AzureMonitorLinuxAgent"
        },
        {
          "id": "/subscriptions/7f1fae41-7708-4fa4-89b3-f6552cad2fc1/resourceGroups/AAGILLCS/providers/Microsoft.Compute/virtualMachines/tnt42-mgmt-p01-eastus2-incumbentVm/extensions/Microsoft.Azure.Security.Monitoring.AzureSecurityLinuxAgent"
        }

Notice that it only includes the id field. That does not match this definition:

    "Resource": {
      "description": "The Resource model definition.",
      "properties": {
        "id": {
          "readOnly": true,
          "type": "string",
          "description": "Resource Id"
        },
        "name": {
          "readOnly": true,
          "type": "string",
          "description": "Resource name"
        },
        "type": {
          "readOnly": true,
          "type": "string",
          "description": "Resource type"
        },
        "location": {
          "type": "string",
          "description": "Resource location"
        },
        "tags": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Resource tags"
        }
      },
      "required": [
        "location"
      ],
      "x-ms-azure-resource": true
    },

A location field is required for a Resource. I think the implementation actually matches a SubResourceReadOnly:

    "SubResourceReadOnly": {
      "properties": {
        "id": {
          "readOnly": true,
          "type": "string",
          "description": "Resource Id"
        }
      },
      "x-ms-azure-resource": true
    },

[grizzlytheodore]

Assigned myself this, as I am taking ownership of this issue

[grizzlytheodore]

@cataggar thank you for the comment and attention.

Changing from 'Resource' to 'SubResourceReadOnly' will remove 'name', 'type', 'location', and 'tags' property.
However, a VMExtension object has those properties inherently from the backend.
Utilizing PowerShell cmdlet, if I do:

PS C:\Users\thchan> Get-AzVMExtension -ResourceGroupName theo_test -VMName vmsdk

ResourceGroupName       : theo_test
VMName                  : vmsdk
Name                    : Microsoft.Azure.Geneva.GenevaMonitoring
Location                : eastus2
Etag                    : null
Publisher               : Microsoft.Azure.Geneva
ExtensionType           : GenevaMonitoring
TypeHandlerVersion      : 2.0
Id                      : /subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/theo_test/providers/Micros
                          oft.Compute/virtualMachines/VmSdk/extensions/Microsoft.Azure.Geneva.GenevaMonitoring
PublicSettings          : {}
ProtectedSettings       :
ProvisioningState       : Succeeded
Statuses                :
SubStatuses             :
AutoUpgradeMinorVersion : True
ForceUpdateTag          :
EnableAutomaticUpgrade  : True

ResourceGroupName       : theo_test
VMName                  : vmsdk
Name                    : Microsoft.Azure.Security.AntimalwareSignature.AntimalwareConfiguration
Location                : eastus2
Etag                    : null
Publisher               : Microsoft.Azure.Security.AntimalwareSignature
ExtensionType           : AntimalwareConfiguration
TypeHandlerVersion      : 2.0
Id                      : /subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/theo_test/providers/Micros
                          oft.Compute/virtualMachines/VmSdk/extensions/Microsoft.Azure.Security.AntimalwareSignature.An
                          timalwareConfiguration
PublicSettings          : {}
ProtectedSettings       :
ProvisioningState       : Succeeded
Statuses                :
SubStatuses             :
AutoUpgradeMinorVersion : True
ForceUpdateTag          :
EnableAutomaticUpgrade  : True

You can see them present.

I am exploring another solution: creating a new object called "ResouceWithOptionalLocation" which has the same properties but without having location tagged as 'required'. You can see my change 'here' I am working with the Swagger team for this changes impact on SDKs (track 2 and 1). I will keep you updated.

[cataggar]

I see. That makes sense. Thanks @grizzlytheodore.

[grizzlytheodore]

PR made to resolve: #18487
it will be released with CRP 2022-03-01 version