Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[Key Vault] Arch board feedback and language alignment #23286

Merged
merged 7 commits into from
Mar 8, 2022

Conversation

mccoyp
Copy link
Member

@mccoyp mccoyp commented Mar 2, 2022

Description

Resolves #22981:

Per the most recent round of feedback for azure-keyvault-keys, we need to take a look at a few more pieces of feedback before the upcoming stable release:

  • Move the optional version parameter in KeyClient.release_key into keyword-only arguments
  • Try to get update_key_rotation_policy and get_key_rotation_policy to round-trip
    • "If I get a rotation policy - I should be able to pass that back in again, with optional kwargs to overwrite specific attributes."
  • Compare key encryption algorithm enums with cryptography names and align where possible
    • cryptography uses aes_key_wrap as the algorithm name and doesn't provide different versions based on number of bytes. For the sake of differentiating our algorithms, and because ckm_rsa_aes_key_wrap is a standard algorithm name in the space, we can keep our KeyExportEncryptionAlgorithm value names. Other algorithms are unchanged and standard
  • Make all enums consistently lower-case
  • Rename name parameter in KeyClient.get_key_rotation_policy and KeyClient.update_key_rotation_policy to key_name

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@mccoyp mccoyp added KeyVault Client This issue points to a problem in the data-plane of the library. labels Mar 2, 2022
@azure-sdk
Copy link
Collaborator

API changes have been detected in azure-keyvault-keys. You can review API changes here

API changes

-             version: str = None, 
+             version: Optional[str] = ..., 
-             version: str = None, 
+             version: Optional[str] = ..., 

@check-enforcer
Copy link

check-enforcer bot commented Mar 3, 2022

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run python - [service] - ci

@azure-sdk
Copy link
Collaborator

API changes have been detected in azure-keyvault-keys. You can review API changes here

1 similar comment
@azure-sdk
Copy link
Collaborator

API changes have been detected in azure-keyvault-keys. You can review API changes here

@mccoyp mccoyp marked this pull request as ready for review March 3, 2022 06:35
@azure-sdk
Copy link
Collaborator

API changes have been detected in azure-keyvault-keys. You can review API changes here

@mccoyp mccoyp requested a review from seankane-msft March 3, 2022 20:13
@mccoyp mccoyp requested a review from YalinLi0312 March 4, 2022 19:24
@mccoyp mccoyp force-pushed the keys-arch-feedback branch from dec5995 to ca4a069 Compare March 4, 2022 22:41
@azure-sdk
Copy link
Collaborator

API changes have been detected in azure-keyvault-keys. You can review API changes here

@mccoyp mccoyp merged commit 0e5bbcd into Azure:main Mar 8, 2022
@mccoyp mccoyp deleted the keys-arch-feedback branch March 8, 2022 20:09
iscai-msft added a commit to iscai-msft/azure-sdk-for-python that referenced this pull request Mar 9, 2022
…into new_metrics_advisor

* 'main' of https://github.com/Azure/azure-sdk-for-python: (28 commits)
  [Storage] Fix duplicate type signatures in async (Azure#23375)
  Adds Env Var that overrides x-ms-useragent, to correct test pipeline (Azure#23310)
  [Key Vault] Arch board feedback and language alignment (Azure#23286)
  include txt sample files in package (Azure#23409)
  [KeyVault Admin] Add one perfstress test (Azure#23303)
  Increment version for search releases (Azure#23405)
  fix version on readme (Azure#23408)
  Increment version for identity releases (Azure#23407)
  [formrecognizer] Fix cspell issues (Azure#23313)
  Increment package version after release of azure-synapse-artifacts (Azure#23393)
  [pylint] dev_requirements.txt for pylint (Azure#23387)
  [Sql] Update sql tests (Azure#23398)
  code and test (Azure#23397)
  [Sql] Migrate sql tests to test proxy (Azure#23388)
  Update swagger to latest version (Azure#23377)
  Sync eng/common directory with azure-sdk-tools for PR 2875 (Azure#23379)
  [formrecognizer] Improve live pipeline tests (Azure#23239)
  update min version of azure-mgmt-core in shared reqs (Azure#23374)
  [CredScan] Suppress warnings for "username" string (Azure#23358)
  [synapse] regenerate `azure-synapse-artifacts` with tag `package-artifacts-composite-v3` (Azure#23295)
  ...
rakshith91 pushed a commit to rakshith91/azure-sdk-for-python that referenced this pull request Apr 7, 2022
rakshith91 pushed a commit to rakshith91/azure-sdk-for-python that referenced this pull request Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client This issue points to a problem in the data-plane of the library. KeyVault
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Key Vault] Address remaining architect feedback for keys
6 participants