Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swagger Documentation For Database Resource With Ledger #13916

Conversation

rewongmicrosoft
Copy link
Contributor

@rewongmicrosoft rewongmicrosoft commented Apr 13, 2021

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

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh for updates in this PR

Contribution checklist:

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

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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
Copy link

Hi, @rewongmicrosoft 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. vsswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 13, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌LintDiff: 3 Errors, 3 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    R4009 - RequiredReadOnlySystemData The response of operation:'Databases_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2021-02-01-preview/Databases.json#L68
    R4009 - RequiredReadOnlySystemData The response of operation:'Databases_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2021-02-01-preview/Databases.json#L108
    R4009 - RequiredReadOnlySystemData The response of operation:'Databases_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2021-02-01-preview/Databases.json#L241
    ⚠️ R3027 - TrackedResourceListByResourceGroup The tracked resource, 'Database', must have a list by resource group operation.(This rule does not apply for tenant level resources.)
    Location: Microsoft.Sql/preview/2021-02-01-preview/Databases.json#L1106
    ⚠️ R3028 - TrackedResourceListBySubscription The tracked resource, 'Database', must have a list by subscriptions operation.
    Location: Microsoft.Sql/preview/2021-02-01-preview/Databases.json#L1106
    ⚠️ R4000 - ParameterDescriptionRequired '$skipToken' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation.
    Location: Microsoft.Sql/preview/2021-02-01-preview/Databases.json#L33


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R2020 - RequiredPropertiesMissingInResourceModel Model definition 'FirewallRule' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
    Location: Microsoft.Sql/preview/2021-02-01-preview/FirewallRules.json#L308
    R2020 - RequiredPropertiesMissingInResourceModel Model definition 'ProxyResourceWithWritableName' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
    Location: Microsoft.Sql/preview/2021-02-01-preview/FirewallRules.json#L298
    R4009 - RequiredReadOnlySystemData The response of operation:'BackupShortTermRetentionPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2021-02-01-preview/BackupShortTermRetentionPolicies.json#L20
    R4009 - RequiredReadOnlySystemData The response of operation:'ExtendedDatabaseBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2021-02-01-preview/BlobAuditing.json#L20
    R4009 - RequiredReadOnlySystemData The response of operation:'ExtendedServerBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2021-02-01-preview/BlobAuditing.json#L174
    R4009 - RequiredReadOnlySystemData The response of operation:'ServerBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2021-02-01-preview/BlobAuditing.json#L314
    R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2021-02-01-preview/BlobAuditing.json#L454
    R4009 - RequiredReadOnlySystemData The response of operation:'DataWarehouseUserActivities_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2021-02-01-preview/DataWarehouseUserActivities.json#L20
    R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseAdvisors_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2021-02-01-preview/DatabaseAdvisors.json#L75
    R4009 - RequiredReadOnlySystemData The response of operation:'DatabaseAutomaticTuning_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Sql/preview/2021-02-01-preview/DatabaseAutomaticTuning.json#L20
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.

    ️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail]
    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"sql/resource-manager/readme.md",
    "tag":"package-preview-2021-02",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"sql/resource-manager/readme.md",
    "tag":"package-preview-2021-02",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    Rule Message
    AutorestCore/Exception "readme":"sql/resource-manager/readme.md",
    "tag":"package-preview-2021-02",
    "details":"Error: Plugin pre-namer reported failure."
    💬 AutorestCore/Exception "readme":"sql/resource-manager/readme.md",
    "tag":"package-preview-2021-02",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the SQL label Apr 13, 2021
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 13, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 5fefa7c22cfc75c4ba24944e61ff034ab1f63dee. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️sql/mgmt/2014-04-01/sql [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/sql/mgmt/v4.0/sql [View full logs]  [Preview SDK Changes] Breaking Change Detected
      Only show 18 items here, please refer to log for details.
      info	[Changelog] - New struct `LongTermRetentionBackupsUpdateByResourceGroupFuture`
      info	[Changelog] - New struct `LongTermRetentionBackupsUpdateFuture`
      info	[Changelog] - New struct `LongTermRetentionOperationResultProperties`
      info	[Changelog] - New struct `LongTermRetentionPoliciesClient`
      info	[Changelog] - New struct `LongTermRetentionPoliciesCreateOrUpdateFuture`
      info	[Changelog] - New struct `LongTermRetentionPolicy`
      info	[Changelog] - New struct `LongTermRetentionPolicyListResult`
      info	[Changelog] - New struct `LongTermRetentionPolicyListResultIterator`
      info	[Changelog] - New struct `LongTermRetentionPolicyListResultPage`
      info	[Changelog] - New struct `UpdateLongTermRetentionBackupParameters`
      info	[Changelog] - New struct `UpdateLongTermRetentionBackupParametersProperties`
      info	[Changelog] - New field `CurrentBackupStorageRedundancy` in struct `DatabaseProperties`
      info	[Changelog] - New field `RequestedBackupStorageRedundancy` in struct `DatabaseProperties`
      info	[Changelog] - New field `BackupStorageRedundancy` in struct `LongTermRetentionBackupProperties`
      info	[Changelog] - New field `RequestedBackupStorageRedundancy` in struct `LongTermRetentionBackupProperties`
      info	[Changelog]
      info	[Changelog] Total 92 breaking change(s), 110 additive change(s).
      info	[Changelog]
    • ️✔️preview/sql/mgmt/v3.0/sql [View full logs]  [Preview SDK Changes] Breaking Change Detected
      Only show 18 items here, please refer to log for details.
      info	[Changelog] - New function `ManagedInstancesClient.ListByManagedInstanceComplete(context.Context, string, string, *int32, string, string, string, QueryTimeGrainType, AggregationFunctionType, MetricType) (TopQueriesListResultIterator, error)`
      info	[Changelog] - New function `PossibleAggregationFunctionTypeValues() []AggregationFunctionType`
      info	[Changelog] - New struct `ManagedInstancePecProperty`
      info	[Changelog] - New struct `ManagedInstancePrivateEndpointConnectionProperties`
      info	[Changelog] - New struct `ManagedInstancePrivateEndpointProperty`
      info	[Changelog] - New struct `QueryMetricInterval`
      info	[Changelog] - New struct `QueryMetricProperties`
      info	[Changelog] - New struct `QueryStatisticsProperties`
      info	[Changelog] - New struct `TopQueries`
      info	[Changelog] - New struct `TopQueriesListResult`
      info	[Changelog] - New struct `TopQueriesListResultIterator`
      info	[Changelog] - New struct `TopQueriesListResultPage`
      info	[Changelog] - New field `ZoneRedundant` in struct `ManagedInstanceProperties`
      info	[Changelog] - New field `PrivateEndpointConnections` in struct `ManagedInstanceProperties`
      info	[Changelog] - New field `Identity` in struct `ManagedInstanceUpdate`
      info	[Changelog]
      info	[Changelog] Total 20 breaking change(s), 70 additive change(s).
      info	[Changelog]
    • ️✔️preview/sql/mgmt/2018-06-01-preview/sql [View full logs]  [Preview SDK Changes] Breaking Change Detected
      Only show 18 items here, please refer to log for details.
      info	[Changelog]
      info	[Changelog] - Const `None` type has been changed from `SensitivityLabelRank` to `IdentityType`
      info	[Changelog] - Const `Medium` has been removed
      info	[Changelog] - Const `Low` has been removed
      info	[Changelog] - Const `Critical` has been removed
      info	[Changelog] - Const `High` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `SensitivityLabelRankCritical`
      info	[Changelog] - New const `SensitivityLabelRankNone`
      info	[Changelog] - New const `UserAssigned`
      info	[Changelog] - New const `SensitivityLabelRankHigh`
      info	[Changelog] - New const `SensitivityLabelRankLow`
      info	[Changelog] - New const `SensitivityLabelRankMedium`
      info	[Changelog]
      info	[Changelog] Total 5 breaking change(s), 6 additive change(s).
      info	[Changelog]
    • ️✔️preview/sql/mgmt/2017-10-01-preview/sql [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/sql/mgmt/2017-03-01-preview/sql [View full logs]  [Preview SDK Changes] Breaking Change Detected
      Only show 18 items here, please refer to log for details.
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `BytesPerSecond`
      info	[Changelog] - New const `PrimaryAggregationTypeNone`
      info	[Changelog] - New const `PrimaryAggregationTypeTotal`
      info	[Changelog] - New const `PrimaryAggregationTypeAverage`
      info	[Changelog] - New const `Seconds`
      info	[Changelog] - New const `PrimaryAggregationTypeCount`
      info	[Changelog] - New const `Bytes`
      info	[Changelog] - New const `CountPerSecond`
      info	[Changelog] - New const `UserAssigned`
      info	[Changelog] - New const `PrimaryAggregationTypeMaximum`
      info	[Changelog] - New const `PrimaryAggregationTypeMinimum`
      info	[Changelog] - New const `Percent`
      info	[Changelog]
      info	[Changelog] Total 12 breaking change(s), 12 additive change(s).
      info	[Changelog]
    • ️✔️preview/sql/mgmt/2015-05-01-preview/sql [View full logs]  [Preview SDK Changes] Breaking Change Detected
      Only show 18 items here, please refer to log for details.
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `CountPerSecond`
      info	[Changelog] - New const `BytesPerSecond`
      info	[Changelog] - New const `PrimaryAggregationTypeMaximum`
      info	[Changelog] - New const `PrimaryAggregationTypeCount`
      info	[Changelog] - New const `PrimaryAggregationTypeMinimum`
      info	[Changelog] - New const `PrimaryAggregationTypeNone`
      info	[Changelog] - New const `UserAssigned`
      info	[Changelog] - New const `PrimaryAggregationTypeAverage`
      info	[Changelog] - New const `PrimaryAggregationTypeTotal`
      info	[Changelog] - New const `Bytes`
      info	[Changelog] - New const `Percent`
      info	[Changelog] - New const `Seconds`
      info	[Changelog]
      info	[Changelog] Total 12 breaking change(s), 12 additive change(s).
      info	[Changelog]
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs] Generate from 5fefa7c22cfc75c4ba24944e61ff034ab1f63dee. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/sql/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
    • Microsoft.Azure.Management.Sql [View full logs]  [Preview SDK Changes]
      cmdout	[msbuild] /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Utilities/SqlManagementTestUtilities.cs(118,13): error CS0246: The type or namespace name 'Usage' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
      cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Utilities/SqlManagementTestUtilities.cs(566,42): error CS0246: The type or namespace name 'ResourceIdentity' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Utilities/SqlManagementTestUtilities.cs(118,13): error CS0246: The type or namespace name 'Usage' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Utilities/SqlManagementTestUtilities.cs(566,42): error CS0246: The type or namespace name 'ResourceIdentity' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/sqlmanagement/Microsoft.Azure.Management.Sql/tests/Microsoft.Azure.Management.Sql.Tests.csproj]
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: dotnet
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 5fefa7c22cfc75c4ba24944e61ff034ab1f63dee. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/sql/resource-manager/readme.md
    • ️✔️@azure/arm-sql [View full logs]  [Preview SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/sqlManagementClient.js → ./dist/arm-sql.js...
      cmderr	[npmPack] created ./dist/arm-sql.js in 1.9s
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs] Generate from 5fefa7c22cfc75c4ba24944e61ff034ab1f63dee. 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] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      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
    • ️✔️track2_azure-mgmt-sql [View full logs]  [Preview SDK Changes] Breaking Change Detected
      Only show 120 items here, please refer to log for details.
      info	[Changelog]   - Model EncryptionProtector has a new parameter auto_rotation_enabled
      info	[Changelog]   - Model DatabaseSecurityAlertPolicy has a new parameter creation_time
      info	[Changelog]   - Model DatabaseSecurityAlertPolicy has a new parameter system_data
      info	[Changelog]   - Model DatabaseUpdate has a new parameter requested_backup_storage_redundancy
      info	[Changelog]   - Model DatabaseUpdate has a new parameter is_ledger_on
      info	[Changelog]   - Model DatabaseUpdate has a new parameter current_backup_storage_redundancy
      info	[Changelog]   - Model SyncGroup has a new parameter sku
      info	[Changelog]   - Model SyncGroup has a new parameter enable_conflict_logging
      info	[Changelog]   - Model SyncGroup has a new parameter conflict_logging_retention_in_days
      info	[Changelog]   - Model RestorableDroppedDatabase has a new parameter sku
      info	[Changelog]   - Model RestorableDroppedDatabase has a new parameter elastic_pool_id
      info	[Changelog]   - Model RestorableDroppedDatabase has a new parameter tags
      info	[Changelog]   - Model ServerSecurityAlertPolicy has a new parameter system_data
      info	[Changelog]   - Model ManagedServerSecurityAlertPolicy has a new parameter system_data
      info	[Changelog]   - Model ManagedInstanceLongTermRetentionBackup has a new parameter backup_storage_redundancy
      info	[Changelog]   - Model DatabaseUsage has a new parameter type
      info	[Changelog]   - Model DatabaseUsage has a new parameter id
      info	[Changelog]   - Added operation VirtualClustersOperations.update_dns_servers
      info	[Changelog]   - Added operation LongTermRetentionBackupsOperations.update
      info	[Changelog]   - Added operation LongTermRetentionBackupsOperations.update_by_resource_group
      info	[Changelog]   - Added operation LongTermRetentionBackupsOperations.copy
      info	[Changelog]   - Added operation LongTermRetentionBackupsOperations.copy_by_resource_group
      info	[Changelog]   - Added operation RestorableDroppedDatabasesOperations.get
      info	[Changelog]   - Added operation SensitivityLabelsOperations.update
      info	[Changelog]   - Added operation ReplicationLinksOperations.list_by_server
      info	[Changelog]   - Added operation FirewallRulesOperations.replace
      info	[Changelog]   - Added operation TransparentDataEncryptionsOperations.list_by_database
      info	[Changelog]   - Added operation ServersOperations.import_database
      info	[Changelog]   - Added operation ManagedDatabaseSensitivityLabelsOperations.update
      info	[Changelog]   - Added operation group DatabaseSchemasOperations
      info	[Changelog]   - Added operation group OutboundFirewallRulesOperations
      info	[Changelog]   - Added operation group ManagedDatabaseQueriesOperations
      info	[Changelog]   - Added operation group LongTermRetentionPoliciesOperations
      info	[Changelog]   - Added operation group ManagedInstancePrivateLinkResourcesOperations
      info	[Changelog]   - Added operation group TimeZonesOperations
      info	[Changelog]   - Added operation group ManagedDatabaseColumnsOperations
      info	[Changelog]   - Added operation group DatabaseAdvisorsOperations
      info	[Changelog]   - Added operation group ServerAdvisorsOperations
      info	[Changelog]   - Added operation group MaintenanceWindowOptionsOperations
      info	[Changelog]   - Added operation group DatabaseSecurityAlertPoliciesOperations
      info	[Changelog]   - Added operation group ManagedDatabaseRecommendedSensitivityLabelsOperations
      info	[Changelog]   - Added operation group OperationsHealthOperations
      info	[Changelog]   - Added operation group DatabaseExtensionsOperations
      info	[Changelog]   - Added operation group ManagedInstancePrivateEndpointConnectionsOperations
      info	[Changelog]   - Added operation group DatabaseTablesOperations
      info	[Changelog]   - Added operation group DataWarehouseUserActivitiesOperations
      info	[Changelog]   - Added operation group DatabaseColumnsOperations
      info	[Changelog]   - Added operation group DeletedServersOperations
      info	[Changelog]   - Added operation group ManagedDatabaseSecurityEventsOperations
      info	[Changelog]   - Added operation group RecommendedSensitivityLabelsOperations
      info	[Changelog]   - Added operation group MaintenanceWindowsOperations
      info	[Changelog]   - Added operation group SqlAgentOperations
      info	[Changelog]   - Added operation group DatabaseRecommendedActionsOperations
      info	[Changelog]   - Added operation group ManagedDatabaseTransparentDataEncryptionOperations
      info	[Changelog]   - Added operation group ServerOperations
      info	[Changelog]   - Added operation group ManagedDatabaseSchemasOperations
      info	[Changelog]   - Added operation group ManagedDatabaseTablesOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Parameter old_server_dns_alias_id of model ServerDnsAliasAcquisition is now required
      info	[Changelog]   - Operation ReplicationLinksOperations.get has a new signature
      info	[Changelog]   - Operation TransparentDataEncryptionsOperations.create_or_update has a new signature
      info	[Changelog]   - Operation DatabasesOperations.list_by_server has a new signature
      info	[Changelog]   - Operation ManagedInstancesOperations.get has a new signature
      info	[Changelog]   - Operation ManagedInstancesOperations.list_by_instance_pool has a new signature
      info	[Changelog]   - Operation ManagedInstancesOperations.list_by_resource_group has a new signature
      info	[Changelog]   - Operation ServersOperations.get has a new signature
      info	[Changelog]   - Operation ServersOperations.list_by_resource_group has a new signature
      info	[Changelog]   - Operation SensitivityLabelsOperations.list_recommended_by_database has a new signature
      info	[Changelog]   - Operation ManagedDatabaseSensitivityLabelsOperations.list_recommended_by_database has a new signature
      info	[Changelog]   - Operation ManagedDatabaseSensitivityLabelsOperations.list_recommended_by_database has a new signature
      info	[Changelog]   - Operation SensitivityLabelsOperations.list_recommended_by_database has a new signature
      info	[Changelog]   - Model FirewallRule no longer has parameter location
      info	[Changelog]   - Model FirewallRule no longer has parameter kind
      info	[Changelog]   - Model Database no longer has parameter storage_account_type
      info	[Changelog]   - Model ReplicationLink no longer has parameter location
      info	[Changelog]   - Model DatabaseSecurityAlertPolicy no longer has parameter location
      info	[Changelog]   - Model DatabaseSecurityAlertPolicy no longer has parameter kind
      info	[Changelog]   - Model DatabaseSecurityAlertPolicy no longer has parameter use_server_default
      info	[Changelog]   - Model DatabaseUpdate no longer has parameter storage_account_type
      info	[Changelog]   - Model RestorableDroppedDatabase no longer has parameter elastic_pool_name
      info	[Changelog]   - Model RestorableDroppedDatabase no longer has parameter edition
      info	[Changelog]   - Model RestorableDroppedDatabase no longer has parameter service_level_objective
      info	[Changelog]   - Model DatabaseUsage no longer has parameter resource_name
      info	[Changelog]   - Model DatabaseUsage no longer has parameter next_reset_time
      info	[Changelog]   - Operation EncryptionProtectorsOperations.create_or_update has a new signature
      info	[Changelog]   - Operation VirtualClustersOperations.update has a new signature
      info	[Changelog]   - Operation SensitivityLabelsOperations.list_current_by_database has a new signature
      info	[Changelog]   - Operation ManagedInstanceEncryptionProtectorsOperations.create_or_update has a new signature
      info	[Changelog]   - Operation FirewallRulesOperations.create_or_update has a new signature
      info	[Changelog]   - Operation ManagedInstancesOperations.list has a new signature
      info	[Changelog]   - Operation ServersOperations.list has a new signature
      info	[Changelog]   - Operation ServerKeysOperations.create_or_update has a new signature
      info	[Changelog]   - Operation ManagedDatabaseSensitivityLabelsOperations.list_current_by_database has a new signature
      info	[Changelog]   - Removed operation DatabasesOperations.list_metrics
      info	[Changelog]   - Removed operation DatabasesOperations.import_database
      info	[Changelog]   - Removed operation DatabasesOperations.list_metric_definitions
      info	[Changelog]   - Removed operation ReplicationLinksOperations.failover_allow_data_loss
      info	[Changelog]   - Removed operation ReplicationLinksOperations.unlink
      info	[Changelog]   - Removed operation ReplicationLinksOperations.failover
      info	[Changelog]   - Removed operation ReplicationLinksOperations.delete
      info	[Changelog]   - Removed operation ElasticPoolsOperations.list_metrics
      info	[Changelog]   - Removed operation ElasticPoolsOperations.list_metric_definitions
      info	[Changelog]   - Removed operation group ServerConnectionPoliciesOperations
      info	[Changelog]   - Removed operation group GeoBackupPoliciesOperations
      info	[Changelog]   - Removed operation group TransparentDataEncryptionActivitiesOperations
      info	[Changelog]   - Removed operation group DataMaskingPoliciesOperations
      info	[Changelog]   - Removed operation group UsagesOperations
      info	[Changelog]   - Removed operation group ServiceObjectivesOperations
      info	[Changelog]   - Removed operation group ServerCommunicationLinksOperations
      info	[Changelog]   - Removed operation group RecommendedElasticPoolsOperations
      info	[Changelog]   - Removed operation group ElasticPoolDatabaseActivitiesOperations
      info	[Changelog]   - Removed operation group ServiceTierAdvisorsOperations
      info	[Changelog]   - Removed operation group ElasticPoolActivitiesOperations
      info	[Changelog]   - Removed operation group DatabaseThreatDetectionPoliciesOperations
      info	[Changelog]   - Removed operation group RecoverableDatabasesOperations
      info	[Changelog]   - Removed operation group ServerUsagesOperations
      info	[Changelog]   - Removed operation group BackupLongTermRetentionPoliciesOperations
      info	[Changelog]   - Removed operation group DataMaskingRulesOperations
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 5fefa7c22cfc75c4ba24944e61ff034ab1f63dee. 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 read-shrinkwrap This version of npm is compatible with lockfileVersion@1, but package-lock.json was generated for lockfileVersion@2. I'll try to do my best with it!
      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-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 5fefa7c22cfc75c4ba24944e61ff034ab1f63dee. 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
      cmderr	[generate.py] 2021-04-20 21:49:24 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-sql-generated"
      cmderr	[generate.py] 2021-04-20 21:49:24 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-04-20 21:49:24 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.24 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/sql/azure-resourcemanager-sql-generated --java.namespace=com.azure.resourcemanager.sql.generated   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/sql/resource-manager/readme.md
      cmderr	[generate.py] 2021-04-20 21:52:31 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-04-20 21:52:31 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-04-20 21:52:31 INFO [POM][Skip] pom already has module azure-resourcemanager-sql-generated
      cmderr	[generate.py] 2021-04-20 21:52:31 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-04-20 21:52:31 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-04-20 21:52:31 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-sql-generated [View full logs]  [Preview SDK Changes]
      cmderr	[Inst] 2021-04-20 21:58:34 DEBUG Got artifact_id: azure-resourcemanager-sql-generated
      cmderr	[Inst] 2021-04-20 21:58:34 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-04-20 21:58:34 DEBUG Got artifact: azure-resourcemanager-sql-generated-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-04-20 21:58:34 DEBUG Got artifact: azure-resourcemanager-sql-generated-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-04-20 21:58:34 DEBUG Got artifact: azure-resourcemanager-sql-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-04-20 21:58:34 DEBUG Match jar package: azure-resourcemanager-sql-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-04-20 21:58:34 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13916/azure-sdk-for-java/azure-resourcemanager-sql-generated/azure-resourcemanager-sql-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-sql-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-sql-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-sql-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @rewongmicrosoft, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 13, 2021
    @openapi-workflow-bot
    Copy link

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

    @ericshape
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @ericshape
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    Copy link
    Contributor

    @j5lim j5lim left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Approved from ARM side.

    @j5lim j5lim added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Apr 21, 2021
    @rewongmicrosoft rewongmicrosoft changed the title Swagger Documentation For Database Resource With Ledger [DO NOT MERGE] Swagger Documentation For Database Resource With Ledger Apr 21, 2021
    @rewongmicrosoft rewongmicrosoft changed the title [DO NOT MERGE] Swagger Documentation For Database Resource With Ledger Swagger Documentation For Database Resource With Ledger Apr 23, 2021
    @akning-ms akning-ms merged commit bf832d4 into Azure:dev-sql-Microsoft.Sql-2021-02-01-preview Apr 25, 2021
    akning-ms added a commit that referenced this pull request May 10, 2021
    * Adds base for updating Microsoft.Sql from version preview/2020-11-01-preview to version 2021-02-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Fix Integer format: S360 swagger lint issues in 2021-02-01 (#13855)
    
    * Update integer format
    
    * update typo
    
    * Swagger Documentation for Outbound Firewall Rules (#13820)
    
    * Swagger Documentation for Outbound Firewall Rules
    
    * Add the new file to v5
    
    Co-authored-by: Vineet Mahadik <Vineet.Mahadik@microsoft.com>
    
    * Swagger Documentation For Database Resource With Ledger (#13916)
    
    * adding database swagger files
    
    * modifying example
    
    * Fixing to be boolean
    
    * adding database extensions and database operations
    
    * adding other database examples
    
    * removing database_legacy, adding usages
    
    * removing usages
    
    * removing databases_legacy from readme
    
    * Swagger Documentation For Ledger Digest Upload (#13871)
    
    * adding ledger api
    
    * Fixes from validation
    
    * removing required endpoint parameter, adding ledgerName (current) to id
    
    * removing 201 response from resource, renaming ledgerName
    
    * adding location to 202 results
    
    * fixing 202 response location
    
    * renaming files
    
    * updating files with new controller name + correct entity name
    
    * fixing readme
    
    * Dev brandong getrestorabledropped (#14129)
    
    * Update RestorableDroppedDatabases API to add BackupStorageAccountType property
    
    * Update readme.md
    
    * Re-add elasticPoolId as a deprecated property
    
    * Update elasticPoolId description and remove trailing comma causing failures
    
    * Remove the unsupported deprecated property
    
    * Add 2021-02-01-preview minor changes (#13942)
    
    * add 2021-02-01-preview for test
    
    * update with 2021-04-19 latest
    
    * update readme.md
    
    * update with latest master in DSMainDev
    
    * Carry IsInfraEncryptionEnabled to Database.json (#14322)
    
    * carry latest minor changes.
    
    * re-format readme.md
    
    * remove 2020 11 01 RestorableDroppedManagedDatabases in V5
    
    * Update readme file in 2021 02 01 dev branch to match the master branch (#14336)
    
    * Carry IsInfraEncryptionEnabled to Database.json (#14322)
    
    * carry latest minor changes.
    
    * re-format readme.md
    
    * remove 2020 11 01 RestorableDroppedManagedDatabases in V5
    
    * update to match master branch readme.md
    
    Co-authored-by: Vineet Mahadik <44247873+VMMicrosoft@users.noreply.github.com>
    Co-authored-by: Vineet Mahadik <Vineet.Mahadik@microsoft.com>
    Co-authored-by: rewongmicrosoft <57964114+rewongmicrosoft@users.noreply.github.com>
    Co-authored-by: brandong-ms <44618010+brandong-ms@users.noreply.github.com>
    Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com>
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * Adds base for updating Microsoft.Sql from version preview/2020-11-01-preview to version 2021-02-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Fix Integer format: S360 swagger lint issues in 2021-02-01 (Azure#13855)
    
    * Update integer format
    
    * update typo
    
    * Swagger Documentation for Outbound Firewall Rules (Azure#13820)
    
    * Swagger Documentation for Outbound Firewall Rules
    
    * Add the new file to v5
    
    Co-authored-by: Vineet Mahadik <Vineet.Mahadik@microsoft.com>
    
    * Swagger Documentation For Database Resource With Ledger (Azure#13916)
    
    * adding database swagger files
    
    * modifying example
    
    * Fixing to be boolean
    
    * adding database extensions and database operations
    
    * adding other database examples
    
    * removing database_legacy, adding usages
    
    * removing usages
    
    * removing databases_legacy from readme
    
    * Swagger Documentation For Ledger Digest Upload (Azure#13871)
    
    * adding ledger api
    
    * Fixes from validation
    
    * removing required endpoint parameter, adding ledgerName (current) to id
    
    * removing 201 response from resource, renaming ledgerName
    
    * adding location to 202 results
    
    * fixing 202 response location
    
    * renaming files
    
    * updating files with new controller name + correct entity name
    
    * fixing readme
    
    * Dev brandong getrestorabledropped (Azure#14129)
    
    * Update RestorableDroppedDatabases API to add BackupStorageAccountType property
    
    * Update readme.md
    
    * Re-add elasticPoolId as a deprecated property
    
    * Update elasticPoolId description and remove trailing comma causing failures
    
    * Remove the unsupported deprecated property
    
    * Add 2021-02-01-preview minor changes (Azure#13942)
    
    * add 2021-02-01-preview for test
    
    * update with 2021-04-19 latest
    
    * update readme.md
    
    * update with latest master in DSMainDev
    
    * Carry IsInfraEncryptionEnabled to Database.json (Azure#14322)
    
    * carry latest minor changes.
    
    * re-format readme.md
    
    * remove 2020 11 01 RestorableDroppedManagedDatabases in V5
    
    * Update readme file in 2021 02 01 dev branch to match the master branch (Azure#14336)
    
    * Carry IsInfraEncryptionEnabled to Database.json (Azure#14322)
    
    * carry latest minor changes.
    
    * re-format readme.md
    
    * remove 2020 11 01 RestorableDroppedManagedDatabases in V5
    
    * update to match master branch readme.md
    
    Co-authored-by: Vineet Mahadik <44247873+VMMicrosoft@users.noreply.github.com>
    Co-authored-by: Vineet Mahadik <Vineet.Mahadik@microsoft.com>
    Co-authored-by: rewongmicrosoft <57964114+rewongmicrosoft@users.noreply.github.com>
    Co-authored-by: brandong-ms <44618010+brandong-ms@users.noreply.github.com>
    Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-Python CI-FixRequiredOnFailure SQL
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants