Skip to content

Commit d348005

Browse files
[KeyVault] adding KeyVault intro section to all readmes (#17379)
* updating keyvault keys readme * secrets readme updated * updating certificates readme * updating imports * removing empty assignment * Update sdk/keyvault/azsecrets/README.md Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com> * changing function names * adding KeyVault intro section to all readmes * adding links to pkg.go.dev * Update sdk/keyvault/azcertificates/README.md Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com> Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com>
1 parent 9f26008 commit d348005

File tree

3 files changed

+39
-37
lines changed

3 files changed

+39
-37
lines changed

sdk/keyvault/azcertificates/README.md

+13-17
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
# 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
102

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]
128

139
## Getting started
1410
### Install the package
@@ -146,7 +142,7 @@ This section contains code snippets covering common tasks:
146142
* [List Properties of Certificates](#list-properties-of-certificates "List Properties of Certificates")
147143

148144
### 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)
150146
creates a certificate to be stored in the Azure Key Vault. If a certificate with the same name already exists, a new
151147
version of the certificate is created. Before creating a certificate, a management policy for the certificate can be
152148
created or our default policy will be used. This method returns a long running operation poller.
@@ -188,11 +184,11 @@ func main() {
188184
}
189185
```
190186
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)
192188
with the name of the certificate.
193189

194190
### 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)
196192
retrieves the latest version of a certificate previously stored in the Key Vault.
197193
```go
198194
import (
@@ -236,7 +232,7 @@ func main_GetCertificate() {
236232

237233

238234
### 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)
240236
updates a certificate previously stored in the Key Vault.
241237
```go
242238
import (
@@ -288,7 +284,7 @@ func main() {
288284
```
289285

290286
### 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)
292288
requests Key Vault delete a certificate, returning a poller which allows you to wait for the deletion to finish.
293289
Waiting is helpful when the vault has [soft-delete][soft_delete] enabled, and you want to purge
294290
(permanently delete) the certificate as soon as possible. When [soft-delete][soft_delete] is disabled,
@@ -337,7 +333,7 @@ func main() {
337333
```
338334

339335
### 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)
341337
lists the properties of all certificates in the specified Key Vault.
342338
```go
343339
import (
@@ -453,8 +449,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
453449
[pkggodev_azcerts]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates
454450
[certificate_client_docs]: https://aka.ms/azsdk/go/azcertificates
455451
[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
458454
[certificates_samples]: https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/keyvault/azcertificates/example_test.go
459455
[soft_delete]: https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview
460456

sdk/keyvault/azkeys/README.md

+15-14
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Azure Key Vault Keys client library for Go
2-
Azure Key Vault helps solve the following problems:
3-
- Cryptographic key management (this library) - create, store, and control
4-
access to the keys used to encrypt your data
52

6-
[Source code][key_client_src] | [Package (pkg.go.dev)][goget_azkeys] | [API reference documentation][reference_docs] | [Product documentation][keyvault_docs]
3+
* Cryptographic key management (this library) - create, store, and control access to the keys used to encrypt your data
4+
* 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
5+
* Certificate management ([azcertificates](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates)) - create, manage, and deploy public and private SSL/TLS certificates
6+
[Source code][key_client_src] | [Package (pkg.go.dev)][goget_azkeys] | [Product documentation][keyvault_docs] | [Samples][keys_samples]
77

88
## Getting started
99
### Install packages
@@ -141,8 +141,8 @@ This section contains code snippets covering common tasks:
141141
<!-- * [Perform cryptographic operations](#cryptographic-operations) -->
142142

143143
### Create a key
144-
[`CreateRSAKey`](https://aka.ms/azsdk/go/keyvault-keys) and
145-
[`CreateECKey`](https://aka.ms/azsdk/go/keyvault-keys) create RSA and elliptic curve keys in the vault, respectively. If a key with the same name already exists, a new version of that key is created.
144+
[`CreateRSAKey`](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys#Client.CreateRSAKey) and
145+
[`CreateECKey`](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys#Client.CreateECKey) create RSA and elliptic curve keys in the vault, respectively. If a key with the same name already exists, a new version of that key is created.
146146

147147
```go
148148
import (
@@ -183,7 +183,7 @@ func main() {
183183
```
184184

185185
### Retrieve a key
186-
[`GetKey`](https://aka.ms/azsdk/go/keyvault-keys) retrieves a key previously stored in the Vault.
186+
[`GetKey`](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys#Client.GetKey) retrieves a key previously stored in the Vault.
187187
```go
188188
import (
189189
"fmt"
@@ -213,7 +213,7 @@ func main() {
213213
```
214214

215215
### Update an existing key
216-
[`UpdateKeyProperties`](https://aka.ms/azsdk/go/keyvault-keys)
216+
[`UpdateKeyProperties`](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys#Client.UpdateKeyProperties)
217217
updates the properties of a key previously stored in the Key Vault.
218218
```go
219219
import (
@@ -249,7 +249,7 @@ func main() {
249249
```
250250

251251
### Delete a key
252-
[`BeginDeleteKey`](https://aka.ms/azsdk/go/keyvault-keys) requests Key Vault delete a key, returning a poller which allows you to wait for the deletion to finish. Waiting is helpful when the vault has [soft-delete][soft_delete] enabled, and you want to purge (permanently delete) the key as soon as possible. When [soft-delete][soft_delete] is disabled, `BeginDeleteKey` itself is permanent.
252+
[`BeginDeleteKey`](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys#Client.BeginDeleteKey) requests Key Vault delete a key, returning a poller which allows you to wait for the deletion to finish. Waiting is helpful when the vault has [soft-delete][soft_delete] enabled, and you want to purge (permanently delete) the key as soon as possible. When [soft-delete][soft_delete] is disabled, `BeginDeleteKey` itself is permanent.
253253

254254
```go
255255
import (
@@ -333,7 +333,7 @@ func main() {
333333
```
334334

335335
### List keys
336-
[`ListKeys`](https://aka.ms/azsdk/go/keyvault-keys) lists the properties of all of the keys in the client's vault.
336+
[`ListKeys`](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys#Client.ListKeys) lists the properties of all of the keys in the client's vault.
337337

338338
```go
339339
import (
@@ -372,7 +372,7 @@ func main() {
372372
```
373373

374374
### Cryptographic operations
375-
[CryptographyClient](https://aka.ms/azsdk/go/keyvault-keys)
375+
[CryptographyClient](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys/crypto#Client)
376376
enables cryptographic operations (encrypt/decrypt, wrap/unwrap, sign/verify) using a particular key.
377377

378378
```go
@@ -498,11 +498,12 @@ contact opencode@microsoft.com with any additional questions or comments.
498498
[keyvault_docs]: https://docs.microsoft.com/azure/key-vault/
499499
[goget_azkeys]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys
500500
[rbac_guide]: https://docs.microsoft.com/azure/key-vault/general/rbac-guide
501-
[reference_docs]: https://aka.ms/azsdk/go/keyvault-keys
502-
[key_client_docs]: https://aka.ms/azsdk/go/keyvault-keys#Client
503-
[crypto_client_docs]: https://aka.ms/azsdk/go/keyvault-keys/crypto/docs
501+
[reference_docs]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys
502+
[key_client_docs]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys#Client
503+
[crypto_client_docs]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys/crypto#Client
504504
[key_client_src]: https://github.com/Azure/azure-sdk-for-go/tree/fd86ba6a0ece5a0658dd16f8d3d564493369a8a2/sdk/keyvault/azkeys/client.go
505505
[key_samples]: https://github.com/Azure/azure-sdk-for-go/tree/fd86ba6a0ece5a0658dd16f8d3d564493369a8a2/sdk/keyvault/azkeys/example_test.go
506506
[soft_delete]: https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview
507+
[keys_samples]: https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/keyvault/azkeys/example_test.go
507508

508509
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-go%2Fsdk%2Fkeyvault%2Fazkeys%2FREADME.png)

sdk/keyvault/azsecrets/README.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# Azure Key Vault Secrets client library for Go
2+
Azure Key Vault helps solve the following problems:
3+
* Secrets management (this library) - securely store and control access to tokens, passwords, certificates, API keys, and other secrets
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+
* Certificate management ([azcertificates](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates)) - create, manage, and deploy public and private SSL/TLS certificates
26
Azure Key Vault helps securely store and control access to tokens, passwords, certificates, API keys, and other secrets.
37

4-
[Source code][secret_client_src] | [API reference documentation][reference_docs] | [Product documentation][keyvault_docs]
8+
[Source code][secret_client_src] | [Package (pkg.go.dev)][reference_docs] | [Product documentation][keyvault_docs] | [Samples][secrets_samples]
59

610
## Getting started
711

@@ -143,7 +147,7 @@ This section contains code snippets covering common tasks:
143147
* [List Secrets](#list-secrets "List Secrets")
144148

145149
### Set a Secret
146-
[SetSecret](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecrets@v0.1.1#Client.SetSecret) creates new secrets and changes the values of existing secrets. If no secret with the given name exists, `SetSecret` creates a new secret with that name and the given value. If the given name is in use, `SetSecret` creates a new version of that secret, with the given value.
150+
[SetSecret](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecrets#Client.SetSecret) creates new secrets and changes the values of existing secrets. If no secret with the given name exists, `SetSecret` creates a new secret with that name and the given value. If the given name is in use, `SetSecret` creates a new version of that secret, with the given value.
147151

148152
```golang
149153
import (
@@ -180,7 +184,7 @@ func main() {
180184
```
181185

182186
### Retrieve a Secret
183-
[GetSecret](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecrets@v0.1.1#Client.GetSecret) retrieves a secret previously stored in the Key Vault.
187+
[GetSecret](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecrets#Client.GetSecret) retrieves a secret previously stored in the Key Vault.
184188

185189
```golang
186190
import (
@@ -258,7 +262,7 @@ func main() {
258262
```
259263

260264
### Delete a Secret
261-
[BeginDeleteSecret](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecrets@v0.1.1#Client.BeginDeleteSecret) requests Key Vault delete a secret, returning a poller which allows you to wait for the deletion to finish. Waiting is helpful when the vault has [soft-delete][soft_delete] enabled, and you want to purge (permanently delete) the secret as soon as possible. When [soft-delete][soft_delete] is disabled, `BeginDeleteSecret` itself is permanent.
265+
[BeginDeleteSecret](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecrets#Client.BeginDeleteSecret) requests Key Vault delete a secret, returning a poller which allows you to wait for the deletion to finish. Waiting is helpful when the vault has [soft-delete][soft_delete] enabled, and you want to purge (permanently delete) the secret as soon as possible. When [soft-delete][soft_delete] is disabled, `BeginDeleteSecret` itself is permanent.
262266

263267
```golang
264268
import (
@@ -295,7 +299,7 @@ func main() {
295299
```
296300

297301
### List secrets
298-
[ListSecrets](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecrets@v0.1.1#Client.ListSecrets) lists the properties of all of the secrets in the client's vault. This list doesn't include the secret's values.
302+
[ListSecrets](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecrets#Client.ListSecrets) lists the properties of all of the secrets in the client's vault. This list doesn't include the secret's values.
299303

300304
```golang
301305
import (
@@ -405,8 +409,9 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
405409
[keyvault_docs]: https://docs.microsoft.com/azure/key-vault/
406410
[rbac_guide]: https://docs.microsoft.com/azure/key-vault/general/rbac-guide
407411
[reference_docs]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecrets
408-
[secret_client_docs]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecrets@v0.1.1#Client
412+
[secret_client_docs]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecrets#Client
409413
[secret_client_src]: https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/keyvault/azsecrets/client.go
410414
[soft_delete]: https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview
415+
[secrets_samples]: https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/keyvault/azsecrets/example_test.go
411416

412417
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-go%2Fsdk%2Fkeyvault%2Fazsecrets%2FREADME.png)

0 commit comments

Comments
 (0)