Skip to content

Commit 6ecf887

Browse files
danieljurekVSC-Service-Account
danieljurek
and
VSC-Service-Account
authored
Grouped ToC Refresh (#1214)
* Add moniker, update KV overview docs * docfx.json * CI Update Build.Reason:Manual by Robert Outlaw Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=210042&view=results * Fix breadcrumb * Refine breadcrumb * Readd storage-overview * Update storage overview links * Update KV latest index * CI Update Build.Reason:Manual by Daniel Jurek Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=210143&view=results * Use expected package paths * adjust links * Readd original breadcrumbs * Readd storage reference files * Readd storage overview to toc * Readd storage overviews * CI Update Build.Reason:Manual by Daniel Jurek Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=210440&view=results * Remove .vscode/settings.json * Readd join tocs plugin * remove unnecessary breadcrumbs * CI Update Build.Reason:Manual by Daniel Jurek Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=210527&view=results * Add moniker, update KV overview docs * docfx.json * Fix breadcrumb * Refine breadcrumb * Readd storage-overview * Update storage overview links * Update KV latest index * Use expected package paths * adjust links * hardcode moniker in link * Remove join toc plugin (re-test on master branch) * Breadcrumb * Remove extra overview sections * Update links and remove extra overview page * Force monikers in legacy storage * CI Update Build.Reason:Manual by Daniel Jurek Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=210604&view=results * Update storage overview ARM packages * Copy files correctly * fix link * Remove extra overview pages from mgmt entries * Remove KV preview * finish removing KV v4 preview moniker * CI Update Build.Reason:Manual by Daniel Jurek Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=210611&view=results * Revert "finish removing KV v4 preview moniker" This reverts commit 5d8c832. * Revert "Remove KV preview" This reverts commit daa356a. * Update storage * Add KV docs to preview moniker * Update KV preview page * Add preview moniker note * CI Update Build.Reason:Manual by Daniel Jurek Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=211136&view=results * Publish overview * KV Preview overview md path * CI Update Build.Reason:Manual by Daniel Jurek Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=211142&view=results * Use original KV docs for preview moniker * Revert KV overview * Remove KV management packages (which are not in preview) from preview * CI Update Build.Reason:Manual by Daniel Jurek Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=211151&view=results Co-authored-by: VSC-Service-Account <[email protected]>
1 parent 53b93ea commit 6ecf887

File tree

213 files changed

+38668
-5238
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

213 files changed

+38668
-5238
lines changed

‎.openpublishing.publish.config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
"azure-node-legacy",
1212
"az-js-storage-v12",
1313
"az-js-storage-v10",
14+
"az-js-keyvault-v3",
1415
"az-js-keyvault-v4",
1516
"az-js-keyvault-v4-preview",
1617
"az-js-servicebus-v7",

‎.vscode/settings.json

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎bread/toc.yml

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
- name: Docs
2+
href: /
3+
homepage: /
4+
items:
5+
- name: Azure for JavaScript & Node.js developers
6+
tocHref: /javascript/azure/
7+
topicHref: /javascript/azure/index
18
- name: Azure
29
tocHref: /javascript/api/preview-docs/
310
topicHref: /azure/index/
@@ -10,20 +17,20 @@
1017
tocHref: /javascript/api/preview-docs/overview/azure/
1118
topicHref: /azure/developer/javascript/index/
1219
items:
13-
- name: npm Packages
20+
- name: Packages
1421
tocHref: /javascript/api/preview-docs/overview/azure/
1522
topicHref: /azure/developer/javascript/azure-sdk-library-package-index
1623
items:
1724
- name: Storage SDK
1825
tocHref: /javascript/api/preview-docs/overview/azure/storage/
1926
topicHref: /javascript/api/preview-docs/overview/azure/storage/storage-overview/
2027
- name: Key Vault SDK
21-
tocHref: /javascript/api/preview-docs/overview/azure/storage/
22-
topicHref: /javascript/api/preview-docs/overview/azure/keyvault-keys-readme
28+
tocHref: /javascript/api/preview-docs/overview/azure/key-vault/
29+
topicHref: /javascript/api/preview-docs/overview/azure/key-vault/key-vault-index/
2330
- name: JavaScript
2431
tocHref: /javascript/api/preview-docs/@azure/
2532
topicHref: /azure/developer/javascript/index/
2633
items:
27-
- name: npm Packages
34+
- name: Packages
2835
tocHref: /javascript/api/preview-docs/@azure/
2936
topicHref: /azure/developer/javascript/azure-sdk-library-package-index

‎ci-configs/keyvault-latest.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@
3939
},
4040
{
4141
"tocGroup": "Key Vault SDK/Management",
42-
"overviewMDPath": "../../../docs-ref-services/latest/key-vault/key-vault-index.md",
4342
"npmPackages": [
4443
{ "name": "@azure/arm-keyvault@latest" }
4544
]

‎ci-configs/keyvault-preview.json

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
"toc_groups": [
99
{
1010
"tocGroup": "Key Vault SDK",
11-
"overviewMDPath": "../../../docs-ref-services/preview/key-vault-index.md"
11+
"overviewMDPath": "../../../docs-ref-services/preview/key-vault/key-vault-index.md"
1212
},
1313
{
1414
"tocGroup": "Key Vault SDK/Key Vault Certificates",
15-
"overviewMDPath": "../../../docs-ref-services/preview/keyvault-certificates-readme.md",
15+
"overviewMDPath": "../../../docs-ref-services/preview/key-vault/keyvault-certificates-readme.md",
1616
"npmPackages": [
1717
{
1818
"name": "@azure/keyvault-certificates@next"
@@ -21,7 +21,7 @@
2121
},
2222
{
2323
"tocGroup": "Key Vault SDK/Key Vault Admin",
24-
"overviewMDPath": "../../../docs-ref-services/preview/keyvault-admin-readme.md",
24+
"overviewMDPath": "../../../docs-ref-services/preview/key-vault/keyvault-admin-readme.md",
2525
"npmPackages": [
2626
{
2727
"name": "@azure/keyvault-admin@next"
@@ -30,7 +30,7 @@
3030
},
3131
{
3232
"tocGroup": "Key Vault SDK/Key Vault Keys",
33-
"overviewMDPath": "../../../docs-ref-services/preview/keyvault-keys-readme.md",
33+
"overviewMDPath": "../../../docs-ref-services/preview/key-vault/keyvault-keys-readme.md",
3434
"npmPackages": [
3535
{
3636
"name": "@azure/keyvault-keys@next"
@@ -39,19 +39,12 @@
3939
},
4040
{
4141
"tocGroup": "Key Vault SDK/Key Vault Secrets",
42-
"overviewMDPath": "../../../docs-ref-services/preview/keyvault-secrets-readme.md",
42+
"overviewMDPath": "../../../docs-ref-services/preview/key-vault/keyvault-secrets-readme.md",
4343
"npmPackages": [
4444
{
4545
"name": "@azure/keyvault-secrets@next"
4646
}
4747
]
48-
},
49-
{
50-
"tocGroup": "Key Vault SDK/Management",
51-
"overviewMDPath": "../../../docs-ref-services/preview/key-vault-index.md",
52-
"npmPackages": [
53-
{ "name": "@azure/arm-keyvault@latest" }
54-
]
5548
}
5649
]
5750
}

‎ci-configs/keyvault-previous.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
},
1313
{
1414
"tocGroup": "Key Vault SDK/Client",
15-
"overviewMDPath": "../../../docs-ref-services/legacy/key-vault/key-vault-index.md",
1615
"npmPackages": [
1716
{
1817
"name": "[email protected]"
@@ -21,7 +20,6 @@
2120
},
2221
{
2322
"tocGroup": "Key Vault SDK/Management",
24-
"overviewMDPath": "../../../docs-ref-services/legacy/key-vault/key-vault-index.md",
2523
"npmPackages": [
2624
{ "name": "[email protected]" }
2725
]

‎ci-configs/storage-latest.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@
4848
},
4949
{
5050
"tocGroup": "Storage SDK/Management",
51-
"overviewMDPath": "../../../docs-ref-services/latest/storage/storage-overview.md",
5251
"npmPackages": [
5352
{ "name": "@azure/arm-storage@latest" },
5453
{ "name": "@azure/arm-storagecache@latest" },

‎ci-configs/storage-previous.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@
3939
},
4040
{
4141
"tocGroup": "Storage SDK/Management",
42-
"overviewMDPath": "../../../docs-ref-services/legacy/storage/storage-overview.md",
4342
"npmPackages": [
4443
{ "name": "[email protected]" },
4544
{ "name": "[email protected]" },

‎docfx.json

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,11 @@
9999
},
100100
{
101101
"files": [
102-
"key-vault-index.md",
103-
"keyvault-keys-readme.md",
104-
"keyvault-secrets-readme.md",
105-
"keyvault-certificates-readme.md",
106-
"keyvault-admin-readme.md"
102+
"key-vault/key-vault-index.md",
103+
"key-vault/keyvault-keys-readme.md",
104+
"key-vault/keyvault-secrets-readme.md",
105+
"key-vault/keyvault-certificates-readme.md",
106+
"key-vault/keyvault-admin-readme.md"
107107
],
108108
"src": "docs-ref-services/preview",
109109
"dest": "api/preview-docs/overview/azure",
@@ -132,9 +132,9 @@
132132
"@azure/storage-file-share/**/*.yml",
133133
"@azure/storage-queue/**/*.yml",
134134
"@azure/arm-storage/**/*.yml",
135-
"arm-storagecache/**/*.yml",
136-
"arm-storageimportexport/**/*.yml",
137-
"arm-storagesync/**/*.yml"
135+
"@azure/arm-storagecache/**/*.yml",
136+
"@azure/arm-storageimportexport/**/*.yml",
137+
"@azure/arm-storagesync/**/*.yml"
138138
],
139139
"src": "latest-packages/storage/docs-ref-autogen",
140140
"dest": "api/preview-docs",
@@ -157,10 +157,8 @@
157157
},
158158
{
159159
"files": [
160-
"@azure/arm-keyvault/**/*.yml",
161-
"@azure/keyvault-certificates/**/*.yml",
162-
"@azure/keyvault-keys/**/*.yml",
163-
"@azure/keyvault-secrets/**/*.yml"
160+
"azure-arm-keyvault/**/*.yml",
161+
"azure-keyvault/**/*.yml"
164162
],
165163
"src": "previous-packages/key-vault/docs-ref-autogen",
166164
"dest": "api/preview-docs",
@@ -181,7 +179,6 @@
181179
},
182180
{
183181
"files": [
184-
"@azure/arm-keyvault/**/*.yml",
185182
"@azure/keyvault-certificates/**/*.yml",
186183
"@azure/keyvault-keys/**/*.yml",
187184
"@azure/keyvault-secrets/**/*.yml",

‎docs-ref-mapping/reference.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1100,6 +1100,7 @@
11001100
- '@azure/arm-sqlvirtualmachine'
11011101
- name: Storage
11021102
uid: azure.nodejs.sdk.landingpage.services.storage
1103+
href: ~/docs-ref-services/latest/storage-overview.md
11031104
items:
11041105
- name: Storage Blob
11051106
uid: azure.nodejs.sdk.landingPage.services.storageblob.detail
@@ -1132,7 +1133,6 @@
11321133
- azure-arm-storage
11331134
- azure-asm-storage
11341135
- azure-arm-storageimportexport
1135-
landingPageType: Service
11361136
- name: StorSimple
11371137
uid: azure.nodejs.sdk.landingpage.services.storsimple
11381138
landingPageType: Service

‎docs-ref-services/latest/bread/toc.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎docs-ref-services/latest/key-vault/key-vault-index.md

Lines changed: 16 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -12,48 +12,19 @@ ms.devlang: nodejs
1212
ms.service: key-vault
1313
---
1414

15-
# Azure Key Vault client libraries for for JavaScript
16-
17-
[Azure Key Vault](https://azure.microsoft.com/services/key-vault/) is a Microsoft-managed service providing cloud keys, secrets, and certificate storage and utility that is highly available, secure, durable, scalable, and redundant.
18-
19-
## Libraries for resource management
20-
21-
To manage your Azure Key Vault resources via the Azure Resource Manager, you would use the below package.
22-
23-
| NPM Package | Reference |
24-
| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
25-
| [@azure/arm-keyvault](https://npmjs.com/package/@azure/arm-keyvault) | [API Reference for @azure/arm-keyvault](https://docs.microsoft.com/javascript/api/@azure/arm-keyvault) |
26-
27-
## Libraries for data access
28-
29-
There are three packages to work with Key Vault keys, secrets and certificates respectively.
30-
A fourth package, `@azure/keyvault-admin` (still in preview) is also available for administrative tasks on your Key Vault instance.
31-
32-
| NPM Package | Reference | Samples |
33-
| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
34-
| [@azure/keyvault-keys](https://npmjs.com/package/@azure/keyvault-keys) | [API Reference for @azure/keyvault-keys](https://docs.microsoft.com/javascript/api/@azure/keyvault-keys) | [Samples for working with keys](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-keys/samples) |
35-
| [@azure/keyvault-secrets](https://npmjs.com/package/@azure/keyvault-secrets) | [API Reference for @azure/keyvault-secrets](https://docs.microsoft.com/javascript/api/@azure/keyvault-secrets) | [Samples for working with secrets](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-secrets/samples) |
36-
| [@azure/keyvault-certificates](https://npmjs.com/package/@azure/keyvault-certificates) | [API Reference for @azure/keyvault-certificates](https://docs.microsoft.com/javascript/api/@azure/keyvault-certificates) | [Samples for working with certificates](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-certificates/samples) |
37-
| [@azure/keyvault-admin](https://npmjs.com/package/@azure/keyvault-admin) (in Preview) | [API Reference for @azure/keyvault-admin](https://docs.microsoft.com/javascript/api/@azure/keyvault-admin) | [Samples for administrative tasks](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-admin/samples) |
38-
39-
These packages have the below features:
40-
41-
- Key Vault Keys
42-
- Create keys using elliptic curve or RSA encryption, optionally backed by Hardware Security Modules (HSM).
43-
- Import, delete and update keys.
44-
- Get one or more keys and deleted keys.
45-
- Recover a deleted key and restore a backed up key.
46-
- Get the versions and the attributes of a key.
47-
- Encrypting, decrypting, signing, verifying, wrapping and unwrapping data with keys.
48-
- Key Vault Secrets
49-
- Get, set and delete a secret.
50-
- Update a secret and it's attributes.
51-
- Backup and restore a secret.
52-
- Get, purge or recover a deleted secret.
53-
- Get all the versions of a secret, or secrets, or deleted secrets.
54-
- Key Vault Certificates
55-
- Get, set and delete a certificate.
56-
- Update a certificate, its attributes, issuer, policy, operation and contacts.
57-
- Backup and restore a certificate.
58-
- Get, purge or recover a deleted certificate.
59-
- Get all the versions of a certificate, or certificates, or deleted certificates.
15+
## Azure Key Vault SDK for JavaScript - latest
16+
17+
## Client packages (4.x.x) - latest
18+
19+
| Reference | Package | Source |
20+
|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
21+
| [Key Vault Certificates](/javascript/api/preview-docs/overview/azure/key-vault/keyvault-certificates-readme?view=az-js-keyvault-v4) | [@azure/keyvault-certificates@4.1.0](https://www.npmjs.com/package/@azure/keyvault-certificates) | [GitHub](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-certificates) |
22+
| [Key Vault Keys](/javascript/api/preview-docs/overview/azure/key-vault/keyvault-keys-readme?view=az-js-keyvault-v4) | [@azure/keyvault-keys@4.1.0](https://www.npmjs.com/package/@azure/keyvault-keys) | [GitHub](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-keys) |
23+
| [Key Vault Secrets](/javascript/api/preview-docs/overview/azure/key-vault/keyvault-secrets-readme?view=az-js-keyvault-v4) | [@azure/keyvault-secrets@4.1.0](https://www.npmjs.com/package/@azure/keyvault-secrets) | [GitHub](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-secrets) |
24+
| | | |
25+
## Management packages - latest
26+
27+
| Reference | Package | Source |
28+
|------------------------------------------------------------------------------|--------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
29+
| [ARM Key Vault](/javascript/api/preview-docs/@azure/arm-keyvault?view=az-js-keyvault-v4) | [@azure/arm-keyvault@1.2.1](https://www.npmjs.com/package/@azure/arm-keyvault) | [GitHub](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/arm-keyvault) |
30+
| | | |

0 commit comments

Comments
 (0)