Update 2023-05-01-preview version with changes from 2023-04-01 version.

[ajtiwari07]

ARM API Information (Control Plane)

Swagger PR for new api verison 2023-04-01 was merged together with 2023-05-01-preview version.
Hence, this PR is to update 2023-05-01-preview version with property introduced in v2023-04-01.

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:

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.
   This new api version is deployed to all regions.
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
   As soon as the new api version is updated in swagger.
4. 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]

Hi, @ajtiwari07 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-pipeline-app]

Swagger Validation Report

️❌BreakingChange: 3 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
redis.json	2023-05-01-preview(7fb2f76)	2023-05-01-preview(main)

Rule	Message
❌ 1041 - AddedPropertyInResponse	The new version has a new property 'storage-subscription-id' in response that was not found in the old version. New: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2169:11 Old: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2169:11
❌ 1045 - AddedOptionalProperty	The new version has a new optional property 'storage-subscription-id' that was not found in the old version. New: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2711:7 Old: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2707:7
❌ 1045 - AddedOptionalProperty	The new version has a new optional property 'storage-subscription-id' that was not found in the old version. New: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2740:7 Old: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2732:7

️️✔️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 v2.0.1)	new version	base version
package-preview-2023-05	package-preview-2023-05(7fb2f76)	package-preview-2023-05(main)

The following errors/warnings exist before current PR submission:

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

Rule	Message
❌ OperationsApiResponseSchema	The response schema of operations API '/providers/Microsoft.Cache/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L57
❌ PathResourceTypeNameCamelCase	Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability' Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L73
❌ CreateOperationAsyncResponseValidation	An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L173
❌ LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L285
❌ DeleteOperationAsyncResponseValidation	An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L299
❌ LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L333
❌ PostOperationAsyncResponseValidation	An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L630
❌ LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L670
❌ PostOperationAsyncResponseValidation	An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L689
❌ LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L729
❌ ResourceNameRestriction	The resource name parameter 'ruleName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L793
❌ TrackedResourcePatchOperation	Tracked resource 'RedisPatchSchedule' must have patch operation that at least supports the update of tags. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L1000
❌ ResourceNameRestriction	The resource name parameter 'linkedServerName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L1194
❌ CreateOperationAsyncResponseValidation	An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L1195
❌ DeleteOperationAsyncResponseValidation	An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L1262
❌ GetCollectionResponseSchema	The response in the GET collection operation 'PrivateEndpointConnections_List' does not match the response definition in the individual GET operation 'PrivateEndpointConnections_Get' . Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L1420
❌ ResourceNameRestriction	The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L1465
❌ CreateOperationAsyncResponseValidation	An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L1509
❌ CreateOperationAsyncResponseValidation	An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L1708
❌ CreateOperationAsyncResponseValidation	An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L1916
❌ MissingTypeObject	The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2125
❌ MissingTypeObject	The schema 'RedisCommonProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2165
❌ MissingTypeObject	The schema 'RedisCreateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2310
❌ MissingTypeObject	The schema 'RedisUpdateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2342
❌ MissingTypeObject	The schema 'RedisProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2357
❌ ProvisioningStateValidation	ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2359
❌ MissingTypeObject	The schema 'RedisCreateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2440
❌ MissingTypeObject	The schema 'RedisUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2480
❌ MissingTypeObject	The schema 'RedisAccessKeys' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2501
❌ MissingTypeObject	The schema 'RedisFirewallRule' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/preview/2023-05-01-preview/redis.json#L2516

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

Validation passes for Avocado.

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

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️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.

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

Validation passed for PoliCheck.

️️✔️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.

️️✔️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]

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-net-track2 succeeded [Detail] [Expand]

• ️✔️Succeeded [Logs]Release - Generate from 4a7af0d. 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.Redis [View full logs]  [Release SDK Changes]
  • Azure.ResourceManager.Redis.1.2.0-alpha.20230509.1.nupkg

  info	[Changelog]

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

• ⚠️Warning [Logs]Release - Generate from 4a7af0d. 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]  notice
  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 [email protected]` to update!
  cmderr	[automation_generate.sh] npm notice

• ️✔️track2_azure-mgmt-redis [View full logs]  [Release SDK Changes]
  • azure-mgmt-redis-12.0.0b1.zip
  • azure_mgmt_redis-12.0.0b1-py3-none-any.whl

  info	[Changelog] ### Features Added
  info	[Changelog]
  info	[Changelog]   - Model ExportRDBParameters has a new parameter storage_subscription_id
  info	[Changelog]   - Model ImportRDBParameters has a new parameter storage_subscription_id
  info	[Changelog]   - Model RedisCommonPropertiesRedisConfiguration has a new parameter storage_subscription_id

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

• ⚠️Warning [Logs]Release - Generate from 4a7af0d. 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-redis-generated [View full logs]  [Release SDK Changes]
  • pom.xml
  • azure-resourcemanager-redis-generated-1.0.0-beta.1.jar
  • azure-resourcemanager-redis-generated-1.0.0-beta.1-sources.jar

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

• ️✔️Succeeded [Logs]Release - Generate from 4a7af0d. 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/redis/armredis [View full logs]  [Release SDK Changes]

  info	[Changelog] ### Features Added
  info	[Changelog]
  info	[Changelog] - New field `StorageSubscriptionID` in struct `CommonPropertiesRedisConfiguration`
  info	[Changelog] - New field `StorageSubscriptionID` in struct `ExportRDBParameters`
  info	[Changelog] - New field `StorageSubscriptionID` in struct `ImportRDBParameters`
  info	[Changelog]
  info	[Changelog] Total 0 breaking change(s), 3 additive change(s).

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

• ️✔️Succeeded [Logs]Release - Generate from 4a7af0d. 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-rediscache [View full logs]  [Release SDK Changes]
  • azure-arm-rediscache-7.2.0.tgz

  info	[Changelog] **Features**
  info	[Changelog]
  info	[Changelog]   - Interface ExportRDBParameters has a new optional parameter storageSubscriptionId
  info	[Changelog]   - Interface ImportRDBParameters has a new optional parameter storageSubscriptionId
  info	[Changelog]   - Interface RedisCommonPropertiesRedisConfiguration has a new optional parameter storageSubscriptionId

️⚠️ azure-resource-manager-schemas warning [Detail]

• ⚠️Warning [Logs]Release - Generate from 4a7af0d. 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] WARN 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

• ️✔️redis [View full logs]  [Release Schema Changes]

️❌ azure-powershell failed [Detail]

• ❌Pipeline Framework Failed [Logs]Release - Generate from 4a7af0d. 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.redis.DefaultTag [View full logs] 
  • Az.Redis.0.1.0.nupkg

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

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

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/redis/armredis	Create ApiView failed. Please ask PR assignee for help
Java	azure-resourcemanager-redis-generated	Create ApiView failed. Please ask PR assignee for help
.Net	Azure.ResourceManager.Redis	https://apiview.dev/Assemblies/Review/0ef652cd207d4d1ca39aa7a2c9f54c34
JavaScript	@azure/arm-rediscache	https://apiview.dev/Assemblies/Review/2d871930e71c4d26b8ff437d4f6f6b2b

[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.

[openapi-workflow-bot]

Hi @ajtiwari07, 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.

[live1206]

my team have two API versions v2023-04-01 and v2023-05-01-preview that unfortunately got merged together. So I have created a separate PR to update 2023-05-01-preview version with a property introduced in v2023-04-01.

Above is the comment @ajtiwari07 left in Teams chat, the user would like to update the existing preview version instead of new version, which needs breaking change review.