KeyVault Certificates adding README and samples #7629
Merged
Conversation
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
heaths
approved these changes
Sep 16, 2019
| Thread.Sleep(newCertOp.PollingInterval); | ||
| } | ||
|
|
||
| // The certificate is no longer needed, need to delete it from the Key Vault. |
| public partial class GetCertificates | ||
| { | ||
| [Test] | ||
| public async Task GetKeysAsync() |
| # Azure Key Vault Certificate client library for .NET | ||
| Azure Key Vault is a cloud service that provides secure storage and automated management of certificates used throughout a cloud application. Multiple certificate, and multiple versions of the same certificate, can be kept in the Key Vault. Each certificate in the vault has a policy associated with it which controls the issuance and lifetime of the certificate, along with actions to be taken as certificates near expiry. | ||
|
|
||
| The Azure Key Vault Certificate client library enables programmatically managing certificates, offering methods to create, update, list and delete certificates, policies, issuers and contacts. The library also supports managing pending certificate operations, and management of deleted certificates. |
There was a problem hiding this comment.
Nit: I recommend the Oxford comma everywhere for readability. It helps separate clauses, which is especially important with complex list statements such as this.
| az keyvault show --name <your-key-vault-name> | ||
| ``` | ||
|
|
||
| #### Create KeyClient |
| ### Create a Certificate | ||
| `StartCreateCertificate` creates a Certificate to be stored in the Azure Key Vault. If a certificate with | ||
| the same name already exists, then a new version of the certificate is created. | ||
| When creating the certificate the user can specify the policy which controls the certificate lifetime. If no policy is speicired the default policy will be used. The `StartCreateCertificate` operation returns a `CertificateOperation`. The following example creates a self signed certificate with the default policy. |
| ``` | ||
|
|
||
| ### Delete a Certificate | ||
| `delete_certificate` deletes all versions of a certificate stored in the Key Vault. When [soft-delete][soft_delete] |
| ## Troubleshooting | ||
|
|
||
| ### General | ||
| When you interact with the Azure Key Vault Key client library using the .NET SDK, errors returned by the service correspond to the same HTTP status codes returned for [REST API][keyvault_rest] requests. |
| ### General | ||
| When you interact with the Azure Key Vault Key client library using the .NET SDK, errors returned by the service correspond to the same HTTP status codes returned for [REST API][keyvault_rest] requests. | ||
|
|
||
| For example, if you try to retrieve a Key that doesn't exist in your Key Vault, a `404` error is returned, indicating `Not Found`. |
There was a problem hiding this comment.
"Certificate". I'll not repeat this comment (may be more). I'm seeing a lot of (copy and paste?) references to Key Client and Keys.
| ``` | ||
| ## Next steps | ||
| Key Vault Certificates client library samples are available to you in this GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Key Vault: | ||
| * [HelloWorld.cs][hello_world_sync] and [HelloWorldAsync.cs][hello_world_async] - for working with Azure Key Vault, including: |
There was a problem hiding this comment.
These links aren't defined below.
|
/azp run net - keyvault - ci Rerunning pipeline due to issue #7604 |
|
No pipelines are associated with this pull request. |
|
/azp run net - keyvault - ci |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.