Azure
Dev postgresql microsoft.d bfor postgre sql 2022 03 08 preview
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:
- 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
- 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.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- [ ] SDK of .NET (need service team to ensure code readiness)
- [ ] SDK of Python
- [ ] SDK of Java
- [ ] SDK of Js
- [ ] SDK of Go
- [x] PowerShell
- [x] CLI
- [x] Terraform
- [ ] No refresh required for updates in this PR
Contribution checklist:
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [x] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :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 appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
-
[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.
-
[ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
- [ ] Removing API(s) in a stable version
- [ ] Removing properties in a stable version
- [ ] Removing API version(s) in a stable version
- [ ] Updating API in a stable or public preview version with Breaking Change Validation errors
- [ ] Updating API(s) in public preview over 1 year (refer to Retirement of Previews)
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.
Hi, @ambrahma Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 19 Errors, 20 Warnings failed [Detail]
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| Databases.json | 2022-03-08-preview(f3f22fb) | 2021-06-01(main) |
| Databases.json | 2022-03-08-preview(f3f22fb) | 2022-01-20-preview(main) |
| PrivateDnsZone.json | 2022-03-08-preview(f3f22fb) | 2021-06-01(main) |
| PrivateDnsZone.json | 2022-03-08-preview(f3f22fb) | 2022-01-20-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 18 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 18 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| :warning: APIsBeingMovedToANewSpec | "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:Operations_List;", "location":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Operations.json" |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 12 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-flexibleserver-2022-03-privatepreview | package-flexibleserver-2022-03-privatepreview(f3f22fb) | default(main) |
| package-flexibleserver-2022-03-preview | package-flexibleserver-2022-03-preview(f3f22fb) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: R2017 - PutRequestResponseScheme | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Administrators_Create' Request Model: 'ActiveDirectoryAdministratorAdd' Response Model: 'ActiveDirectoryAdministrator' Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Administrators.json#L38 |
|
| :warning: R2066 - PostOperationIdContainsUrlVerb | OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailabilityWithLocation_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/CheckNameAvailability.json#L87 |
|
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isBaseline Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L100 |
|
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fastProvisioningSupported Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L438 |
|
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: activeDirectoryAuthEnabled Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/FlexibleServers.json#L717 |
|
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: passwordAuthEnabled Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/FlexibleServers.json#L721 |
|
| :warning: R4021 - DescriptionAndTitleMissing | 'StorageTierCapability' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L81 |
|
| :warning: R4021 - DescriptionAndTitleMissing | 'supportedUpgradableTierList' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L132 |
|
| :warning: R4021 - DescriptionAndTitleMissing | 'FastProvisioningEditionCapability' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L279 |
|
| :warning: R4021 - DescriptionAndTitleMissing | 'supportedFastProvisioningEditions' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L443 |
|
| :warning: R4030 - UniqueXmsExample | Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: NameAvailability Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/CheckNameAvailability.json#L88 |
|
| :warning: R4030 - UniqueXmsExample | Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ServerGet Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/FlexibleServers.json#L242 |
The following errors/warnings exist before current PR submission:
Only 18 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| :warning: R1003 - ListInOperationName | Since operation 'LocationBasedCapabilitiesExecute' response has model definition 'x-ms-pageable', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L42 |
| :warning: R1005 - GetInOperationName | 'GET' operation 'LocationBasedCapabilities_Execute' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L42 |
| :warning: R1006 - PutInOperationName | 'PUT' operation 'Configurations_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Configuration.json#L200 |
| :warning: R2029 - PageableOperation | Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Operations.json#L38 |
| :warning: R2066 - PostOperationIdContainsUrlVerb | OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/CheckNameAvailability.json#L42 |
| :warning: R2066 - PostOperationIdContainsUrlVerb | OperationId should contain the verb: 'getprivatednszonesuffix' in:'GetPrivateDnsZoneSuffix_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/PrivateDnsZone.json#L42 |
| :warning: R2066 - PostOperationIdContainsUrlVerb | OperationId should contain the verb: 'checkvirtualnetworksubnetusage' in:'VirtualNetworkSubnetUsage_Execute'. Consider updating the operationId Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/VirtualNetwork.json#L42 |
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: geoBackupSupported Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L403 |
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: zoneRedundantHaSupported Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L408 |
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: zoneRedundantHaAndGeoBackupSupported Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L413 |
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDynamicConfig Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Configuration.json#L310 |
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isReadOnly Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Configuration.json#L315 |
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isConfigPendingRestart Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Configuration.json#L320 |
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Operations.json#L111 |
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: restartWithFailover Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/ServerStartStopRestart.json#L206 |
| :warning: R4021 - DescriptionAndTitleMissing | 'supportedVcores' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L214 |
| :warning: R4021 - DescriptionAndTitleMissing | 'supportedStorageMB' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L240 |
| :warning: R4021 - DescriptionAndTitleMissing | 'supportedFlexibleServerEditions' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json#L418 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| :warning: MULTIPLE_API_VERSION | The default tag contains multiple API versions swaggers. readme: specification/postgresql/resource-manager/readme.md tag: specification/postgresql/resource-manager/readme.md#tag-package-2020-01-01 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 27 Errors, 0 Warnings failed [Detail]
Tag package-flexibleserver-2022-03-preview; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 33, untested: 0, failed: 27, passed: 6
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 18 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
"statusCode: 400, errorCode: NoRegisteredProviderFound, errorMessage: No registered resource provider found for location 'locationnaip6a75' and API version '2022-03-08-preview' for type 'locations/checkNameAvailability'. The supported api-versions are '2020-02-14-privatepreview, 2020-02-14-preview, 2020-11-05-preview, 2021-06-01-preview, 2021-06-01, 2022-01-20-preview, 2022-03-08-privatepreview, 2022-03-08-preview, 2022-05-01-privatepreview'. The supported locations are 'australiaeast, australiasoutheast, brazilsouth, canadaeast, canadacentral, centralindia, centralus, eastasia, eastus, eastus2, francecentral, francesouth, germanywestcentral, japaneast, japanwest, jioindiawest, koreacentral, koreasouth, northcentralus, northeurope, norwayeast, qatarcentral, southafricanorth, southcentralus, southeastasia, southindia, switzerlandnorth, switzerlandwest, swedencentral, uaenorth, uksouth, ukwest, westcentralus, westeurope, westus, westus2, westus3, eastus2euap'." |
|
"statusCode: 400, errorCode: VirtualNetworkDoesnotExist, errorMessage: The virtual network 'test-vnet' does not exist." |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DBforPostgreSQL/flexibleServers/servername1uouol' under resource group 'apiTest-mKsCTW-20212' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
️️✔️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: 7 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/f3f22fb49d04fd42396c86a9a570cfa70cef3033/specification/postgresql/resource-manager/readme.md#tag-package-flexibleserver-2022-03-preview">postgresql/resource-manager/readme.md#package-flexibleserver-2022-03-preview
- "https://github.com/Azure/azure-rest-api-specs/blob/f3f22fb49d04fd42396c86a9a570cfa70cef3033/specification/postgresql/resource-manager/readme.md#tag-package-flexibleserver-2022-03-privatepreview">postgresql/resource-manager/readme.md#package-flexibleserver-2022-03-privatepreview
| Rule | Message |
|---|---|
| :warning: PreCheck/PropertyRedeclarationWarning | "readme":"postgresql/resource-manager/readme.md", "tag":"package-flexibleserver-2022-03-preview", "details":"Schema 'ActiveDirectoryAdministrator' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from ActiveDirectoryAdministrator" |
| :warning: PreCheck/PropertyRedeclarationWarning | "readme":"postgresql/resource-manager/readme.md", "tag":"package-flexibleserver-2022-03-preview", "details":"Schema 'ServerBackup' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from ServerBackup" |
| :warning: PreCheck/PropertyRedeclarationWarning | "readme":"postgresql/resource-manager/readme.md", "tag":"package-flexibleserver-2022-03-preview", "details":"Schema 'Configuration' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from Configuration" |
| :warning: PreCheck/PropertyRedeclarationWarning | "readme":"postgresql/resource-manager/readme.md", "tag":"package-flexibleserver-2022-03-preview", "details":"Schema 'FirewallRule' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from FirewallRule" |
| :warning: PreCheck/PropertyRedeclarationWarning | "readme":"postgresql/resource-manager/readme.md", "tag":"package-flexibleserver-2022-03-preview", "details":"Schema 'Server' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from Server" |
| :warning: UnkownSecurityScheme | "readme":"postgresql/resource-manager/readme.md", "tag":"package-flexibleserver-2022-03-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
| :warning: UnkownSecurityScheme | "readme":"postgresql/resource-manager/readme.md", "tag":"package-flexibleserver-2022-03-privatepreview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - sdk/resourcemanager/postgresql/armpostgresql - 2.0.0+ Struct `CloudError` has been removed
❌azure-sdk-for-go - sdk/resourcemanager/postgresql/armpostgresqlflexibleservers - 2.0.0+ Struct `CloudError` has been removed
❌azure-sdk-for-python-track2 - track2_azure-mgmt-rdbms - Approved - 10.2.0b3+ Model DataEncryption no longer has parameter geo_backup_key_uri + Model DataEncryption no longer has parameter geo_backup_user_assigned_identity_id + Model ErrorResponse no longer has parameter additional_info + Model ErrorResponse no longer has parameter code + Model ErrorResponse no longer has parameter details + Model ErrorResponse no longer has parameter message + Model ErrorResponse no longer has parameter target + Model ServerForUpdate no longer has parameter location + Model UserAssignedIdentity has a new required parameter type + Model UserAssignedIdentity no longer has parameter client_id + Model UserAssignedIdentity no longer has parameter principal_id
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from f7386016ed8edfdc59d00003c1298afa6966842c. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json warn File azure-sdk-for-net_tmp/initOutput.json not found to read command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️Azure.ResourceManager.PostgreSql [View full logs] [Release SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from f7386016ed8edfdc59d00003c1298afa6966842c. SDK Automation 14.0.0command 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 minor version of npm available! 8.15.0 -> 8.19.2 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2> 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] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation group AdministratorsOperations info [Changelog] - Added operation group CheckNameAvailabilityWithLocationOperations info [Changelog] - Model CapabilityProperties has a new parameter fast_provisioning_supported info [Changelog] - Model CapabilityProperties has a new parameter supported_fast_provisioning_editions info [Changelog] - Model ErrorResponse has a new parameter error info [Changelog] - Model ProxyResource has a new parameter system_data info [Changelog] - Model Resource has a new parameter system_data info [Changelog] - Model Server has a new parameter auth_config info [Changelog] - Model Server has a new parameter data_encryption info [Changelog] - Model Server has a new parameter identity info [Changelog] - Model Server has a new parameter replica_capacity info [Changelog] - Model Server has a new parameter replication_role info [Changelog] - Model ServerForUpdate has a new parameter auth_config info [Changelog] - Model ServerForUpdate has a new parameter data_encryption info [Changelog] - Model ServerForUpdate has a new parameter identity info [Changelog] - Model ServerForUpdate has a new parameter version info [Changelog] - Model ServerVersionCapability has a new parameter supported_versions_to_upgrade info [Changelog] - Model Sku has a new parameter capacity info [Changelog] - Model Sku has a new parameter family info [Changelog] - Model Sku has a new parameter size info [Changelog] - Model StorageMBCapability has a new parameter supported_upgradable_tier_list info [Changelog] - Model TrackedResource has a new parameter system_data info [Changelog] - Model UserAssignedIdentity has a new parameter user_assigned_identities info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Model DataEncryption no longer has parameter geo_backup_key_uri info [Changelog] - Model DataEncryption no longer has parameter geo_backup_user_assigned_identity_id info [Changelog] - Model ErrorResponse no longer has parameter additional_info info [Changelog] - Model ErrorResponse no longer has parameter code info [Changelog] - Model ErrorResponse no longer has parameter details info [Changelog] - Model ErrorResponse no longer has parameter message info [Changelog] - Model ErrorResponse no longer has parameter target info [Changelog] - Model ServerForUpdate no longer has parameter location info [Changelog] - Model UserAssignedIdentity has a new required parameter type info [Changelog] - Model UserAssignedIdentity no longer has parameter client_id info [Changelog] - Model UserAssignedIdentity no longer has parameter principal_id
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from f7386016ed8edfdc59d00003c1298afa6966842c. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-postgresqlflexibleserver [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from f7386016ed8edfdc59d00003c1298afa6966842c. SDK Automation 14.0.0command 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/postgresql/armpostgresql [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [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/postgresql/armpostgresqlflexibleservers [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [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).
️⚠️ azure-sdk-for-js warning [Detail]
⚠️Warning [Logs]Release - Generate from f7386016ed8edfdc59d00003c1298afa6966842c. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json warn No file changes detected after generation warn No package detected after generation
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from f7386016ed8edfdc59d00003c1298afa6966842c. Schema Automation 14.0.0command .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
️✔️postgresql [View full logs] [Release Schema Changes]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from f7386016ed8edfdc59d00003c1298afa6966842c. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
️✔️Az.PostgreSql [View full logs] [Release SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/postgresql/armpostgresql | https://apiview.dev/Assemblies/Review/fc509558261042de81ce2ce8f4468db9 |
| Go | sdk/resourcemanager/postgresql/armpostgresqlflexibleservers | https://apiview.dev/Assemblies/Review/1a9500a2f3f0436aaa468187f379a60e |
| Python | track2_azure-mgmt-rdbms | Create ApiView timeout. Package is too large and we cannot create ApiView for it. |
| Java | azure-resourcemanager-postgresqlflexibleserver | https://apiview.dev/Assemblies/Review/d347a29568a548f68c3500a1a33e0ed1 |
| .Net | Azure.ResourceManager.PostgreSql | There is no API change compared with the previous version |
Hi @ambrahma, 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.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Hi @ambrahma, 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.
Hi, @ambrahma your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
For Python breaking change, we need sign off from Python team. BigCat20196 (Jiefeng Chen) could do it.
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
@ambrahma - This is a huge refactoring combined with adding a new API version. That makes it nearly impossible to review, since we have no way of knowing what's changed, what's new, what's removed, etc. This is why we ask teams do refactoring in separate PRs before or after creating new API version PRs.
This PR apparently moves the existing specs contained in these 10 files (across 16 existing API versions):
postgresql.json PrivateEndpointConnections.json PrivateLinkResources.json DataEncryptionKeys.json Databases.json PrivateDnsZone.json IntelligentPerformance.json QueryPerformanceInsights.json Migrations.json getCachedServerName.json ServerSecurityAlertPolicies.json PerformanceRecommendations.json
to these 15 files in the new API version (2022-03-08-preview):
Administrators.json Backups.json CachedServerName.json Capabilities.json CheckNameAvailability.json Configuration.json Database.json Databases.json FirewallRules.json FlexibleServers.json Operations.json postgresql.json PrivateDnsZone.json ServerStartStopRestart.json VirtualNetwork.json
I'm trying to figure out how to do ARM review. We need some help here:
- Which API version(s) is 2022-03-08-preview replacing?
- Which files have the new APIs?
- Which existing APIs are changed?
- Which files were they in before this PR?
- Which files within this PR are they in?
- Are any APIs removed?
- How do the specs in the existing files map to the new ones? Only 2 files have the same name before and after, a couple others are similar.
@ambrahma - This is a huge refactoring combined with adding a new API version. That makes it nearly impossible to review, since we have no way of knowing what's changed, what's new, what's removed, etc. This is why we ask teams do refactoring in separate PRs before or after creating new API version PRs.
This PR apparently moves the existing specs contained in these 10 files (across 16 existing API versions):
postgresql.json PrivateEndpointConnections.json PrivateLinkResources.json DataEncryptionKeys.json Databases.json PrivateDnsZone.json IntelligentPerformance.json QueryPerformanceInsights.json Migrations.json getCachedServerName.json ServerSecurityAlertPolicies.json PerformanceRecommendations.json
to these 15 files in the new API version (2022-03-08-preview):
Administrators.json Backups.json CachedServerName.json Capabilities.json CheckNameAvailability.json Configuration.json Database.json Databases.json FirewallRules.json FlexibleServers.json Operations.json postgresql.json PrivateDnsZone.json ServerStartStopRestart.json VirtualNetwork.json
I'm trying to figure out how to do ARM review. We need some help here:
- Which API version(s) is 2022-03-08-preview replacing?
- Which files have the new APIs?
- Which existing APIs are changed?
- Which files were they in before this PR?
- Which files within this PR are they in?
- Are any APIs removed?
- How do the specs in the existing files map to the new ones? Only 2 files have the same name before and after, a couple others are similar.
@mentat9 thank you sharing the problem you are facing with this review. Sorry I didn't realize that the refactoring alongwith the new api changes would result into this confusion.
Here are the required details you requested:
- 2022-03-08-preview version is the new api version we want to introduce for public preview. This is based out of the version 2022-01-20-preview version. However, there were some changes made in 2022-03-08-previewpreview version for getCachedServerName.json which I have included in this new version too.
- Administrators.json is the only new api introduced here.
- capabilities api in Capabilities.json was updated to have more properties introduced in the response. This api was initially in postgresql.json FlexibleServers.json file have some new examples added for Create and Update which involves some new properties to be updated. This api was earlier in postgresql.json.
- Existing apis are not removed in this PR.
- postgresql.json (from 2022-01-20-preview) was split into following files: Backups.json Capabilities.json CheckNameAvailability.json Configuration.json FirewallRules.json FlexibleServers.json Operations.json ServerStartStopRestart.json VirtualNetwork.json
Databases.json (from 2022-01-20-preview) is now Database.json (Sorry about this change as it was throwing LintDiff error after adding type object for some existing definitions for Database and DatabaseProperties.)
PrivateDnsZone.json (from 2022-01-20-preview) is mapped to PrivateDnsZone.json.
getCachedServerName.json (from 2022-03-08-privatepreview) is mapped to CachedServerName.json
Let me know if you need any other information from my end.
@ambrahma - while you're in refactoring mode, I'd suggest you to take full advantage of common-types and not declare those yourself, that's also going to be quite helpful for reducing the amount of stuff you have that really could need reviewing, or ways you could accidentally deviate from the RPC. I'll add more detailed feedback if I have it.
@ambrahma - while you're in refactoring mode, I'd suggest you to take full advantage of common-types and not declare those yourself, that's also going to be quite helpful for reducing the amount of stuff you have that really could need reviewing, or ways you could accidentally deviate from the RPC. I'll add more detailed feedback if I have it.
COmpleted requested changes
@BigCat20196 can you please help review this PR for Python breaking change issue?
@TimLovellSmith looks like you missed to add appropriate tag for ARM review. Current tag still shows WaitForARMFeedback
@suhasrao My feedback has been addressed, but could you please take a look at signoff? Hopefully there are few remaining issues, but I think it'd be good to have more experienced eyes on what is a large PR.
Hi @ambrahma I found there is breakingchange, you need start breakingchange review follow this.
Hi @ambrahma, 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.
@tianxchen-ms Looks to me like one of the breaking change errors is caused by an actual bugfix in PrivateDnsZone.json - the old definition of CloudError (used as the error response) looks wrong to me. It would have had an extra 'error' wrapper around the error response:
"CloudError": {
"type": "object",
"x-ms-external": true,
"properties": {
"error": {
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse"
}
},
"description": "An error response from the Batch service."
@TimLovellSmith I mean need to involve breaking change reviewer into this big PR. Now there are already 20+ errors. @ambrahma Could you create a new intake to involve them following this
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.
@TimLovellSmith I mean need to involve breaking change reviewer into this big PR. Now there are already 20+ errors. @ambrahma Could you create a new intake to involve them following this
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.
Initiated new breaking change request here https://msazure.visualstudio.com/One/_workitems/edit/15853327. Please get this approved at the earliest as this has been triggered without any actual breaking change
Hi @ambrahma I found there is breakingchange, you need start breakingchange review follow this.
Hi @ambrahma, 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.
Triggered this Braking change template for review https://msazure.visualstudio.com/One/_workitems/edit/15853327