update swagger and generate examples

[HarshAulakhh]

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

Changelog

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

1. 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
2. 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.
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
   • SDK of .NET (need service team to ensure code readiness)
   • SDK of Python
   • SDK of Java
   • SDK of Js
   • SDK of Go
   • PowerShell
   • CLI
   • Terraform
   • No refresh required for updates in this PR

Contribution checklist:

• 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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

• Removing API(s) in a stable version
• Removing properties in a stable version
• Removing API version(s) in a stable version
• Updating API in a stable or public preview version with Breaking Change Validation errors
• Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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

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

[openapi-pipeline-app]

Swagger Validation Report

️❌BreakingChange: 25 Errors, 15 Warnings failed [Detail]

compared swaggers (via Oad v0.9.6)]	new version	base version
elasticsan.json	2021-11-20(01220be)	2021-11-20(main)

Only 30 items are listed, please refer to log for more details.

Rule	Message
❌ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'ForceDeleteVolumesParameter' removed or renamed? New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1010:3 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1001:3
❌ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'ForceDeleteVolumeGroupsParameter' removed or renamed? New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1010:3 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1001:3
❌ 1019 - RemovedEnumValue	The new version is removing enum value(s) 'Standard_LRS, Standard_ZRS' from the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1495:9 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1521:9
❌ 1019 - RemovedEnumValue	The new version is removing enum value(s) 'Standard' from the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1517:9 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1548:9
❌ 1019 - RemovedEnumValue	The new version is removing enum value(s) 'EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys' from the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1627:9 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1666:9
❌ 1019 - RemovedEnumValue	The new version is removing enum value(s) 'EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys' from the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1671:9 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1710:9
❌ 1019 - RemovedEnumValue	The new version is removing enum value(s) 'FromVolume, FromDiskSnapshot, Export' from the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1788:9 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1827:9
❌ 1019 - RemovedEnumValue	The new version is removing enum value(s) 'EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys' from the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1864:5 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1919:5
❌ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1336:9 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1349:9
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'name' renamed or removed? Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1520:7
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'tier' renamed or removed? Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1520:7
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'san' renamed or removed? New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1335:7 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1348:7
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'maxIopsPerGiB' renamed or removed? New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1434:7 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1448:7
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'maxMBpsPerGiB' renamed or removed? New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1434:7 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1448:7
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'maxConnectedClientCount' renamed or removed? New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1434:7 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1448:7
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'provisionedMBps' renamed or removed? New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1199:7 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1208:7
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'location' renamed or removed? New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1571:7 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1610:7
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'location' renamed or removed? New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1688:7 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1727:7
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'maxIops' renamed or removed? New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1374:7 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1382:7
❌ 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'iopsPerBaseGiB' in response that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1434:7 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1448:7
❌ 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'totalSizeTiB' in response that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1199:7 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1208:7
❌ 1041 - AddedPropertyInResponse	The new version has a new property 'elasticSan' in response that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1335:7 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1348:7
❌ 1045 - AddedOptionalProperty	The new version has a new optional property 'totalSizeTiB' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1199:7 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1208:7
❌ 1046 - RemovedOptionalParameter	The optional parameter 'x-ms-delete-volumegroups' was removed in the new version. Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L342:9
❌ 1046 - RemovedOptionalParameter	The optional parameter 'x-ms-delete-volumes' was removed in the new version. Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L612:9
⚠️ 1026 - TypeChanged	The new version has a different type 'array' than the previous one 'object'. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1336:9 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1349:9
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1600:11 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1639:11
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L514:13 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L502:13
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L526:13 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L514:13
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L532:13 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L520:13

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

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2021-11-20-preview	package-2021-11-20-preview(01220be)	package-2021-11-20-preview(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R1001 - OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Volumes' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L964
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1114

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️⚠️SDK Track2 Validation: 3 Warnings warning [Detail]

• The following tags are being changed in this PR
• elasticsan/resource-manager/readme.md#package-2021-11-20-preview

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ IgnoredPropertyNextToRef	"readme":"elasticsan/resource-manager/readme.md", "tag":"package-2021-11-20-preview", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ResourceTypeSku > properties > elasticSan)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"elasticsan/resource-manager/readme.md", "tag":"package-2021-11-20-preview", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ResourceTypeSku > properties > volumeGroup)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"elasticsan/resource-manager/readme.md", "tag":"package-2021-11-20-preview", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ResourceTypeSku > properties > volume)\n keys: [ \u001b[32m'type'\u001b[39m ]"
💬	"readme":"elasticsan/resource-manager/readme.md", "tag":"package-2021-11-20-preview", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)"
💬	"readme":"elasticsan/resource-manager/readme.md", "tag":"package-2021-11-20-preview", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"
💬	"readme":"elasticsan/resource-manager/readme.md", "tag":"package-2021-11-20-preview", "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)"
💬	"readme":"elasticsan/resource-manager/readme.md", "tag":"package-2021-11-20-preview", "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"
💬	"readme":"elasticsan/resource-manager/readme.md", "tag":"package-2021-11-20-preview", "details":"Autorest completed in 11.61s. 0 files generated."

The following errors/warnings exist before current PR submission:

|:speech_balloon: |"readme":"elasticsan/resource-manager/readme.md",
"tag":"package-2021-11-20-preview",
"details":"AutoRest core version selected from configuration: ^3.2.0."|

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

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

Validation passes for CadlValidation.

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

[openapi-pipeline-app]

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account. 

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️✔️azure-sdk-for-go - armelasticsans - 0.1.0
️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-elasticsan - first release

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

• ️✔️Succeeded [Logs]Release - Generate from efb0537. 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
  warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
  command	pwsh ./eng/scripts/Automation-Sdk-Generate.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

• ️✔️Azure.ResourceManager.ElasticSan [View full logs]  [Release SDK Changes]
  • Azure.ResourceManager.ElasticSan.1.0.0-alpha.20220705.1.nupkg
  • Azure.ResourceManager.ElasticSan.1.0.0-alpha.20220705.1.symbols.nupkg

  info	[Changelog]

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

• ⚠️Warning [Logs]Release - Generate from efb0537. 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]  global `--global`, `--local` are deprecated. Use `--location=global` instead.
  cmderr	[automation_generate.sh] npm notice
  cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.11.0 -> 8.13.2
  cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.13.2>
  cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
  cmderr	[automation_generate.sh] npm notice

• ️✔️track2_azure-mgmt-elasticsan [View full logs]  [Release SDK Changes]
  • azure_mgmt_elasticsan-1.0.0b1-py3-none-any.whl
  • azure-mgmt-elasticsan-1.0.0b1.zip

  info	[Changelog]   - Initial Release

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

• ️✔️Succeeded [Logs]Release - Generate from efb0537. 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
  command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

• ️✔️azure-resourcemanager-elasticsan [View full logs]  [Release SDK Changes]
  • pom.xml
  • azure-resourcemanager-elasticsan-1.0.0-beta.1-sources.jar
  • azure-resourcemanager-elasticsan-1.0.0-beta.1.jar

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

• ️✔️Succeeded [Logs]Release - Generate from efb0537. 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

• ️✔️armelasticsans [View full logs]  [Release SDK Changes]

  info	[Changelog] This is a new package
  info	[Changelog]

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

• ⚠️Warning [Logs]Release - Generate from efb0537. 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
  cmderr	[automation_init.sh]  deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
  cmderr	[automation_init.sh] deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
  cmderr	[automation_init.sh] deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
  cmderr	[automation_init.sh]  deprecated @azure/[email protected]: This version has been deprecated, please upgrade to the version tagged as latest
  cmderr	[automation_init.sh] npm WARN @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
  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-elasticsan [View full logs]  [Release SDK Changes]
  • azure-arm-elasticsan-1.0.0-beta.1.tgz

  info	[Changelog]
  error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

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

[openapi-workflow-bot]

Hi, @HarshAulakhh 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. [email protected]

[openapi-workflow-bot]

Hi @HarshAulakhh, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

[openapi-workflow-bot]

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

[HarshAulakhh]

NewApiVersionRequired reason: A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

Our service is still in development. We have preview coming up in next couple of months. This is a PR to clean up the things that we are not targeting in the private preview. We don't need to introduce a new version as we are still in development. So I hope this can be ignored as per my understanding.