azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Add files via upload

Open tezhangmsvan opened this issue 3 years ago • 11 comments

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:

  1. What's the purpose of the update?
    • [ ] new service onboarding
    • [x] 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. 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):

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

ARM API Review Checklist

Applicability: :warning:

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:

  • [x] 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.
  • [x] 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.

  • [x] 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.

tezhangmsvan avatar Dec 21 '22 00:12 tezhangmsvan

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

    Swagger Validation Report

    ️❌BreakingChange: 3 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    Configurations.json 2021-12-01-preview(99a9f1d) 2021-12-01-preview(main)
    Rule Message
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L49:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L49:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L105:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L105:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L446:5
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L446:5
    ️❌Breaking Change(Cross-Version): 157 Errors, 93 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    AzureADAdministrator.json 2022-09-30-preview(99a9f1d) 2021-12-01-preview(main)
    Backups.json 2022-09-30-preview(99a9f1d) 2021-12-01-preview(main)
    Configurations.json 2022-09-30-preview(99a9f1d) 2021-12-01-preview(main)
    Databases.json 2022-09-30-preview(99a9f1d) 2021-12-01-preview(main)
    FirewallRules.json 2022-09-30-preview(99a9f1d) 2021-12-01-preview(main)
    FlexibleServers.json 2022-09-30-preview(99a9f1d) 2021-12-01-preview(main)
    LogFiles.json 2022-09-30-preview(99a9f1d) 2021-12-01-preview(main)
    PrivateEndpointConnections.json 2022-09-30-preview(99a9f1d) 2018-06-01(main)
    PrivateEndpointConnections.json 2022-09-30-preview(99a9f1d) 2018-06-01-privatepreview(main)
    PrivateLinkResources.json 2022-09-30-preview(99a9f1d) 2018-06-01(main)
    PrivateLinkResources.json 2022-09-30-preview(99a9f1d) 2018-06-01-privatepreview(main)
    ServiceOperations.json 2022-09-30-preview(99a9f1d) 2021-12-01-preview(main)

    The following breaking changes are detected by comparison with the latest stable version:

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

    Rule Message
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}' removed or restructured?
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json#L37:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/privateEndpointConnections' removed or restructured?
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json#L251:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/privateLinkResources' removed or restructured?
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateLinkResources.json#L37:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/privateLinkResources/{groupName}' removed or restructured?
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateLinkResources.json#L82:5
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'PrivateEndpointProperty' removed or renamed?
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L251:3
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json#L297:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'PrivateLinkServiceConnectionStateProperty' removed or renamed?
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L251:3
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json#L297:3
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L625:5
    Old: common-types/resource-management/v1/types.json#L551:5
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L625:5
    Old: common-types/resource-management/v1/types.json#L551:5
    1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
    New: common-types/resource-management/v4/privatelinks.json#L38:7
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json#L301:7
    1025 - RequiredStatusChange The 'required' status changed from the old version('True') to the new version('False').
    New: common-types/resource-management/v4/privatelinks.json#L67:7
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json#L333:7
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v4/privatelinks.json#L12:9
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json#L320:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
    New: common-types/resource-management/v4/privatelinks.json#L76:9
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json#L342:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
    New: common-types/resource-management/v4/privatelinks.json#L156:9
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json#L369:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
    New: common-types/resource-management/v4/privatelinks.json#L169:9
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateLinkResources.json#L137:9
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'nextLink' renamed or removed?
    New: common-types/resource-management/v4/privatelinks.json#L155:7
    Old: Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json#L368:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'code' renamed or removed?
    New: common-types/resource-management/v4/types.json#L306:7
    Old: common-types/resource-management/v1/types.json#L289:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'message' renamed or removed?
    New: common-types/resource-management/v4/types.json#L306:7
    Old: common-types/resource-management/v1/types.json#L289:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'target' renamed or removed?
    New: common-types/resource-management/v4/types.json#L306:7
    Old: common-types/resource-management/v1/types.json#L289:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'details' renamed or removed?
    New: common-types/resource-management/v4/types.json#L306:7
    Old: common-types/resource-management/v1/types.json#L289:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'additionalInfo' renamed or removed?
    New: common-types/resource-management/v4/types.json#L306:7
    Old: common-types/resource-management/v1/types.json#L289:7


    The following breaking changes are detected by comparison with the latest preview version:

    Only 20 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 'ServerNameParameter' removed or renamed?
    New: azure-rest-api-specs/blob/99a9f1d7cb077b8167be4b1463b4a443f52227b7/revision#L2105:2
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L636:3
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/AzureADAdministrator.json#L49:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/AzureADAdministrator.json#L49:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/AzureADAdministrator.json#L114:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/AzureADAdministrator.json#L111:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/AzureADAdministrator.json#L164:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/AzureADAdministrator.json#L161:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/AzureADAdministrator.json#L209:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/AzureADAdministrator.json#L206:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L625:5
    Old: common-types/resource-management/v1/types.json#L551:5
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/Backups.json#L49:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Backups.json#L49:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/Backups.json#L92:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Backups.json#L92:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/Backups.json#L137:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Backups.json#L137:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L625:5
    Old: common-types/resource-management/v1/types.json#L551:5
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/Configurations.json#L49:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L49:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/Configurations.json#L110:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L105:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/Configurations.json#L155:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L150:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/Configurations.json#L218:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L208:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L625:5
    Old: common-types/resource-management/v1/types.json#L551:5
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/Databases.json#L49:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Databases.json#L49:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/Databases.json#L114:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Databases.json#L111:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/Databases.json#L164:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Databases.json#L158:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.DBforMySQL/preview/2022-09-30-preview/Databases.json#L209:9
    Old: Microsoft.DBforMySQL/preview/2021-12-01-preview/Databases.json#L203:9
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/types.json#L625:5
    Old: common-types/resource-management/v1/types.json#L551:5
    ️❌LintDiff: 6 Errors, 18 Warnings failed [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-flexibleserver-2021-12-01-preview package-flexibleserver-2021-12-01-preview(99a9f1d) package-flexibleserver-2021-12-01-preview(dev-mysql-Microsoft.DBforMySQL-2022-09-30-privatepreview)
    package-flexibleserver-2022-09-30-preview package-flexibleserver-2022-09-30-preview(99a9f1d) default(dev-mysql-Microsoft.DBforMySQL-2022-09-30-privatepreview)

    [must fix]The following errors/warnings are introduced by current PR:

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

    Rule Message Related RPC [For API reviewers]
    ImplementPrivateEndpointAPIs The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/privateLinkResources is missing.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L36
    ResourceNameRestriction The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L37
    RPC-Uri-V1-05
    GetCollectionResponseSchema The response in the GET collection operation 'PrivateEndpointConnections_ListByServer' does not match the response definition in the individual GET operation 'PrivateEndpointConnections_Get' .
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L208
    ImplementPrivateEndpointAPIs The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName} is missing.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateLinkResources.json#L36
    ImplementPrivateEndpointAPIs The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/privateEndpointConnections is missing.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateLinkResources.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'PrivateLinkResources_ListByServer' does not match the response definition in the individual GET operation 'PrivateLinkResources_Get' .
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateLinkResources.json#L37
    :warning: ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/LogFiles.json#L49
    :warning: ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L44
    :warning: ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L91
    :warning: ParameterDescription Parameter should have a description.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L98
    :warning: ParameterDescription Parameter should have a description.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L104
    :warning: ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L155
    :warning: ParameterDescription Parameter should have a description.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L162
    :warning: PageableOperation Based on the response model schema, operation 'PrivateEndpointConnections_ListByServer' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L209
    :warning: ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateEndpointConnections.json#L215
    :warning: PageableOperation Based on the response model schema, operation 'PrivateLinkResources_ListByServer' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateLinkResources.json#L38
    :warning: ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateLinkResources.json#L44
    :warning: ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/PrivateLinkResources.json#L86
    :warning: ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/ServiceOperations.json#L49
    :warning: ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/ServiceOperations.json#L91


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L37
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L65
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L65
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L82
    ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L138
    PostOperationAsyncResponseValidation An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options'
    Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L139
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L180
    ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L196
    LongRunningResponseStatusCode A 'put' operation 'AzureADAdministrators_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/AzureADAdministrator.json#L38
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/AzureADAdministrator.json#L88
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/AzureADAdministrator.json#L88
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/AzureADAdministrator.json#L135
    ResourceNameRestriction The resource name parameter 'backupName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/Backups.json#L37
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/Configurations.json#L65
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/Configurations.json#L65
    ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/Databases.json#L37
    LongRunningResponseStatusCode A 'put' operation 'Databases_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/Databases.json#L38
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/Databases.json#L88
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/Databases.json#L88
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.DBforMySQL/preview/2022-09-30-preview/Databases.json#L135
    ️❌Avocado: 1 Errors, 1 Warnings failed [Detail]
    Rule Message
    MULTIPLE_DEFAULT_TAGS The readme file has more than one default tag.
    readme: specification/mysql/resource-manager/readme.md
    :warning: 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
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView 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.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    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/mysql/armmysql - Approved - 2.0.0
    +	Struct `CloudError` has been removed
    ⚠️azure-sdk-for-go - sdk/resourcemanager/mysql/armmysqlflexibleservers - Approved - 2.0.0-beta.1
    +	Field `AdditionalInfo` of struct `ErrorResponse` has been removed
    +	Field `Code` of struct `ErrorResponse` has been removed
    +	Field `Details` of struct `ErrorResponse` has been removed
    +	Field `Message` of struct `ErrorResponse` has been removed
    +	Field `Target` of struct `ErrorResponse` has been removed
    +	Struct `CloudError` has been removed
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from e8a72695bee4e1c5799422382e7407fa8324141e. 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.MySql [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from e8a72695bee4e1c5799422382e7407fa8324141e. 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 major version of npm available! 8.19.3 -> 9.4.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-rdbms [View full logs]  [Preview SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added model PrivateEndpoint
      info	[Changelog]   - Added model PrivateEndpointConnectionProvisioningState
      info	[Changelog]   - Added model PrivateEndpointServiceConnectionStatus
      info	[Changelog]   - Added model PrivateLinkServiceConnectionState
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from e8a72695bee4e1c5799422382e7407fa8324141e. 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 available: 22.3.1 -> 23.0
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0
      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-mysqlflexibleserver [View full logs]  [Preview SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from e8a72695bee4e1c5799422382e7407fa8324141e. 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/mysql/armmysql [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Struct `CloudError` has been removed
      info	[Changelog]
      info	[Changelog] Total 2 breaking change(s), 0 additive change(s).
    • ️✔️sdk/resourcemanager/mysql/armmysqlflexibleservers [View full logs]  [Preview SDK Changes] Breaking Change Detected
      Only show 60 items here, please refer to log for details.
      info	[Changelog] - New function `NewAzureADAdministratorsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*AzureADAdministratorsClient, error)`
      info	[Changelog] - New function `*AzureADAdministratorsClient.BeginCreateOrUpdate(context.Context, string, string, AdministratorName, AzureADAdministrator, *AzureADAdministratorsClientBeginCreateOrUpdateOptions) (*runtime.Poller[AzureADAdministratorsClientCreateOrUpdateResponse], error)`
      info	[Changelog] - New function `*AzureADAdministratorsClient.BeginDelete(context.Context, string, string, AdministratorName, *AzureADAdministratorsClientBeginDeleteOptions) (*runtime.Poller[AzureADAdministratorsClientDeleteResponse], error)`
      info	[Changelog] - New function `*AzureADAdministratorsClient.Get(context.Context, string, string, AdministratorName, *AzureADAdministratorsClientGetOptions) (AzureADAdministratorsClientGetResponse, error)`
      info	[Changelog] - New function `*AzureADAdministratorsClient.NewListByServerPager(string, string, *AzureADAdministratorsClientListByServerOptions) *runtime.Pager[AzureADAdministratorsClientListByServerResponse]`
      info	[Changelog] - New function `*BackupsClient.Put(context.Context, string, string, string, *BackupsClientPutOptions) (BackupsClientPutResponse, error)`
      info	[Changelog] - New function `NewCheckNameAvailabilityWithoutLocationClient(string, azcore.TokenCredential, *arm.ClientOptions) (*CheckNameAvailabilityWithoutLocationClient, error)`
      info	[Changelog] - New function `*CheckNameAvailabilityWithoutLocationClient.Execute(context.Context, NameAvailabilityRequest, *CheckNameAvailabilityWithoutLocationClientExecuteOptions) (CheckNameAvailabilityWithoutLocationClientExecuteResponse, error)`
      info	[Changelog] - New function `NewLogFilesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*LogFilesClient, error)`
      info	[Changelog] - New function `*LogFilesClient.NewListByServerPager(string, string, *LogFilesClientListByServerOptions) *runtime.Pager[LogFilesClientListByServerResponse]`
      info	[Changelog] - New function `NewPrivateEndpointConnectionsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)`
      info	[Changelog] - New function `*PrivateEndpointConnectionsClient.BeginCreateOrUpdate(context.Context, string, string, string, PrivateEndpointConnection, *PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[PrivateEndpointConnectionsClientCreateOrUpdateResponse], error)`
      info	[Changelog] - New function `*PrivateEndpointConnectionsClient.BeginDelete(context.Context, string, string, string, *PrivateEndpointConnectionsClientBeginDeleteOptions) (*runtime.Poller[PrivateEndpointConnectionsClientDeleteResponse], error)`
      info	[Changelog] - New function `*PrivateEndpointConnectionsClient.Get(context.Context, string, string, string, *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)`
      info	[Changelog] - New function `*PrivateEndpointConnectionsClient.ListByServer(context.Context, string, string, *PrivateEndpointConnectionsClientListByServerOptions) (PrivateEndpointConnectionsClientListByServerResponse, error)`
      info	[Changelog] - New function `NewPrivateLinkResourcesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*PrivateLinkResourcesClient, error)`
      info	[Changelog] - New function `*PrivateLinkResourcesClient.Get(context.Context, string, string, string, *PrivateLinkResourcesClientGetOptions) (PrivateLinkResourcesClientGetResponse, error)`
      info	[Changelog] - New function `*PrivateLinkResourcesClient.ListByServer(context.Context, string, string, *PrivateLinkResourcesClientListByServerOptions) (PrivateLinkResourcesClientListByServerResponse, 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 `AzureADAdministratorsClientCreateOrUpdateResponse`
      info	[Changelog] - New struct `AzureADAdministratorsClientDeleteResponse`
      info	[Changelog] - New struct `AzureADAdministratorsClientListByServerResponse`
      info	[Changelog] - New struct `CheckNameAvailabilityWithoutLocationClient`
      info	[Changelog] - New struct `ErrorDetail`
      info	[Changelog] - New struct `LogFile`
      info	[Changelog] - New struct `LogFileListResult`
      info	[Changelog] - New struct `LogFileProperties`
      info	[Changelog] - New struct `LogFilesClient`
      info	[Changelog] - New struct `LogFilesClientListByServerResponse`
      info	[Changelog] - New struct `PrivateEndpoint`
      info	[Changelog] - New struct `PrivateEndpointConnection`
      info	[Changelog] - New struct `PrivateEndpointConnectionListResult`
      info	[Changelog] - New struct `PrivateEndpointConnectionProperties`
      info	[Changelog] - New struct `PrivateEndpointConnectionsClient`
      info	[Changelog] - New struct `PrivateEndpointConnectionsClientCreateOrUpdateResponse`
      info	[Changelog] - New struct `PrivateEndpointConnectionsClientDeleteResponse`
      info	[Changelog] - New struct `PrivateLinkResource`
      info	[Changelog] - New struct `PrivateLinkResourceListResult`
      info	[Changelog] - New struct `PrivateLinkResourceProperties`
      info	[Changelog] - New struct `PrivateLinkResourcesClient`
      info	[Changelog] - New struct `PrivateLinkServiceConnectionState`
      info	[Changelog] - New struct `TagsObject`
      info	[Changelog] - New field `ResetAllToDefault` in struct `ConfigurationListForBatchUpdate`
      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 `Error` in struct `ErrorResponse`
      info	[Changelog] - New field `SystemData` in struct `ProxyResource`
      info	[Changelog] - New field `SystemData` in struct `Resource`
      info	[Changelog] - New field `Version` in struct `ServerPropertiesForUpdate`
      info	[Changelog] - New field `AutoIoScaling` in struct `Storage`
      info	[Changelog] - New field `SystemData` in struct `TrackedResource`
      info	[Changelog] - New field `Location` in struct `VirtualNetworkSubnetUsageResult`
      info	[Changelog] - New field `SubscriptionID` in struct `VirtualNetworkSubnetUsageResult`
      info	[Changelog]
      info	[Changelog] Total 3 breaking change(s), 97 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs] Generate from e8a72695bee4e1c5799422382e7407fa8324141e. 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] Generate from e8a72695bee4e1c5799422382e7407fa8324141e. 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
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs] Generate from e8a72695bee4e1c5799422382e7407fa8324141e. 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
    Posted by Swagger Pipeline | How to fix these errors?

    Generated ApiView

    Language Package Name ApiView Link
    swagger Microsoft.DBforMySQL https://apiview.dev/Assemblies/Review/6971add44ff145fcbdf1fe612b406de2
    Go sdk/resourcemanager/mysql/armmysql Create ApiView failed. Please ask PR assignee for help
    Go sdk/resourcemanager/mysql/armmysqlflexibleservers Create ApiView failed. Please ask PR assignee for help
    Java azure-resourcemanager-mysqlflexibleserver https://apiview.dev/Assemblies/Review/e3247783cc344cf3b161e4f74970d8ef
    .Net Azure.ResourceManager.MySql https://apiview.dev/Assemblies/Review/bf5a69cd3c0548aca6b54be46c56859f

    Hi @tezhangmsvan, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    Hi, @tezhangmsvan your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

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

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

    /azp run

    tezhangmsvan avatar Jan 03 '23 19:01 tezhangmsvan

    Azure Pipelines successfully started running 1 pipeline(s).

    azure-pipelines[bot] avatar Jan 03 '23 19:01 azure-pipelines[bot]

    We are ready for review @raosuhas. Thanks. Please let me know who else do we need to complete this PR

    tezhangmsvan avatar Jan 07 '23 03:01 tezhangmsvan

    /azp run

    tezhangmsvan avatar Jan 13 '23 08:01 tezhangmsvan

    Azure Pipelines successfully started running 1 pipeline(s).

    azure-pipelines[bot] avatar Jan 13 '23 08:01 azure-pipelines[bot]

          "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
    

    Consider updating to v3 ProxyResoruce which should already defines SystemData for you - or maybe even later versions, I haven't seen them used too much yet though, so my confidence in them is less than 100%.


    Refers to: specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2022-09-30-privatepreview/AzureADAdministrator.json:293 in 3587345. [](commit_id = 3587345b1dec81fd2ea015dadd2c8f819cb4490f, deletion_comment = False)

    TimLovellSmith avatar Jan 13 '23 18:01 TimLovellSmith

    I'd suggest expanding the acronym BYOK to BringYourOwnKey (or whatever it is)

    TimLovellSmith avatar Jan 13 '23 18:01 TimLovellSmith

    Please fix the linter, avocado, model validation errors. And this pr needs to be reviewed by breaking change review board.

    xiaoxuqi-ms avatar Jan 19 '23 00:01 xiaoxuqi-ms

    Breaking change intake. https://msazure.visualstudio.com/One/_workitems/edit/16844142

    tezhangmsvan avatar Jan 19 '23 23:01 tezhangmsvan

    Please fix the linter, avocado, model validation errors. And this pr needs to be reviewed by breaking change review board.

    Not all the errors are on our side. And we were told that we can suppress them

    tezhangmsvan avatar Jan 19 '23 23:01 tezhangmsvan

    /azp run

    tezhangmsvan avatar Jan 27 '23 20:01 tezhangmsvan

    Azure Pipelines successfully started running 1 pipeline(s).

    azure-pipelines[bot] avatar Jan 27 '23 20:01 azure-pipelines[bot]

    @xiaoxuqi-ms Our PR is ready for merge. All errors are either false alarm or external (from common types that I was told can be suppressed.

    tezhangmsvan avatar Jan 30 '23 18:01 tezhangmsvan

    /azp run

    xiaoxuqi-ms avatar Feb 03 '23 07:02 xiaoxuqi-ms

    Azure Pipelines successfully started running 1 pipeline(s).

    azure-pipelines[bot] avatar Feb 03 '23 07:02 azure-pipelines[bot]

    TrackedResource

    Need to change to v4:

    https://github.com/Azure/azure-rest-api-specs/blob/33a3e0e355956678ccb7e74ce33c8065105c7ee5/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2022-09-30-preview/FlexibleServers.json#L967

    .

    fixed

    tezhangmsvan avatar Feb 03 '23 15:02 tezhangmsvan