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.

Sign up for GitHub

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] Documenting the lack of browser support #9716

Merged
merged 5 commits into from
Jun 27, 2020
Merged

[KeyVault] Documenting the lack of browser support #9716

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
558af6d
[KeyVault] Documenting the lack of browser support
sadasant Jun 25, 2020
551cba7
typo
sadasant Jun 25, 2020
9855b25
feedback, and same note in other READMEs
sadasant Jun 25, 2020
db96ef5
colon
sadasant Jun 25, 2020
04b82e7
feedback by Ramya
sadasant Jun 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions sdk/keyvault/keyvault-certificates/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ Use the client library for Azure Key Vault Certificates in your Node.js applicat
- Get all certificates.
- Get all deleted certificates.

> Important note about browser support:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this won't get collapsed because of the two spaces at the end of this line. Same with the other READMEs

Copy link
Contributor

@ramya-rao-a ramya-rao-a Jun 26, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

We don't really need to call out that a note is "important". Also when someone is reading this on npm, they would have no context on "azure-sdk-for-js". I would recommend something simpler like the below

Note: This package cannot be used in the browser due to Azure Key Vault service limitations.

> Even though we're designing the `azure-sdk-for-js` to be isomorphic as a whole, meaning that it should work both in NodeJS and in web browsers, due to service limitations we're unable to provide browser support for the Key Vault libraries.

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-certificates) | [Package (npm)](https://www.npmjs.com/package/@azure/keyvault-certificates) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/keyvault-certificates) | [Product documentation](https://azure.microsoft.com/en-us/services/key-vault/) | [Samples](./samples)

## Getting started
Expand Down
7 changes: 5 additions & 2 deletions sdk/keyvault/keyvault-keys/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ If you would like to know more about Azure Key Vault, you may want to review: [W
Azure Key Vault Key management allows you to create and control
encryption keys that encrypt your data.

Use the client library for Azure Key Vault Keys in your Node.js application to
Use the client library for Azure Key Vault Keys in your Node.js application to:

- Create keys using elliptic curve or RSA encryption, optionally backed by Hardware Security Modules (HSM).
- Import, Delete, and Update keys.
- Get one or more keys and deleted keys, with their attributes.
- Recover a deleted key and restore a backed up key.
- Get the versions of a key.

Using the cryptography client available in this library you also have access to
Using the cryptography client available in this library you also have access to:

- Encrypting
- Decrypting
Expand All @@ -23,6 +23,9 @@ Using the cryptography client available in this library you also have access to
- Wrapping keys
- Unwrapping keys

> Important note about browser support:
> Even though we're designing the `azure-sdk-for-js` to be isomorphic as a whole, meaning that it should work both in NodeJS and in web browsers, due to service limitations we're unable to provide browser support for the Key Vault libraries.

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-keys) | [Package (npm)](https://www.npmjs.com/package/@azure/keyvault-keys) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/keyvault-keys) | [Product documentation](https://azure.microsoft.com/en-us/services/key-vault/) | [Samples](./samples)

## Getting started
Expand Down
5 changes: 4 additions & 1 deletion sdk/keyvault/keyvault-secrets/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Azure Key Vault Secrets management allows you to securely store and
tightly control access to tokens, passwords, certificates, API keys,
and other secrets.

Use the client library for Azure Key Vault Secrets in your Node.js application to
Use the client library for Azure Key Vault Secrets in your Node.js application to:

- Get, set and delete secrets.
- Update a secret and it's attributes.
Expand All @@ -17,6 +17,9 @@ Use the client library for Azure Key Vault Secrets in your Node.js application t
- Get all secrets.
- Get all deleted secrets.

> Important note about browser support:
> Even though we're designing the `azure-sdk-for-js` to be isomorphic as a whole, meaning that it should work both in NodeJS and in web browsers, due to service limitations we're unable to provide browser support for the Key Vault libraries.

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-secrets) | [Package (npm)](https://www.npmjs.com/package/@azure/keyvault-secrets) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/keyvault-secrets) | [Product documentation](https://azure.microsoft.com/en-us/services/key-vault/) | [Samples](./samples)

## Getting started
Expand Down