"az snapshot grant-access" fails with "Accessing disk or snapshot with a logical sector size of 4096 requires specifying the file format. Set the fileFormat property to VHDX."

[riccom76]

Describe the bug

CLI cmdlet "az snapshot grant-access", using APIs equal or later than 2023-01-02, fails with "Accessing disk or snapshot with a logical sector size of 4096 requires specifying the file format. Set the fileFormat property to VHDX".

[ ~ ]$ az snapshot grant-access --duration-in-seconds 3600 --resource-group martinme_repro --name premV2Snap (BadRequest) Accessing disk or snapshot with a logical sector size of 4096 requires specifying the file format. Set the fileFormat property to VHDX. Code: BadRequest Message: Accessing disk or snapshot with a logical sector size of 4096 requires specifying the file format. Set the fileFormat property to VHDX.

When trying to pass the "fileFormat" as parameter for CMDLets, an error is returned saying the 'fileFormat' isn't valid.

[ ~ ]$ az snapshot grant-access --duration-in-seconds 3600 --resource-group martinme_repro --name premV2Snap --fileFormat VHDX unrecognized arguments: --fileFormat VHDX

Tested with RESTAPI --> Snapshots - Grant Access - REST API (Azure Compute) | Microsoft Learn
The supported api-versions are '2016-04-30-preview, 2017-03-30, 2018-04-01, 2018-06-01, 2018-09-30, 2019-03-01, 2019-07-01, 2019-11-01, 2020-05-01, 2020-06-30, 2020-09-30, 2020-12-01, 2021-04-01, 2021-08-01, 2021-12-01, 2022-03-02, 2022-07-02, 2023-01-02, 2023-04-02, 2023-10-02'

• SUCCESS: I've tried it again with the RestAPI by specifying with the fileFormat set to VHDX in the body and it works with the latest API version 2023-10-02 as well: Snapshots - Grant Access - REST API (Azure Compute) | Microsoft Learn
• {access: "Read",durationInSeconds: "3600",fileFormat: "VHDX"} --

"az snapshot grant-access", using APIs equal or later than 2023-01-02, do not offer any parameter to define the "fileFormat".

RestAPI Snapshots - Grant Access - REST API (Azure Compute) | Microsoft Learn accepts the "fileFormat" as parameter. CLI cmdlet should do the same.

Related command

az snapshot grant-access --duration-in-seconds 3600 --resource-group martinme_repro --name premV2Snap

Errors

[ ~ ]$ az snapshot grant-access --duration-in-seconds 3600 --resource-group martinme_repro --name premV2Snap --fileFormat VHDX
unrecognized arguments: --fileFormat VHDX

Issue script & Debug output

Expected behavior

"az snapshot grant-access", using APIs equal or later than 2023-01-02, do not offer any parameter to define the "fileFormat".

RestAPI Snapshots - Grant Access - REST API (Azure Compute) | Microsoft Learn accepts the "fileFormat" as parameter. CLI cmdlet should do the same.

Environment Summary

Azure Portal CloudShell

Additional context

No response

[yonzhan]

Thank you for opening this issue, we will look into it.

[yanzhudd]

Hi @riccom76,
currently CLI has no parameter to set the field "fileFormat". If you want CLI to support this feature, please provide the necessary info by raising a feature request using this feature request template.

[riccom76]

hi @yanzhudd , this is not a feature request but more a fix to a misalignment between the CLI cmdlet parameters and what the RestAPI version used is expecting as parameters when invoked.

RestAPI Snapshots - Grant Access - REST API (Azure Compute) | Microsoft Learn vesion equal or later than 2023-01-02, expects the "fileFormat" to be there. This CLI cmdlet has to be updated to accommodate what the RestAPI expects as passed parameters.

[yanzhudd]

Hi @riccom76
I have raised a PR to fix this issue, could you please help to verify if this private package meets your expectation?
https://dev.azure.com/azclitools/public/_build/results?buildId=140563&view=artifacts&pathAsName=false&type=publishedArtifacts

Thanks in advance!