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

[KeyVault] - Address various architecture feedback #14997

Merged
merged 4 commits into from
Apr 30, 2021

Conversation

maorleger
Copy link
Member

What

  • KeyVaultBackupClient constructor: pipelineOptions -> options
  • CryptographyClient: keyId -> keyID
  • createKeyOptions: +hsm

Why

As part of pre-GA architecture feedback with @chradek we discovered a few things that we would want to address
before we GA the KeyVault packages in May. This PR is meant to collect all the various items and keep track of what
was changed.

@ghost ghost added the KeyVault label Apr 23, 2021
@check-enforcer
Copy link

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 js - [service] - ci

@maorleger
Copy link
Member Author

@chradek @sadasant mind reviewing this PR when you get a chance?

Copy link
Contributor

@chradek chradek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good. Just a minor nit.

@@ -142,7 +142,7 @@ export class CryptographyClient {
/**
* The ID of the key used to perform cryptographic operations for the client.
*/
get keyId(): string | undefined {
get keyID(): string | undefined {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes me a little sad that this is keyID instead of keyId, but it does make it consistent with the rest of the interfaces in this package (if inconsistent with the rest of the keyvault packages)

sdk/keyvault/keyvault-admin/src/backupClient.ts Outdated Show resolved Hide resolved
@maorleger maorleger merged commit afa90eb into Azure:master Apr 30, 2021
@maorleger maorleger deleted the arch-feedback branch April 30, 2021 13:05
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-js that referenced this pull request Jul 9, 2021
Adding 2020-09-Preview same as 11-preview (Azure#14997)

* Adding 2020-09-Preview same as 11-preview

* fixing lint issue

* fixing model

* fixing model

* fixing model

* pretify fix

* fixing linting

* more linting fix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants