MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.3k stars 21.48k forks source link

[Azure DevTest Labs ] "Add a VM using an image from the attached shared image gallery " refers to an unexisting req body `properties.SharedImageId` #124851

Open ggorge-etiqa opened 1 week ago

ggorge-etiqa commented 1 week ago

The Azure DevTest Labs documentation about how to "Add a VM using an image from the attached shared image gallery" refers to a PUT method on virtual machines request body property properties.SharedImageId that is not documented.

image

See : https://learn.microsoft.com/en-us/azure/devtest-labs/add-vm-use-shared-image and https://github.com/MicrosoftDocs/azure-docs/blame/0f620e6ac197ef0c3ecdc9c7778e533bbbb931ea/articles/devtest-labs/add-vm-use-shared-image.md#L53

Here is the link of the AZ DevTest Labs virtual machines REST API: https://learn.microsoft.com/en-us/rest/api/dtl/virtual-machines/create-or-update?view=rest-dtl-2018-09-15&tabs=HTTP#request-body where properties.SharedImageId does not exists.

Below is the error when using the undocumented request body property with python sdk:

azure.core.exceptions.HttpResponseError: (MissingRequiredProperties) One of the following properties must be specified: customImageId, galleryImageReference.
Code: MissingRequiredProperties
Message: One of the following properties must be specified: customImageId, galleryImageReference.

ms.author: @rosemalcolm author: @RoseHJM ms.custom: UpdateFrequency2

TPavanBalaji commented 1 week ago

@ggorge-etiqa Thanks for your feedback! We will investigate and update as appropriate.