-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Microsoft.KeyVault 2023-07-01 Add changes for Trusted Access Mode #23813
Microsoft.KeyVault 2023-07-01 Add changes for Trusted Access Mode #23813
Conversation
Hi, @fssevero 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. [email protected] |
Hi, @fssevero your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
common.json | 2023-07-01(0ac12df) | 2023-02-01(main) |
common.json | 2023-07-01(0ac12df) | 2022-02-01-preview(main) |
keys.json | 2023-07-01(0ac12df) | 2023-02-01(main) |
keys.json | 2023-07-01(0ac12df) | 2022-02-01-preview(main) |
keysManagedHsm.json | 2023-07-01(0ac12df) | 2023-02-01(main) |
keyvault.json | 2023-07-01(0ac12df) | 2023-02-01(main) |
keyvault.json | 2023-07-01(0ac12df) | 2022-02-01-preview(main) |
managedHsm.json | 2023-07-01(0ac12df) | 2023-02-01(main) |
managedHsm.json | 2023-07-01(0ac12df) | 2022-02-01-preview(main) |
providers.json | 2023-07-01(0ac12df) | 2023-02-01(main) |
providers.json | 2023-07-01(0ac12df) | 2022-02-01-preview(main) |
secrets.json | 2023-07-01(0ac12df) | 2023-02-01(main) |
secrets.json | 2023-07-01(0ac12df) | 2022-02-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The new version has a different default value than the previous one. New: Microsoft.KeyVault/stable/2023-07-01/keys.json#L482:9 Old: Microsoft.KeyVault/preview/2022-02-01-preview/keys.json#L482:9 |
|
The new version has a different default value than the previous one. New: Microsoft.KeyVault/stable/2023-07-01/managedHsm.json#L1350:9 Old: Microsoft.KeyVault/preview/2022-02-01-preview/managedHsm.json#L1250:9 |
|
The new version has a different default value than the previous one. New: Microsoft.KeyVault/stable/2023-07-01/managedHsm.json#L1362:9 Old: Microsoft.KeyVault/preview/2022-02-01-preview/managedHsm.json#L1263:9 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) | new version | base version |
---|---|---|
package-2023-07 | package-2023-07(0ac12df) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PutRequestResponseSchemeArm |
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: 'Keys_CreateIfNotExist' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.KeyVault/stable/2023-07-01/keys.json#L14 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.KeyVault/stable/2023-07-01/keys.json#L60 |
DefinitionsPropertiesNamesCamelCase |
Property name should be camel case. Location: Microsoft.KeyVault/stable/2023-07-01/keys.json#L428 |
AllTrackedResourcesMustHaveDelete |
The resource Key does not have a corresponding delete operation. Location: Microsoft.KeyVault/stable/2023-07-01/keys.json#L512 |
TrackedResourcePatchOperation |
Tracked resource 'Key' must have patch operation that at least supports the update of tags. Location: Microsoft.KeyVault/stable/2023-07-01/keys.json#L512 |
XmsParameterLocation |
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.KeyVault/stable/2023-07-01/keys.json#L646 |
XmsParameterLocation |
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.KeyVault/stable/2023-07-01/keys.json#L653 |
PutRequestResponseSchemeArm |
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: 'ManagedHsmKeys_CreateIfNotExist' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.KeyVault/stable/2023-07-01/keysManagedHsm.json#L14 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.KeyVault/stable/2023-07-01/keysManagedHsm.json#L46 |
PutRequestResponseSchemeArm |
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: 'Vaults_CreateOrUpdate' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema' Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L14 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L69 |
RequestSchemaForTrackedResourcesMustHaveTags |
A tracked resource MUST always have tags as a top level optional property. Tracked resource does not have tags in the request schema. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L268 |
PutResponseSchemaDescription |
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L322 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L511 |
ParametersOrder |
The parameters:vaultName,location should be kept in the same order as they present in the path. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L512 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L567 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L568 |
ParametersOrder |
The parameters:vaultName,location should be kept in the same order as they present in the path. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L568 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L568 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L601 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L607 |
PathContainsResourceType |
The path for the CURD methods do not contain a resource type. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L624 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L750 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L789 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L843 |
DeleteResponseBodyEmpty |
The delete response body must be empty. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L903 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L927 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L1014 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L1067 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.KeyVault/stable/2023-07-01/keyvault.json#L1076 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView 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).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
Hi, @fssevero, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
16 similar comments
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @fssevero. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
…3813) * Adds base for updating Microsoft.KeyVault from version stable/2023-02-01 to version 2023-07-01 * Updates readme * Updates API version in new specs and examples * Add Identity to managed HSM resources * Remove ManagedHsmIdentityTargetResource * use common type for Identity * Update identity definition * Update readme.python.md * Update readme.python.md --------- Co-authored-by: Yuchao Yan <[email protected]>
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.
-[X] 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.