Updates to readme files (#3220)
* links updates * PR comments * readme updates * oops * update source section
This commit is contained in:
George Arama
GitHub
parent
203028a180
commit
4239100f3b
@ -227,6 +227,9 @@ The following SDK library releases are available on [vcpkg](https://github.com/m
|
||||
* `azure-storage-blobs-cpp`
|
||||
* `azure-storage-files-datalake-cpp`
|
||||
* `azure-storage-files-shares-cpp`
|
||||
* `azure-security-keyvault-keys-cpp`
|
||||
* `azure-security-keyvault-secrets-cpp`
|
||||
* `azure-security-keyvault-certificates-cpp`
|
||||
|
||||
> NOTE: In case of getting linker errors when consuming the SDK on Windows, make sure that [vcpkg triplet](https://vcpkg.readthedocs.io/en/latest/users/triplets/) being consumed matches the [CRT link flags](https://docs.microsoft.com/cpp/build/reference/md-mt-ld-use-run-time-library?view=msvc-160) being set for your app or library build. See also `MSVC_USE_STATIC_CRT` build flag.
|
||||
|
||||
|
||||
@ -129,7 +129,7 @@ For details on contributing to this repository, see the [contributing guide][azu
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
||||
the rights to use your contribution. For details, visit https://cla.microsoft.com.
|
||||
the rights to use your contribution. For details, visit the [Contributor License Agreement](https://cla.microsoft.com).
|
||||
|
||||
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
|
||||
|
||||
@ -90,7 +90,7 @@ For details on contributing to this repository, see the [contributing guide][azu
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
||||
the rights to use your contribution. For details, visit https://cla.microsoft.com.
|
||||
the rights to use your contribution. For details, visit the [Contributor License Agreement](https://cla.microsoft.com).
|
||||
|
||||
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
|
||||
|
||||
@ -6,7 +6,6 @@ The Azure Key Vault certificates client library enables programmatically managin
|
||||
|
||||
[Source code][certificate_client_src] | [API reference documentation][api_reference] | [Product documentation][keyvault_docs]
|
||||
|
||||
|
||||
## Getting started
|
||||
|
||||
### Install the package
|
||||
@ -277,14 +276,14 @@ You will notice that additional information is logged, like the client request I
|
||||
|
||||
Several Azure Key Vault secrets client library samples are available to you in this GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Azure Key Vault:
|
||||
|
||||
* Certificate-Basic-Operations:
|
||||
* [Certificate-Basic-Operations](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-certificates/samples/certificate_basic_operations.md):
|
||||
* create a certificate
|
||||
* get a certificate
|
||||
* update a certificate
|
||||
* delete a certificate
|
||||
* purge a certificate
|
||||
|
||||
* Certificates-Get-Certificates:
|
||||
* [Certificates-Get-Certificates](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-certificates/samples/certificate_get_certificates.md):
|
||||
* create certificates
|
||||
* get properties of certificates
|
||||
* get properties of certificate versions
|
||||
@ -292,7 +291,7 @@ Several Azure Key Vault secrets client library samples are available to you in t
|
||||
* get deleted certificates
|
||||
* purge a certificate
|
||||
|
||||
* Certificates-Import-Certificate:
|
||||
* [Certificates-Import-Certificate](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-certificates/samples/certificate_import_certificate.md):
|
||||
* Import a PEM certificate
|
||||
* import a PKCS certificate
|
||||
|
||||
@ -301,7 +300,7 @@ For details on contributing to this repository, see the [contributing guide][azu
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
||||
the rights to use your contribution. For details, visit https://cla.microsoft.com.
|
||||
the rights to use your contribution. For details, visit the [Contributor License Agreement](https://cla.microsoft.com).
|
||||
|
||||
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
|
||||
|
||||
@ -91,3 +91,7 @@ If the Azure Key Vault is soft delete-enabled and you want to permanently delete
|
||||
auto result = response.PollUntilDone(defaultWait);
|
||||
certificateClient.PurgeDeletedCertificate(certificateName);
|
||||
```
|
||||
## Source
|
||||
|
||||
To see the full example source, see:
|
||||
[Source Code](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/keyvault/azure-security-keyvault-certificates/test/samples/certificate-basic-operations)
|
||||
|
||||
@ -132,3 +132,7 @@ If the Azure Key Vault is soft delete-enabled and you want to permanently delete
|
||||
certificateClient.PurgeDeletedCertificate(certificateName2);
|
||||
}
|
||||
```
|
||||
## Source
|
||||
|
||||
To see the full example source, see:
|
||||
[Source Code](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/keyvault/azure-security-keyvault-certificates/test/samples/certificate-get-certificates)
|
||||
|
||||
@ -92,3 +92,7 @@ response2.PollUntilDone(defaultWait);
|
||||
certificateClient.PurgeDeletedCertificate(pkcsName);
|
||||
certificateClient.PurgeDeletedCertificate(pemName);
|
||||
```
|
||||
## Source
|
||||
|
||||
To see the full example source, see:
|
||||
[Source Code](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/keyvault/azure-security-keyvault-certificates/test/samples/certificate-import-certificate)
|
||||
|
||||
@ -217,10 +217,10 @@ The following section provides several code snippets using the `client` [created
|
||||
- [Update an existing key](#update-an-existing-key)
|
||||
- [Delete a key](#delete-a-key)
|
||||
- [Delete and purge a key](#delete-and-purge-a-key)
|
||||
- [List keys](#list-keys)
|
||||
- [List Keys](#list-keys)
|
||||
<!-- - [Encrypt and Decrypt](#encrypt-and-decrypt) -->
|
||||
|
||||
### Create a key
|
||||
#### Create a key
|
||||
|
||||
Create a key to be stored in the Azure Key Vault. If a key with the same name already exists, then a new version of the key is created.
|
||||
|
||||
@ -249,7 +249,7 @@ std::cout << ecKey.Name();
|
||||
std::cout << ecKey.KeyType.ToString();
|
||||
```
|
||||
|
||||
### Retrieve a key
|
||||
#### Retrieve a key
|
||||
|
||||
`GetKey` retrieves a key previously stored in the Azure Key Vault.
|
||||
|
||||
@ -260,7 +260,7 @@ std::cout << key.Name();
|
||||
std::cout << key.KeyType.ToString();
|
||||
```
|
||||
|
||||
### Update an existing key
|
||||
#### Update an existing key
|
||||
|
||||
`UpdateKeyProperties` updates a key previously stored in the Azure Key Vault.
|
||||
|
||||
@ -277,11 +277,11 @@ std::cout << updatedKey.Properties.Version;
|
||||
std::cout << updatedKey.Properties.UpdatedOn->ToString();
|
||||
```
|
||||
|
||||
### Delete a key
|
||||
#### Delete a key
|
||||
|
||||
`StartDeleteKey` starts a long-running operation to delete a key previously stored in the Azure Key Vault.
|
||||
You can retrieve the key immediately without waiting for the operation to complete.
|
||||
When [soft-delete][soft_delete] is not enabled for the Azure Key Vault, this operation permanently deletes the key.
|
||||
When [soft-delete](https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview) is not enabled for the Azure Key Vault, this operation permanently deletes the key.
|
||||
|
||||
```cpp
|
||||
DeleteKeyOperation operation = client.StartDeleteKey("key-name");
|
||||
@ -291,7 +291,7 @@ std::cout << key.Name();
|
||||
std::cout << key.DeletedOn->ToString();
|
||||
```
|
||||
|
||||
### Delete and purge a key
|
||||
#### Delete and purge a key
|
||||
|
||||
You will need to wait for the long-running operation to complete before trying to purge or recover the key.
|
||||
|
||||
@ -310,7 +310,7 @@ DeletedKey key = operation.Value();
|
||||
client.PurgeDeletedKey(key.Name());
|
||||
```
|
||||
|
||||
### List Keys
|
||||
#### List Keys
|
||||
|
||||
This example lists all the keys in the specified Azure Key Vault.
|
||||
|
||||
@ -326,20 +326,6 @@ for (auto keys = client.GetPropertiesOfKeys(); keys.HasPage(); keys.MoveToNextPa
|
||||
}
|
||||
```
|
||||
|
||||
<!-- ### Encrypt and Decrypt
|
||||
|
||||
This example creates a `CryptographyClient` and uses it to encrypt and decrypt with a key in Azure Key Vault.
|
||||
|
||||
```cpp
|
||||
byte[] plaintext = Encoding.UTF8.GetBytes("A single block of plaintext");
|
||||
|
||||
// encrypt the data using the algorithm RSAOAEP
|
||||
EncryptResult encryptResult = cryptoClient.Encrypt(EncryptionAlgorithm.RsaOaep, plaintext);
|
||||
|
||||
// decrypt the encrypted data.
|
||||
DecryptResult decryptResult = cryptoClient.Decrypt(EncryptionAlgorithm.RsaOaep, encryptResult.Ciphertext);
|
||||
``` -->
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### General
|
||||
@ -433,7 +419,7 @@ Several Azure Key Vault keys client library samples are available to you in this
|
||||
See the [CONTRIBUTING.md][contributing] for details on building, testing, and contributing to these libraries.
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA)
|
||||
declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
|
||||
declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit the [Contributor License Agreement](https://cla.microsoft.com).
|
||||
|
||||
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.
|
||||
|
||||
@ -4,6 +4,8 @@ Azure Security Keyvault Secrets Package client library for C++ (`azure-security-
|
||||
|
||||
The library allows client libraries to expose common functionality in a consistent fashion. Once you learn how to use these APIs in one client library, you will know how to use them in other client libraries.
|
||||
|
||||
[Source code][secrets_client_src] | [API reference documentation][api_reference] | [Product documentation][keyvault_docs]
|
||||
|
||||
## Getting started
|
||||
|
||||
### Install the package
|
||||
@ -157,21 +159,21 @@ You will notice that additional information is logged, like the client request I
|
||||
|
||||
Several Azure Key Vault secrets client library samples are available to you in this GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Azure Key Vault:
|
||||
|
||||
* Sample1-Basic-Operations:
|
||||
* [Sample1-Basic-Operations](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-secrets/samples/sample1_basic_operations.md):
|
||||
* Create a secret
|
||||
* Get a secret
|
||||
* Update a secret
|
||||
* Delete and Purge a secret
|
||||
|
||||
* Sample2-Backup-Restore:
|
||||
* [Sample2-Backup-Restore](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-secrets/samples/sample2_backup_restore.md):
|
||||
* Backup a secret
|
||||
* Restore a deleted secret
|
||||
|
||||
* Sample3-Delete-Recover:
|
||||
* [Sample3-Delete-Recover](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-secrets/samples/sample3_delete_recover.md):
|
||||
* Delete a secret
|
||||
* Recover a deleted Secret
|
||||
|
||||
* Sample4-Get-Secrets-Deleted:
|
||||
* [Sample4-Get-Secrets-Deleted](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-secrets/samples/sample4_get_secrets_deleted.md):
|
||||
* List all secrets
|
||||
* List all of a secrets versions
|
||||
* List all deletes secrets
|
||||
@ -182,7 +184,7 @@ For details on contributing to this repository, see the [contributing guide][azu
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
||||
the rights to use your contribution. For details, visit https://cla.microsoft.com.
|
||||
the rights to use your contribution. For details, visit the [Contributor License Agreement](https://cla.microsoft.com).
|
||||
|
||||
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
|
||||
@ -215,3 +217,6 @@ Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk
|
||||
[azure_sdk_for_cpp_contributing_pull_requests]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#pull-requests
|
||||
[azure_cli]: https://docs.microsoft.com/cli/azure
|
||||
[azure_sub]: https://azure.microsoft.com/free/
|
||||
[api_reference]: https://azure.github.io/azure-sdk-for-cpp/keyvault.html
|
||||
[secrets_client_src]: https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/keyvault/azure-security-keyvault-secrets
|
||||
[keyvault_docs]: https://docs.microsoft.com/azure/key-vault/
|
||||
@ -84,4 +84,5 @@ secretClient.PurgeDeletedSecret(secret.Name);
|
||||
|
||||
## Source
|
||||
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/identity/azure-identity/README.md
|
||||
To see the full example source, see:
|
||||
[Source Code](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/keyvault/azure-security-keyvault-secrets/test/samples/sample1-basic-operations)
|
||||
|
||||
@ -88,5 +88,7 @@ auto restoredSecret = secretClient.RestoreSecretBackup(backedUpSecret).Value;
|
||||
```
|
||||
|
||||
## Source
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/identity/azure-identity/README.md
|
||||
|
||||
To see the full example source, see:
|
||||
[Source Code](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/keyvault/azure-security-keyvault-secrets/test/samples/sample2-backup-restore)
|
||||
|
||||
|
||||
@ -68,4 +68,6 @@ Secret restoredSecret = recoverOperation.PollUntilDone(2s).Value;
|
||||
|
||||
## Source
|
||||
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/identity/azure-identity/README.md
|
||||
To see the full example source, see:
|
||||
[Source Code](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/keyvault/azure-security-keyvault-secrets/test/samples/sample3-delete-recover)
|
||||
|
||||
|
||||
@ -122,4 +122,5 @@ secretClient.PurgeDeletedSecret(secret2.Name);
|
||||
```
|
||||
## Source
|
||||
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/identity/azure-identity/README.md
|
||||
To see the full example source, see:
|
||||
[Source Code](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/keyvault/azure-security-keyvault-secrets/test/samples/sample4-get-secrets-deleted)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user