Added fileFormat to GrantAccessData for DD snapshots by shpimpal · Pull Request #23528 · Azure/azure-rest-api-specs

shpimpal · 2023-04-12T13:34:13Z

ARM API Information (Control Plane)

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2023-04-12T13:34:17Z

Hi, @shpimpal Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2023-04-12T13:34:17Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
diskRPCommon.json	2023-01-02(a1d45ba)	2022-07-02(main)

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.1)	new version	base version
package-2023-01-02	package-2023-01-02(a1d45ba)	package-2023-01-02(feature/cplat-2023-01-02)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: DiskRP/stable/2023-01-02/diskRPCommon.json#L40
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: DiskRP/stable/2023-01-02/diskRPCommon.json#L364
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: DiskRP/stable/2023-01-02/diskRPCommon.json#L460
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: DiskRP/stable/2023-01-02/diskRPCommon.json#L542

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2023-01-02

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-04-12T13:34:19Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️⚠️SDK Breaking Change Tracking warning [Detail]

Breaking Changes Tracking

️✔️azure-sdk-for-go - sdk/resourcemanager/compute/armcompute - 5.0.0

+	Field `ID` of struct `VirtualMachineScaleSetIPConfiguration` has been removed
+	Field `ID` of struct `VirtualMachineScaleSetNetworkConfiguration` has been removed

⚠️azure-sdk-for-python-track2 - track2_azure-mgmt-compute - 29.1.0

+	Model VirtualMachineScaleSetIPConfiguration no longer has parameter id
+	Model VirtualMachineScaleSetNetworkConfiguration no longer has parameter id

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 27aacec4ec0a115fa847268f082434d303debf23. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.Compute [View full logs] [Preview SDK Changes]
- Azure.ResourceManager.Compute.1.2.0-alpha.20230504.1.nupkg
```
info	[Changelog]
```

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs] Generate from 27aacec4ec0a115fa847268f082434d303debf23. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.6
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.6>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.6` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-compute [View full logs] [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter computer_name
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter hyper_v_generation
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter os_name
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter os_version
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Model VirtualMachineScaleSetIPConfiguration no longer has parameter id
info	[Changelog]   - Model VirtualMachineScaleSetNetworkConfiguration no longer has parameter id

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs] Generate from 27aacec4ec0a115fa847268f082434d303debf23. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-compute-generated [View full logs] [Preview SDK Changes]

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 27aacec4ec0a115fa847268f082434d303debf23. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-compute [View full logs] [Preview SDK Changes]

azure-arm-compute-20.1.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Type Alias FileFormat
info	[Changelog]   - Interface GrantAccessData has a new optional parameter fileFormat
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter computerName
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter hyperVGeneration
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter osName
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter osVersion
info	[Changelog]   - Added Enum KnownFileFormat
info	[Changelog]   - Enum KnownStorageAccountType has a new value StandardSSDLRS

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 27aacec4ec0a115fa847268f082434d303debf23. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/compute/armcompute [View full logs] [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Field `ID` of struct `VirtualMachineScaleSetIPConfiguration` has been removed
info	[Changelog] - Field `ID` of struct `VirtualMachineScaleSetNetworkConfiguration` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New enum type `FileFormat` with values `FileFormatVHD`, `FileFormatVHDX`
info	[Changelog] - New field `FileFormat` in struct `GrantAccessData`
info	[Changelog]
info	[Changelog] Total 2 breaking change(s), 4 additive change(s).

️❌ azure-resource-manager-schemas failed [Detail]

❌Failed [Logs] Generate from 27aacec4ec0a115fa847268f082434d303debf23. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json

❌compute/resource-manager [View full logs] [Preview Schema Changes]

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs] Generate from 27aacec4ec0a115fa847268f082434d303debf23. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

❌Az.compute.DefaultTag [View full logs]

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.compute.DefaultTag

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-04-12T13:34:19Z

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.Compute	https://apiview.dev/Assemblies/Review/0901c7e73c4c4cf69dae5099deef9bb9
Go	sdk/resourcemanager/compute/armcompute	https://apiview.dev/Assemblies/Review/a985b76fe25b4f53badba6d0cf9058b4
Java	azure-resourcemanager-compute-generated	https://apiview.dev/Assemblies/Review/62dac0e68a184d978a9b04d9ee07cc57
.Net	Azure.ResourceManager.Compute	https://apiview.dev/Assemblies/Review/6b9a1c5f624c45f6a53b0aea150841d3
JavaScript	@azure/arm-compute	https://apiview.dev/Assemblies/Review/e74593d235cb4ff39801490c42c6e83b

ghost · 2023-04-12T13:34:23Z

Thank you for your contribution shpimpal! We will review the pull request and get back to you soon.

openapi-workflow-bot · 2023-04-20T15:26:13Z

Hi, @shpimpal your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

sjanamma · 2023-04-20T15:58:31Z

      "type": "boolean",

ARM recommends enums over booleans for future proof APIs.

Standard guidance is: replace boolean/switch properties with a more meaningful enum whenever possible.
A boolean will forever have two valid values (true or false). A string enum type is always preferred. Also, properties should always provide better values just than True and False. For example two switches "isTypeA" and "isTypeB" should be replaced with one enum "type": [A, B, DefaultType]. Enums are always a more flexible and future proof option because they allow additional values to be added in the future in a non-breaking way, e.g. [Enabled, Disabled, Suspended, Deallocated].
Note: do NOT define a 'boolean enum' with two values 'True and False'. This might be easier to 'extend' in terms of types, but semantically its cofusing, and no better than a boolean.

Refers to: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-01-02/diskRPCommon.json:41 in 3caf9cb. [](commit_id = 3caf9cb, deletion_comment = False)

sjanamma · 2023-04-20T15:59:56Z

      "type": "boolean",

same comment as above for booleans. Enum usage is recommended

Refers to: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-01-02/diskRPCommon.json:365 in 3caf9cb. [](commit_id = 3caf9cb, deletion_comment = False)

sjanamma · 2023-04-20T16:02:55Z

I do not see nay paths created yet. Also, none of the objects are modeled as ARM resources. I do not think this PR is ready for ARM reviews.

Refers to: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-01-02/diskRPCommon.json:609 in 3caf9cb. [](commit_id = 3caf9cb, deletion_comment = False)

openapi-workflow-bot · 2023-04-20T16:03:22Z

Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

...cation/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-01-02/diskRPCommon.json

Added fileFormat to GrantAccessData

17ce882

ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Apr 12, 2023

ghost added the Compute label Apr 12, 2023

shpimpal changed the title ~~Added fileFormat to GrantAccessData~~ Added fileFormat to GrantAccessData for DD snapshots Apr 12, 2023

azure-sdk mentioned this pull request Apr 12, 2023

[AutoPR sdk/resourcemanager/compute/armcompute] Added fileFormat to GrantAccessData for DD snapshots azure-sdk/azure-sdk-for-go#5270

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Apr 12, 2023

azure-sdk mentioned this pull request Apr 12, 2023

[AutoPR compute/resource-manager] Added fileFormat to GrantAccessData for DD snapshots azure-sdk/azure-resource-manager-schemas#2402

Draft

AzureRestAPISpecReview added the resource-manager label Apr 12, 2023

shpimpal marked this pull request as ready for review April 18, 2023 10:20

shpimpal requested review from MS-syh2qs, Sandido, dkulkarni-ms, grizzlytheodore, haagha, hyonholee and madewithsmiles as code owners April 18, 2023 10:20

Added VHDX word to custom-words

3caf9cb

openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Apr 20, 2023

sjanamma added the ARMChangesRequested label Apr 20, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 20, 2023

sjanamma removed the ARMChangesRequested label Apr 20, 2023

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 20, 2023

sjanamma added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Apr 21, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 21, 2023

chetmaddula reviewed Apr 24, 2023

View reviewed changes

...cation/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-01-02/diskRPCommon.json Show resolved Hide resolved

Added examples

a1d45ba

azure-sdk mentioned this pull request May 4, 2023

[AutoPR track2_azure-mgmt-compute] Added fileFormat to GrantAccessData for DD snapshots azure-sdk/azure-sdk-for-python#3453

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label May 4, 2023

haagha merged commit 86d06da into Azure:feature/cplat-2023-01-02 May 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added fileFormat to GrantAccessData for DD snapshots#23528

Added fileFormat to GrantAccessData for DD snapshots#23528
haagha merged 3 commits intoAzure:feature/cplat-2023-01-02from
shpimpal:dev/shpimpal/DdSnapshotFileFormat

shpimpal commented Apr 12, 2023 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Apr 12, 2023

Uh oh!

openapi-pipeline-app bot commented Apr 12, 2023 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Apr 12, 2023 •

edited

Loading

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Apr 12, 2023 •

edited

Loading

Uh oh!

ghost commented Apr 12, 2023

Uh oh!

openapi-workflow-bot bot commented Apr 20, 2023

Uh oh!

sjanamma commented Apr 20, 2023

Uh oh!

sjanamma commented Apr 20, 2023

Uh oh!

sjanamma commented Apr 20, 2023

Uh oh!

openapi-workflow-bot bot commented Apr 20, 2023

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Comments

Conversation

shpimpal commented Apr 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Apr 12, 2023

Uh oh!

openapi-pipeline-app bot commented Apr 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Apr 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Apr 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

ghost commented Apr 12, 2023

Uh oh!

openapi-workflow-bot bot commented Apr 20, 2023

Uh oh!

sjanamma commented Apr 20, 2023

Uh oh!

sjanamma commented Apr 20, 2023

Uh oh!

sjanamma commented Apr 20, 2023

Uh oh!

openapi-workflow-bot bot commented Apr 20, 2023

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Comments

shpimpal commented Apr 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 12, 2023 •

edited

Loading