-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Release microsoft.sql 2021-11-01 Stable API version #19863
Release microsoft.sql 2021-11-01 Stable API version #19863
Conversation
Hi, @ericshape Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.9.6)] | new version | base version |
---|---|---|
BackupShortTermRetentionPolicies.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
BlobAuditing.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DataWarehouseUserActivities.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseAdvancedThreatProtectionSettings.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseAdvisors.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseAutomaticTuning.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseColumns.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseExtensions.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseOperations.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseRecommendedActions.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseSchemas.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseSecurityAlertPolicies.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseTables.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseUsages.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseVulnerabilityAssessmentRuleBaselines.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseVulnerabilityAssessmentScans.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DatabaseVulnerabilityAssessments.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
Databases.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DeletedServers.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
DistributedAvailabilityGroups.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ElasticPoolOperations.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ElasticPools.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
EncryptionProtectors.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
EndpointCertificates.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
FailoverGroups.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
FirewallRules.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
IPv6FirewallRules.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
InstanceFailoverGroups.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
InstancePools.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
JobAgents.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
JobCredentials.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
JobExecutions.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
JobStepExecutions.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
JobSteps.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
JobTargetExecutions.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
JobTargetGroups.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
JobVersions.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
Jobs.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
LedgerDigestUploads.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
LocationCapabilities.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
LongTermRetentionBackups.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
LongTermRetentionManagedInstanceBackups.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
LongTermRetentionPolicies.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
MaintenanceWindowOptions.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
MaintenanceWindows.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedBackupShortTermRetentionPolicies.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabaseColumns.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabaseQueries.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabaseRestoreDetails.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabaseSchemas.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabaseSecurityAlertPolicies.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabaseSecurityEvents.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabaseSensitivityLabels.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabaseTables.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabaseTransparentDataEncryption.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabaseVulnerabilityAssessmentRuleBaselines.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabaseVulnerabilityAssessmentScans.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabaseVulnerabilityAssessments.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedDatabases.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedInstanceAdministrators.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedInstanceAzureADOnlyAuthentications.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedInstanceEncryptionProtectors.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedInstanceKeys.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedInstanceLongTermRetentionPolicies.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedInstanceOperations.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedInstancePrivateEndpointConnections.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedInstancePrivateLinkResources.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedInstanceTdeCertificates.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedInstanceVulnerabilityAssessments.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedInstances.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedServerDnsAliases.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ManagedServerSecurityAlertPolicies.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
Operations.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
OutboundFirewallRules.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
PrivateEndpointConnections.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
PrivateLinkResources.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
RecoverableManagedDatabases.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ReplicationLinks.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
RestorableDroppedDatabases.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
RestorableDroppedManagedDatabases.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
RestorePoints.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
SensitivityLabels.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerAdvancedThreatProtectionSettings.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerAdvisors.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerAutomaticTuning.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerAzureADAdministrators.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerAzureADOnlyAuthentications.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerConnectionPolicies.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerDevOpsAudit.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerDnsAliases.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerKeys.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerOperations.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerSecurityAlertPolicies.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerTrustCertificates.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerTrustGroups.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
ServerVulnerabilityAssessments.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
Servers.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
SqlAgent.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
SubscriptionUsages.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
SyncAgents.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
SyncGroups.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
SyncMembers.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
TdeCertificates.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
TimeZones.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
TransparentDataEncryptions.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
Usages.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
VirtualClusters.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
VirtualNetworkRules.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
WorkloadClassifiers.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
WorkloadGroups.json | 2021-11-01(2a4ff59) | 2021-11-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The new version adds a response code '202'. New: Microsoft.Sql/stable/2021-11-01/ReplicationLinks.json#L148:11 |
|
The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Sql/stable/2021-11-01/ReplicationLinks.json#L112:7 Old: Microsoft.Sql/preview/2021-11-01-preview/ReplicationLinks.json#L112:7 |
Rule | Message |
---|---|
"details":"Attention: There are some existing APIs currently documented in a new spec file. The validation may not be able to report breaking changes with these APIs. It is recommended not to rename swagger file or move public APIs to a new file when creating a new API version.The existing APIs being moved are:ServerUsages_ListByServer;", "location":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/ServerUsages.json" |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 203 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2021-11 | package-2021-11(2a4ff59) | default(main) |
The following errors/warnings are introduced by current PR:
Only 7 items are listed, please refer to log for more details.
Rule | Message |
---|---|
Per the Noun_Verb convention for Operation Ids, the noun 'ManagedInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Sql/stable/2021-11-01/ManagedInstances.json#L440 |
|
The response of operation:'BackupShortTermRetentionPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/stable/2021-11-01/BackupShortTermRetentionPolicies.json#L65 |
|
The response of operation:'BackupShortTermRetentionPolicies_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/stable/2021-11-01/BackupShortTermRetentionPolicies.json#L119 |
|
The response of operation:'BackupShortTermRetentionPolicies_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/stable/2021-11-01/BackupShortTermRetentionPolicies.json#L186 |
|
The response of operation:'ServerBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/stable/2021-11-01/BlobAuditing.json#L62 |
|
The response of operation:'ServerBlobAuditingPolicies_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/stable/2021-11-01/BlobAuditing.json#L102 |
|
The response of operation:'DatabaseBlobAuditingPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/stable/2021-11-01/BlobAuditing.json#L205 |
The following errors/warnings exist before current PR submission:
Only 7 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Sql/stable/2021-11-01/LocationCapabilities.json#L1229 |
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Sql/stable/2021-11-01/ManagedInstances.json#L806 |
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Sql/stable/2021-11-01/ServerTrustGroups.json#L344 |
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Sql/stable/2021-11-01/SqlAgent.json#L125 |
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Sql/stable/2021-11-01/VirtualClusters.json#L269 |
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/stable/2021-11-01/FirewallRules.json#L263 |
R2020 - RequiredPropertiesMissingInResourceModel |
Model definition 'IPv6 FirewallRule' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Sql/stable/2021-11-01/IPv6FirewallRules.json#L215 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/sql/resource-manager/readme.md tag: specification/sql/resource-manager/readme.md#tag-package-composite-v5 |
️❌
ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.Sql' for api version '2021-11-01'. The supported api-versions are '2014-01-01, 2014-04-01, 2014-04-01-preview, 2015-05-01-preview, 2015-05-01, 2017-03-01-preview, 2017-10-01-preview, 2018-06-01-preview, 2019-06-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01-preview, 2022-02-01-preview'." |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌
SDK Track2 Validation: 2 Errors, 0 Warnings failed [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/2a4ff59100eea32bfdd8ec143ec77c48635a7091/specification/sql/resource-manager/readme.md#tag-package-2021-11">sql/resource-manager/readme.md#package-2021-11
Rule | Message |
---|---|
|
"readme":"sql/resource-manager/readme.md", "tag":"package-2021-11", "details":"Duplicate object schemas with 'SecurityAlertPolicyName' name detected." |
|
"readme":"sql/resource-manager/readme.md", "tag":"package-2021-11", "details":"Error: 1 errors occured -- cannot continue." |
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
Hi @ericshape, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Generated ApiView
|
Hi, @ericshape your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
Please respond to the comments and remove the "ARMChangesRequested" label when this PR is ready for review again . |
@raosuhas thanks for the review.
We did not change any of their API contracts. They are safe to add. |
@raosuhas I have addressed your comments. can we have your review again? |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
@jianyexi , can you assist what are duplicated model name? |
The lintDiff error was caused by the duplicated model 'DatabaseVulnerabilityAssessmentRuleBaselineProperties' in |
I have addressed this comment. |
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Release Microsoft.SQL 2021-11-01 stable API version.
Move 2021-11-01-preview (released in prod over 6 months ago) to 2021-11-01 stable version
all the changes are just adding 2021-11-01 swagger files into stable API folder: https://github.com/Azure/azure-rest-api-specs/pull/19863/files#diff-a9813225adad9c543578640d5522406a91874f99551b8ee8466925afb518abd3
Carry these four APIs from last stable API version: 2014-04-01
DataMaskingPolicies.json , DataMaskingRules.json, GeoBackupPolicies.json , RecoverableDatabases.json and ServerUsages.json
We directly copy the 2021-11-01-preview to this stable version. Thus, these exceptions are carried on. We still ask for exceptions for these failed checks:
The List methods are Delete method are not needed based on SQL business justification.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
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.