|
1 | 1 | # Azure Key Vault Certificates client library for Go
|
2 |
| -Azure Key Vault helps solve the following problems: |
3 |
| -- Certificate management (this library) - create, manage, and deploy public and private SSL/TLS certificates |
4 |
| -- Cryptographic key management |
5 |
| -([azkeys](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/keyvault/azkeys)) - create, store, and control access to the keys used to encrypt your data |
6 |
| -- Secrets management |
7 |
| -([azsecrets](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/keyvault/azsecrets)) - |
8 |
| -securely store and control access to tokens, passwords, certificates, API keys, |
9 |
| -and other secrets |
10 | 2 |
|
11 |
| -[Source code][certificates_client_src] | [pkg.go.dev][pkggodev_azcerts] | [API reference documentation][reference_docs] | [Product documentation][keyvault_docs] | [Samples][certificates_samples] |
| 3 | +* Certificate management (this library) - create, manage, and deploy public and private SSL/TLS certificates |
| 4 | +* Cryptographic key management (([azkeys](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys))) - create, store, and control access to the keys used to encrypt your data |
| 5 | +* Secrets management ([azsecrets](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecrets)) - securely store and control access to tokens, passwords, certificates, API keys, and other secrets |
| 6 | + |
| 7 | +[Source code][certificates_client_src] | [Package (pkg.go.dev)][reference_docs] | [Product documentation][keyvault_docs] | [Samples][certificates_samples] |
12 | 8 |
|
13 | 9 | ## Getting started
|
14 | 10 | ### Install the package
|
@@ -146,7 +142,7 @@ This section contains code snippets covering common tasks:
|
146 | 142 | * [List Properties of Certificates](#list-properties-of-certificates "List Properties of Certificates")
|
147 | 143 |
|
148 | 144 | ### Create a Certificate
|
149 |
| -[BeginCreateCertificate](https://aka.ms/azsdk/go/azcertificates) |
| 145 | +[BeginCreateCertificate](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates#Client.BeginCreateCertificate) |
150 | 146 | creates a certificate to be stored in the Azure Key Vault. If a certificate with the same name already exists, a new
|
151 | 147 | version of the certificate is created. Before creating a certificate, a management policy for the certificate can be
|
152 | 148 | created or our default policy will be used. This method returns a long running operation poller.
|
@@ -188,11 +184,11 @@ func main() {
|
188 | 184 | }
|
189 | 185 | ```
|
190 | 186 | If you would like to check the status of your certificate creation, you can call `Poll(ctx context.Context)` on the poller or
|
191 |
| -[GetCertificateOperation](https://aka.ms/azsdk/go/azcertificates) |
| 187 | +[GetCertificateOperation](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates#Client.GetCertificateOperation) |
192 | 188 | with the name of the certificate.
|
193 | 189 |
|
194 | 190 | ### Retrieve a Certificate
|
195 |
| -[GetCertificate](https://aka.ms/azsdk/go/azcertificates) |
| 191 | +[GetCertificate](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates#Client.GetCertificate) |
196 | 192 | retrieves the latest version of a certificate previously stored in the Key Vault.
|
197 | 193 | ```go
|
198 | 194 | import (
|
@@ -236,7 +232,7 @@ func main_GetCertificate() {
|
236 | 232 |
|
237 | 233 |
|
238 | 234 | ### Update properties of an existing Certificate
|
239 |
| -[UpdateCertificateProperties](https://aka.ms/azsdk/go/azcertificates) |
| 235 | +[UpdateCertificateProperties](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates#Client.UpdateCertificateProperties) |
240 | 236 | updates a certificate previously stored in the Key Vault.
|
241 | 237 | ```go
|
242 | 238 | import (
|
@@ -288,7 +284,7 @@ func main() {
|
288 | 284 | ```
|
289 | 285 |
|
290 | 286 | ### Delete a Certificate
|
291 |
| -[BeginDeleteCertificate](https://aka.ms/azsdk/go/azcertificates) |
| 287 | +[BeginDeleteCertificate](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates#Client.BeginDeleteCertificate) |
292 | 288 | requests Key Vault delete a certificate, returning a poller which allows you to wait for the deletion to finish.
|
293 | 289 | Waiting is helpful when the vault has [soft-delete][soft_delete] enabled, and you want to purge
|
294 | 290 | (permanently delete) the certificate as soon as possible. When [soft-delete][soft_delete] is disabled,
|
@@ -337,7 +333,7 @@ func main() {
|
337 | 333 | ```
|
338 | 334 |
|
339 | 335 | ### List Certificates
|
340 |
| -[ListCertificates](https://aka.ms/azsdk/go/azcertificates) |
| 336 | +[ListCertificates](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates#Client.ListCertificates) |
341 | 337 | lists the properties of all certificates in the specified Key Vault.
|
342 | 338 | ```go
|
343 | 339 | import (
|
@@ -453,8 +449,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
|
453 | 449 | [pkggodev_azcerts]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates
|
454 | 450 | [certificate_client_docs]: https://aka.ms/azsdk/go/azcertificates
|
455 | 451 | [rbac_guide]: https://docs.microsoft.com/azure/key-vault/general/rbac-guide
|
456 |
| -[reference_docs]: https://aka.ms/azsdk/go/azcertificates |
457 |
| -[certificates_client_src]: https://aka.ms/azsdk/go/azcertificates |
| 452 | +[reference_docs]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates |
| 453 | +[certificates_client_src]: https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/keyvault/azcertificates |
458 | 454 | [certificates_samples]: https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/keyvault/azcertificates/example_test.go
|
459 | 455 | [soft_delete]: https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview
|
460 | 456 |
|
|
0 commit comments