ARM ID annotations for MySQL

[matthchr]

Uses the new arm-id format to describe fields which are references to other ARM resources.

This was split off from #18318

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-workflow-bot]

Hi, @matthchr 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]

Swagger Validation Report

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

compared swaggers (via Oad v0.9.6)]	new version	base version
mysql.json	2021-05-01(63cc8bc)	2021-05-01(main)

Rule	Message
❌ 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1683:9 Old: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1683:9
❌ 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1695:9 Old: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1687:9

️️✔️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-flexibleserver-2021-05-01	package-flexibleserver-2021-05-01(63cc8bc)	package-flexibleserver-2021-05-01(main)

The following errors/warnings exist before current PR submission:

Rule	Message
❌ R4037 - MissingTypeObject	The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2717
❌ R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2324
❌ R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2374
❌ R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2422
❌ R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2476
❌ R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2484
❌ R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2519
❌ R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2533
❌ R4041 - XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2703
⚠️ R1003 - ListInOperationName	Since operation 'ConfigurationsBatchUpdate' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1154
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'updateconfigurations' in:'Configurations_BatchUpdate'. Consider updating the operationId Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1154
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checkvirtualnetworksubnetusage' in:'CheckVirtualNetworkSubnetUsage_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1299
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1347
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailabilityWithoutLocation_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1395
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'getprivatednszonesuffix' in:'GetPrivateDnsZoneSuffix_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1440
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2583
⚠️ R4020 - DescriptiveDescriptionRequired	The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L2623
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Restart a server Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L383
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Check name availability Location: Microsoft.DBforMySQL/stable/2021-05-01/mysql.json#L1396

️⚠️Avocado: 1 Warnings warning [Detail]

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

️️✔️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: 0 Warnings warning [Detail]

• The following tags are being changed in this PR
• "https://github.com/Azure/azure-rest-api-specs/blob/63cc8bcd607dfb83f15ecfc25487471f835b4f7c/specification/mysql/resource-manager/readme.md#tag-package-flexibleserver-2021-05-01">mysql/resource-manager/readme.md#package-flexibleserver-2021-05-01

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ UnkownSecurityScheme	"readme":"mysql/resource-manager/readme.md", "tag":"package-flexibleserver-2021-05-01", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"

️️✔️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-python-track2 - track2_azure-mgmt-rdbms - 10.2.0b1
️✔️azure-sdk-for-go - armmysql - 1.0.1
️✔️azure-sdk-for-go - armmysqlflexibleservers - 1.1.0-beta.1

️❌ azure-sdk-for-net failed [Detail]

• ❌Failed [Logs]Release - Generate from 9e8a3d8. SDK Automation 14.0.0

  warn	Skip initScript due to not configured
  command	sudo apt-get install -y dotnet-sdk-6.0
  command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/mysql/resource-manager/readme.md
  cmderr	[Autorest] realpath(): Permission denied
  cmderr	[Autorest] realpath(): Permission denied
  cmderr	[Autorest] realpath(): Permission denied
  cmderr	[Autorest] realpath(): Permission denied
  cmderr	[Autorest] realpath(): Permission denied
  cmderr	[Autorest] realpath(): Permission denied
  cmderr	[Autorest] No usable version of the libssl was found
  cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
  cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
  cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
  error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
  warn	Skip package processing as generation is failed

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

• ⚠️Warning [Logs]Release - Generate from 9e8a3d8. 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]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.

• ️✔️track2_azure-mgmt-rdbms [View full logs]  [Release SDK Changes]
  • azure_mgmt_rdbms-10.2.0b2-py3-none-any.whl
  • azure-mgmt-rdbms-10.2.0b2.zip

  info	[Changelog] **Features**
  info	[Changelog]
  info	[Changelog]   - Added operation group AzureADAdministratorsOperations
  info	[Changelog]   - Added operation group CheckNameAvailabilityWithoutLocationOperations

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

• ️✔️Succeeded [Logs]Release - Generate from 9e8a3d8. 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-mysqlflexibleserver [View full logs]  [Release SDK Changes]
  • pom.xml
  • azure-resourcemanager-mysqlflexibleserver-1.0.0-beta.3-sources.jar
  • azure-resourcemanager-mysqlflexibleserver-1.0.0-beta.3.jar

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

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

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

  info	[Changelog] ### Other Changes
  info	[Changelog]
  info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

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

  info	[Changelog] ### Features Added
  info	[Changelog]
  info	[Changelog] - New const `ResetAllToDefaultTrue`
  info	[Changelog] - New const `ResetAllToDefaultFalse`
  info	[Changelog] - New const `AdministratorTypeActiveDirectory`
  info	[Changelog] - New const `AdministratorNameActiveDirectory`
  info	[Changelog] - New function `NewAzureADAdministratorsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*AzureADAdministratorsClient, error)`
  info	[Changelog] - New function `PossibleResetAllToDefaultValues() []ResetAllToDefault`
  info	[Changelog] - New function `*LogFilesClient.NewListByServerPager(string, string, *LogFilesClientListByServerOptions) *runtime.Pager[LogFilesClientListByServerResponse]`
  info	[Changelog] - New function `*AzureADAdministratorsClient.BeginDelete(context.Context, string, string, AdministratorName, *AzureADAdministratorsClientBeginDeleteOptions) (*runtime.Poller[AzureADAdministratorsClientDeleteResponse], error)`
  info	[Changelog] - New function `PossibleAdministratorTypeValues() []AdministratorType`
  info	[Changelog] - New function `PossibleAdministratorNameValues() []AdministratorName`
  info	[Changelog] - New function `*BackupsClient.Put(context.Context, string, string, string, *BackupsClientPutOptions) (BackupsClientPutResponse, error)`
  info	[Changelog] - New function `*AzureADAdministratorsClient.Get(context.Context, string, string, AdministratorName, *AzureADAdministratorsClientGetOptions) (AzureADAdministratorsClientGetResponse, error)`
  info	[Changelog] - New function `NewLogFilesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*LogFilesClient, error)`
  info	[Changelog] - New function `*AzureADAdministratorsClient.NewListByServerPager(string, string, *AzureADAdministratorsClientListByServerOptions) *runtime.Pager[AzureADAdministratorsClientListByServerResponse]`
  info	[Changelog] - New function `*CheckNameAvailabilityWithoutLocationClient.Execute(context.Context, NameAvailabilityRequest, *CheckNameAvailabilityWithoutLocationClientExecuteOptions) (CheckNameAvailabilityWithoutLocationClientExecuteResponse, error)`
  info	[Changelog] - New function `NewCheckNameAvailabilityWithoutLocationClient(string, azcore.TokenCredential, *arm.ClientOptions) (*CheckNameAvailabilityWithoutLocationClient, error)`
  info	[Changelog] - New function `*AzureADAdministratorsClient.BeginCreateOrUpdate(context.Context, string, string, AdministratorName, AzureADAdministrator, *AzureADAdministratorsClientBeginCreateOrUpdateOptions) (*runtime.Poller[AzureADAdministratorsClientCreateOrUpdateResponse], error)`
  info	[Changelog] - New struct `AdministratorListResult`
  info	[Changelog] - New struct `AdministratorProperties`
  info	[Changelog] - New struct `AzureADAdministrator`
  info	[Changelog] - New struct `AzureADAdministratorsClient`
  info	[Changelog] - New struct `AzureADAdministratorsClientBeginCreateOrUpdateOptions`
  info	[Changelog] - New struct `AzureADAdministratorsClientBeginDeleteOptions`
  info	[Changelog] - New struct `AzureADAdministratorsClientCreateOrUpdateResponse`
  info	[Changelog] - New struct `AzureADAdministratorsClientDeleteResponse`
  info	[Changelog] - New struct `AzureADAdministratorsClientGetOptions`
  info	[Changelog] - New struct `AzureADAdministratorsClientGetResponse`
  info	[Changelog] - New struct `AzureADAdministratorsClientListByServerOptions`
  info	[Changelog] - New struct `AzureADAdministratorsClientListByServerResponse`
  info	[Changelog] - New struct `BackupsClientPutOptions`
  info	[Changelog] - New struct `BackupsClientPutResponse`
  info	[Changelog] - New struct `CheckNameAvailabilityWithoutLocationClient`
  info	[Changelog] - New struct `CheckNameAvailabilityWithoutLocationClientExecuteOptions`
  info	[Changelog] - New struct `CheckNameAvailabilityWithoutLocationClientExecuteResponse`
  info	[Changelog] - New struct `LogFile`
  info	[Changelog] - New struct `LogFileListResult`
  info	[Changelog] - New struct `LogFileProperties`
  info	[Changelog] - New struct `LogFilesClient`
  info	[Changelog] - New struct `LogFilesClientListByServerOptions`
  info	[Changelog] - New struct `LogFilesClientListByServerResponse`
  info	[Changelog] - New field `ResetAllToDefault` in struct `ConfigurationListForBatchUpdate`
  info	[Changelog] - New field `Version` in struct `ServerPropertiesForUpdate`
  info	[Changelog] - New field `Keyword` in struct `ConfigurationsClientListByServerOptions`
  info	[Changelog] - New field `Page` in struct `ConfigurationsClientListByServerOptions`
  info	[Changelog] - New field `PageSize` in struct `ConfigurationsClientListByServerOptions`
  info	[Changelog] - New field `Tags` in struct `ConfigurationsClientListByServerOptions`
  info	[Changelog] - New field `Location` in struct `VirtualNetworkSubnetUsageResult`
  info	[Changelog] - New field `SubscriptionID` in struct `VirtualNetworkSubnetUsageResult`
  info	[Changelog]
  info	[Changelog] Total 0 breaking change(s), 67 additive change(s).

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

• ⚠️Warning [Logs]Release - Generate from 9e8a3d8. 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
  warn	No file changes detected after generation
  warn	No package detected after generation

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

• ⚠️Warning [Logs]Release - Generate from 9e8a3d8. 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

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

️❌ azure-powershell failed [Detail]

• ❌Failed [Logs]Release - Generate from 9e8a3d8. 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

• ❌Az.mysql [View full logs]  [Release SDK Changes]

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

[openapi-workflow-bot]

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

[matthchr]

.NET SDK for reference. This PR is a superset of the .NET SDK arm-ids, which should be OK because the MySQL .NET SDK isn't GA yet.