-
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
Adding ResourceGuardProxy APIs to Microsoft.Dataprotection latest stable version #22574
Conversation
Hi, @Charan000 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.10.4)] | new version | base version |
---|---|---|
dataprotection.json | 2023-01-01(96d6481) | 2023-01-01(main) |
Rule | Message |
---|---|
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L3460:5 |
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L3508:5 |
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L3672:5 |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 3 Errors, 1 Warnings failed [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2023-01 | package-2023-01(96d6481) | package-2023-01(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L3460 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L3508 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L3672 |
RPC-Uri-V1-05 |
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L7294 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ParametersOrder |
The parameters:operationId,location should be kept in the same order as they present in the path. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L64 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L94 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L184 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L328 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L375 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L440 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L467 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L526 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L544 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L580 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L761 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L809 |
ResourceNameRestriction |
The resource name parameter 'backupPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L809 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L969 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1017 |
ResourceNameRestriction |
The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1017 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1064 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1112 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1139 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1205 |
ResourceNameRestriction |
The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1205 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1206 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1281 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1282 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1354 |
ResourceNameRestriction |
The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1354 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'BackupInstances' 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.DataProtection/stable/2023-01-01/dataprotection.json#L1360 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1394 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1394 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1411 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 38 Errors, 0 Warnings failed [Detail]
Tag package-2023-01; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 66, untested: 0, failed: 31, passed: 35
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
CLIENT_ERROR |
statusCode: 400, errorCode: UserErrorInvalidRequestParameter, errorMessage: Parameter PolicyName in request is invalid Source: runtime OperationId: BackupInstances_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 400, errorCode: BMSUserErrorInvalidInput, errorMessage: Input provided for the call is invalid Source: runtime OperationId: BackupInstances_GetBackupInstanceOperationResult |
CLIENT_ERROR |
statusCode: 404, errorCode: UserErrorGenericResourceNotFound, errorMessage: Azure resource does not exist. Please make sure required resources exist. If the issue persists, contact Microsoft support. Source: runtime OperationId: BackupInstances_Get |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: innerError Source: response OperationId: BackupInstances_Get |
CLIENT_ERROR |
statusCode: 400, errorCode: UserErrorInvalidRequestParameter, errorMessage: Parameter BackupInstance in request is invalid Source: runtime OperationId: BackupInstances_AdhocBackup |
CLIENT_ERROR |
statusCode: 403, errorCode: LinkedAuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' has permission to perform action 'Microsoft.DataProtection/backupVaults/backupInstances/validateRestore/action' on scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-fcBnEM-22574/providers/Microsoft.DataProtection/backupVaults/vaultnamns018o/backupInstances/backupinc4ohia'; however, it does not have permission to perform action 'read' on the linked scope(s) '/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb' or the linked scope(s) are invalid. Source: runtime OperationId: BackupInstances_ValidateForRestore |
CLIENT_ERROR |
statusCode: 400, errorCode: UserErrorInvalidRequestParameter, errorMessage: Parameter BackupInstance in request is invalid Source: runtime OperationId: BackupInstances_SyncBackupInstance |
CLIENT_ERROR |
statusCode: 400, errorCode: UserErrorInvalidRequestParameter, errorMessage: Parameter BackupInstance in request is invalid Source: runtime OperationId: BackupInstances_SuspendBackups |
CLIENT_ERROR |
statusCode: 400, errorCode: UserErrorInvalidRequestParameter, errorMessage: Parameter BackupInstance in request is invalid Source: runtime OperationId: BackupInstances_StopProtection |
CLIENT_ERROR |
statusCode: 400, errorCode: UserErrorInvalidRequestParameter, errorMessage: Parameter BackupInstance in request is invalid Source: runtime OperationId: BackupInstances_ResumeBackups |
CLIENT_ERROR |
statusCode: 400, errorCode: UserErrorInvalidRequestParameter, errorMessage: Parameter BackupInstance in request is invalid Source: runtime OperationId: BackupInstances_ResumeProtection |
CLIENT_ERROR |
statusCode: 403, errorCode: LinkedAuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' has permission to perform action 'Microsoft.DataProtection/backupVaults/backupInstances/restore/action' on scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-fcBnEM-22574/providers/Microsoft.DataProtection/backupVaults/vaultnamns018o/backupInstances/backupinc4ohia'; however, it does not have permission to perform action 'read' on the linked scope(s) '/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb' or the linked scope(s) are invalid. Source: runtime OperationId: BackupInstances_TriggerRestore |
CLIENT_ERROR |
statusCode: 403, errorCode: LinkedAuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' has permission to perform action 'Microsoft.DataProtection/backupVaults/validateForBackup/action' on scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-fcBnEM-22574/providers/Microsoft.DataProtection/backupVaults/vaultnamns018o'; however, it does not have permission to perform action 'read' on the linked scope(s) '/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest' or the linked scope(s) are invalid. Source: runtime OperationId: BackupInstances_ValidateForBackup |
SERVER_ERROR |
statusCode: 500, errorCode: CloudInternalError, errorMessage: Microsoft Azure Backup encountered an internal error. Wait for a few minutes and then try the operation again. If the issue persists, please contact Microsoft support. Source: runtime OperationId: BackupInstances_TriggerRehydrate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: innerError Source: response OperationId: BackupInstances_TriggerRehydrate |
CLIENT_ERROR |
statusCode: 400, errorCode: BMSUserErrorResourceGuardResourceDoesntExist, errorMessage: ResourceGuard resource doesn't exist. Source: runtime OperationId: DppResourceGuardProxy_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: DppResourceGuardProxy_Get |
CLIENT_ERROR |
statusCode: 403, errorCode: LinkedAuthorizationFailed, errorMessage: The client has permission to perform action 'Microsoft.DataProtection/resourceGuards/deleteBackupInstanceRequests/approve/action' on scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-fcBnEM-22574/providers/Microsoft.DataProtection/backupVaults/vaultnamns018o/backupResourceGuardProxies/resourcedpwbjm', however the linked subscription 'f9e67185-f313-4e79-aa71-6458d429369d' was not found. Source: runtime OperationId: DppResourceGuardProxy_UnlockDelete |
CLIENT_ERROR |
statusCode: 400, errorCode: UserErrorInvalidRequestParameter, errorMessage: Parameter DataSourceType in request is invalid Source: runtime OperationId: BackupPolicies_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: UserErrorGenericResourceNotFound, errorMessage: Azure resource does not exist. Please make sure required resources exist. If the issue persists, contact Microsoft support. Source: runtime OperationId: BackupPolicies_Get |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: innerError Source: response OperationId: BackupPolicies_Get |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.DataProtection/locations/checkFeatureSupport/action' over scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: DataProtection_CheckFeatureSupport |
CLIENT_ERROR |
statusCode: 400, errorCode: BMSUserErrorInvalidInput, errorMessage: Input provided for the call is invalid Source: runtime OperationId: OperationResult_Get |
CLIENT_ERROR |
statusCode: 400, errorCode: BMSUserErrorInvalidInput, errorMessage: Input provided for the call is invalid Source: runtime OperationId: OperationStatus_Get |
CLIENT_ERROR |
statusCode: 400, errorCode: UserErrorInvalidRequestParameter, errorMessage: Parameter backupInstanceName in request is invalid Source: runtime OperationId: RestorableTimeRanges_Find |
CLIENT_ERROR |
statusCode: 404, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: RecoveryPoints_List |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: value Source: response OperationId: RecoveryPoints_List |
CLIENT_ERROR |
statusCode: 404, errorCode: UserErrorGenericResourceNotFound, errorMessage: Azure resource does not exist. Please make sure required resources exist. If the issue persists, contact Microsoft support. Source: runtime OperationId: RecoveryPoints_Get |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: innerError Source: response OperationId: RecoveryPoints_Get |
SERVER_ERROR |
statusCode: 500, errorCode: CloudInternalError, errorMessage: Microsoft Azure Backup encountered an internal error. Source: runtime OperationId: ExportJobsOperationResult_Get |
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
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.
Swagger Generation Artifacts
|
Generated ApiView
|
Please DO NOT delete the first comment or the labels can not be added properly. |
Hi @Charan000, Your PR has some issues. Please fix the CI sequentially by following the order of
|
NewApiVersionRequired reason: |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Confirmed with @Charan000 , owner of "vaultName" will fix the linter issue. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
adding change to newer version ResourceGuardProxy APIs and example fixing parameter refs fixing refs incorrect ref fixes pattern for resourceGuardProxyName param semantic fixes
This version in staging right now and service team aren't adding a whole new API version. They plan to add it later. |
…ble version (Azure#22574) * manual swagger fix adding change to newer version ResourceGuardProxy APIs and example fixing parameter refs fixing refs incorrect ref fixes pattern for resourceGuardProxyName param semantic fixes * warning fixes --------- Co-authored-by: Charan MVS <smadu@microsoft.com>
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.