-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Removed literal links from Key Vault READMEs and replaced them with v…
…ariables. Moved Administration and JCA samples to the correct directory hierarchy. Added missing sections to JCA README. (#18194)
- Loading branch information
Showing
13 changed files
with
141 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,9 @@ | ||
# Azure Key Vault Administration library for Java | ||
Azure Key Vault Managed HSM is a fully-managed, highly-available, single-tenant, standards-compliant cloud service that enables you to safeguard cryptographic keys for your cloud applications using FIPS 140-2 Level 3 validated HSMs. | ||
|
||
The Azure Key Vault Administration library clients support administrative tasks such as full backup/restore and key-level role-based access control (RBAC). | ||
|
||
[Source code][source_code] | [API reference documentation][api_documentation] | [Product documentation][azkeyvault_docs] | [Samples][keys_samples] | ||
|
||
## Getting started | ||
### Adding the package to your project | ||
|
@@ -17,7 +22,7 @@ Maven dependency for the Azure Key Vault Administration library. Add it to your | |
### Prerequisites | ||
- A [Java Development Kit (JDK)][jdk_link], version 8 or later. | ||
- [Azure Subscription][azure_subscription] | ||
- An existing [Azure Key Vault][azure_keyvault]. If you need to create a Key Vault, you can use the [Azure Cloud Shell](https://shell.azure.com/bash) to create one with this Azure CLI command. Replace `<your-resource-group-name>` and `<your-key-vault-name>` with your own, unique names: | ||
- An existing [Azure Key Vault][azure_keyvault]. If you need to create a Key Vault, you can use the [Azure Cloud Shell][azure_cloud_shell] to create one with this Azure CLI command. Replace `<your-resource-group-name>` and `<your-key-vault-name>` with your own, unique names: | ||
|
||
```Bash | ||
az keyvault create --resource-group <your-resource-group-name> --name <your-key-vault-name> | ||
|
@@ -29,9 +34,9 @@ In order to interact with the Azure Key Vault service, you'll need to either cre | |
The `DefaultAzureCredential` way of authentication by providing client secret credentials is being used in this getting started section but you can find more ways to authenticate with [azure-identity][azure_identity]. | ||
#### Create/Get credentials | ||
To create/get client secret credentials you can use the [Azure Portal][azure_create_application_in_portal], [Azure CLI][azure_keyvault_cli_full] or [Azure Cloud Shell](https://shell.azure.com/bash) | ||
To create/get client secret credentials you can use the [Azure Portal][azure_create_application_in_portal], [Azure CLI][azure_keyvault_cli_full] or [Azure Cloud Shell][azure_cloud_shell] | ||
Here is an [Azure Cloud Shell](https://shell.azure.com/bash) snippet below to | ||
Here is an [Azure Cloud Shell][azure_cloud_shell] snippet below to | ||
* Create a service principal and configure its access to Azure resources: | ||
|
@@ -419,7 +424,7 @@ try { | |
``` | ||
### Default HTTP client | ||
All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the [HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). | ||
All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the [HTTP clients wiki][http_clients_wiki]. | ||
### Default SSL library | ||
All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an Uber JAR containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. | ||
|
@@ -435,10 +440,10 @@ This project welcomes contributions and suggestions. Most contributions require | |
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. | ||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the Code of Conduct FAQ or contact <[email protected]> with any additional questions or comments. | ||
This project has adopted the [Microsoft Open Source Code of Conduct][microsoft_code_of_conduct]. For more information see the Code of Conduct FAQ or contact <[email protected]> with any additional questions or comments. | ||
<!-- LINKS --> | ||
[source_code]: src | ||
[source_code]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/keyvault/azure-security-keyvault-administration/src | ||
[api_documentation]: https://azure.github.io/azure-sdk-for-java | ||
[azkeyvault_docs]: https://docs.microsoft.com/azure/key-vault/ | ||
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/identity/azure-identity | ||
|
@@ -451,9 +456,13 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope | |
[azure_create_application_in_portal]: https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal | ||
[azure_keyvault_cli]: https://docs.microsoft.com/azure/key-vault/quick-create-cli | ||
[azure_keyvault_cli_full]: https://docs.microsoft.com/cli/azure/keyvault?view=azure-cli-latest | ||
[administration_samples]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/keyvault/azure-security-keyvault-administration/src/samples/java/com/azure/security/keyvault/administration | ||
[storage_readme_sas_token]: https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/storage/azure-storage-blob#get-credentials | ||
[portal_sas_token]: https://docs.microsoft.com/azure/vs-azure-tools-storage-manage-with-storage-explorer?tabs=windows#generate-a-shared-access-signature-in-storage-explorer | ||
[performance_tuning]: https://github.com/Azure/azure-sdk-for-java/wiki/Performance-Tuning | ||
[jdk_link]: https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable | ||
[azure_cloud_shell]: https://shell.azure.com/bash | ||
[http_clients_wiki]: https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients | ||
[microsoft_code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ | ||
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Fkeyvault%2Fazure-security-keyvault-administration%2FREADME.png) |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
# Azure Key Vault Certificate client library for Java | ||
Azure Key Vault allows you to securely manage and tightly control your certificates. The Azure Key Vault Certificate client library supports certificates backed by RSA and EC keys. | ||
|
||
Multiple certificates and multiple versions of the same certificate can be kept in the Key Vault. Cryptographic keys in Key Vault backing the certificates are represented as [JSON Web Key [JWK]](https://tools.ietf.org/html/rfc7517) objects. This library offers operations to create, retrieve, update, delete, purge, backup, restore, and list the certificates, as well as its versions. | ||
Multiple certificates and multiple versions of the same certificate can be kept in the Key Vault. Cryptographic keys in Key Vault backing the certificates are represented as [JSON Web Key [JWK]][jwk_specification] objects. This library offers operations to create, retrieve, update, delete, purge, backup, restore, and list the certificates, as well as its versions. | ||
|
||
[Source code][source_code] | [API reference documentation][api_documentation] | [Product documentation][azkeyvault_docs] | [Samples][certificates_samples] | ||
|
||
|
@@ -22,7 +22,7 @@ Maven dependency for the Azure Key Vault Certificate client library. Add it to y | |
### Prerequisites | ||
- A [Java Development Kit (JDK)][jdk_link], version 8 or later. | ||
- [Azure Subscription][azure_subscription] | ||
- An existing [Azure Key Vault][azure_keyvault]. If you need to create a Key Vault, you can use the [Azure Cloud Shell](https://shell.azure.com/bash) to create one with this Azure CLI command. Replace `<your-resource-group-name>` and `<your-key-vault-name>` with your own, unique names: | ||
- An existing [Azure Key Vault][azure_keyvault]. If you need to create a Key Vault, you can use the [Azure Cloud Shell][azure_cloud_shell] to create one with this Azure CLI command. Replace `<your-resource-group-name>` and `<your-key-vault-name>` with your own, unique names: | ||
|
||
```Bash | ||
az keyvault create --resource-group <your-resource-group-name> --name <your-key-vault-name> | ||
|
@@ -34,9 +34,9 @@ In order to interact with the Azure Key Vault service, you'll need to create an | |
The `DefaultAzureCredential` way of authentication by providing client secret credentials is being used in this getting started section but you can find more ways to authenticate with [azure-identity][azure_identity]. | ||
#### Create/Get credentials | ||
To create/get client secret credentials you can use the [Azure Portal][azure_create_application_in_portal], [Azure CLI][azure_keyvault_cli_full] or [Azure Cloud Shell](https://shell.azure.com/bash) | ||
To create/get client secret credentials you can use the [Azure Portal][azure_create_application_in_portal], [Azure CLI][azure_keyvault_cli_full] or [Azure Cloud Shell][azure_cloud_shell] | ||
Here is an [Azure Cloud Shell](https://shell.azure.com/bash) snippet below to | ||
Here is an [Azure Cloud Shell][azure_cloud_shell] snippet below to | ||
* Create a service principal and configure its access to Azure resources: | ||
|
@@ -295,7 +295,7 @@ try { | |
``` | ||
### Default HTTP client | ||
All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the [HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). | ||
All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the [HTTP clients wiki][http_clients_wiki]. | ||
### Default SSL library | ||
All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an Uber JAR containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. | ||
|
@@ -314,7 +314,7 @@ This project welcomes contributions and suggestions. Most contributions require | |
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. | ||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the Code of Conduct FAQ or contact <[email protected]> with any additional questions or comments. | ||
This project has adopted the [Microsoft Open Source Code of Conduct][microsoft_code_of_conduct]. For more information see the Code of Conduct FAQ or contact <[email protected]> with any additional questions or comments. | ||
<!-- LINKS --> | ||
[source_code]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/keyvault/azure-security-keyvault-certificates/src | ||
|
@@ -323,7 +323,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope | |
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/identity/azure-identity | ||
[maven]: https://maven.apache.org/ | ||
[azure_subscription]: https://azure.microsoft.com/ | ||
[azure_keyvault]: https://docs.microsoft.com/azure/key-vault/quick-create-portal | ||
[azure_keyvault]: https://docs.microsoft.com/azure/key-vault/certificates/quick-create-portal | ||
[azure_cli]: https://docs.microsoft.com/cli/azure | ||
[rest_api]: https://docs.microsoft.com/rest/api/keyvault/ | ||
[azkeyvault_rest]: https://docs.microsoft.com/rest/api/keyvault/ | ||
|
@@ -334,5 +334,9 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope | |
[samples_readme]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/keyvault/azure-security-keyvault-certificates/src/samples/README.md | ||
[performance_tuning]: https://github.com/Azure/azure-sdk-for-java/wiki/Performance-Tuning | ||
[jdk_link]: https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable | ||
[azure_cloud_shell]: https://shell.azure.com/bash | ||
[jwk_specification]: https://tools.ietf.org/html/rfc7517 | ||
[http_clients_wiki]: https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients | ||
[microsoft_code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ | ||
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Fkeyvault%2Fazure-security-keyvault-certificates%2FREADME.png) |
Oops, something went wrong.