Skip to content

Commit 139774f

Browse files
authored
[KeyVault] - Address KeyVault feedback (Azure#13524)
## What - Hide various parse identifier methods - Make additionalAuthenticatedData readonly ## Why These came out of the recent KV architecture review.
1 parent 41c0645 commit 139774f

File tree

14 files changed

+13
-20
lines changed

14 files changed

+13
-20
lines changed

sdk/keyvault/keyvault-certificates/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- [Breaking] Removed `dist-browser` from the published package. To bundle the Azure SDK libraries for the browsers, please read our bundling guide: [link](https://github.com/Azure/azure-sdk-for-js/blob/master/documentation/Bundling.md).
66
- Updated the Key Vault Certificates Long Running Operation Pollers to follow a more compact and meaningful approach moving forward.
77
- Bug fix: The logging of HTTP requests wasn't properly working - now it has been fixed and tests have been written that verify the fix.
8+
- Removed `parseKeyVaultCertificatesIdentifier` from the public API.
89

910
## 4.2.0-beta.1 (2020-09-11)
1011

sdk/keyvault/keyvault-certificates/review/keyvault-certificates.api.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -421,9 +421,6 @@ export const logger: import("@azure/logger").AzureLogger;
421421
// @public
422422
export type MergeCertificateOptions = coreHttp.OperationOptions;
423423

424-
// @public
425-
export function parseKeyVaultCertificateId(id: string): KeyVaultCertificateId;
426-
427424
export { PipelineOptions }
428425

429426
// @public

sdk/keyvault/keyvault-certificates/src/identifier.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ export interface KeyVaultCertificateId {
4646
* }
4747
*```
4848
* @param id - The Id of the Key Vault Certificate.
49+
* @internal
4950
*/
5051
export function parseKeyVaultCertificateId(id: string): KeyVaultCertificateId {
5152
const urlParts = id.split("/");

sdk/keyvault/keyvault-certificates/src/index.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ import { DeleteCertificateState } from "./lro/delete/operation";
141141
import { CreateCertificateState } from "./lro/create/operation";
142142
import { RecoverDeletedCertificateState } from "./lro/recover/operation";
143143
import { parseCertificateBytes } from "./utils";
144-
import { parseKeyVaultCertificateId, KeyVaultCertificateId } from "./identifier";
144+
import { KeyVaultCertificateId } from "./identifier";
145145
import {
146146
coreContactsToCertificateContacts,
147147
getCertificateFromCertificateBundle,
@@ -168,7 +168,6 @@ export {
168168
BeginRecoverDeletedCertificateOptions,
169169
KeyVaultCertificate,
170170
KeyVaultCertificateWithPolicy,
171-
parseKeyVaultCertificateId,
172171
BackupCertificateOptions,
173172
CertificateContentType,
174173
CertificateProperties,

sdk/keyvault/keyvault-certificates/test/public/identifier.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright (c) Microsoft Corporation.
22
// Licensed under the MIT license.
33

4-
import { parseKeyVaultCertificateId } from "../../src";
4+
import { parseKeyVaultCertificateId } from "../../src/identifier";
55
import * as assert from "assert";
66

77
describe("Key Vault Certificates Identifier", () => {

sdk/keyvault/keyvault-keys/CHANGELOG.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55
- [Breaking] Removed `dist-browser` from the published package. To bundle the Azure SDK libraries for the browsers, please read our bundling guide: [link](https://github.com/Azure/azure-sdk-for-js/blob/master/documentation/Bundling.md).
66
- Updated the Key Vault Keys Long Running Operation Pollers to follow a more compact and meaningful approach moving forward.
77
- Bug fix: The logging of HTTP requests wasn't properly working - now it has been fixed and tests have been written that verify the fix.
8-
- Add a constructor overload to `CryptographyClient` that takes a `JsonWebKey` and allows for local-only subset of operations.
9-
- Add `KeyId` to the public API of CryptographyClient.
8+
- Added a constructor overload to `CryptographyClient` that takes a `JsonWebKey` and allows for local-only subset of operations.
9+
- Added `KeyId` to the public API of CryptographyClient.
10+
- Removed `parseKeyVaultKeysId` from the public API and made `KeyOptionsOptions.additionalAuthenticatedData` a readonly property.
1011

1112
## 4.2.0-beta.2 (2020-10-06)
1213

sdk/keyvault/keyvault-keys/review/keyvault-keys.api.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ export type KeyOperation = string;
189189

190190
// @public
191191
export interface KeyOperationsOptions extends CryptographyOptions {
192-
additionalAuthenticatedData?: Uint8Array;
192+
readonly additionalAuthenticatedData?: Uint8Array;
193193
iv?: Uint8Array;
194194
tag?: Uint8Array;
195195
}
@@ -340,9 +340,6 @@ export { PagedAsyncIterableIterator }
340340

341341
export { PageSettings }
342342

343-
// @public
344-
export function parseKeyVaultKeyId(id: string): KeyVaultKeyId;
345-
346343
export { PipelineOptions }
347344

348345
export { PollerLike }

sdk/keyvault/keyvault-keys/src/cryptographyClientModels.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ export interface KeyOperationsOptions extends CryptographyOptions {
147147
* Additional data to authenticate but not encrypt/decrypt when using authenticated crypto
148148
* algorithms.
149149
*/
150-
additionalAuthenticatedData?: Uint8Array;
150+
readonly additionalAuthenticatedData?: Uint8Array;
151151
/**
152152
* The tag to authenticate when performing decryption with an authenticated algorithm.
153153
*/

sdk/keyvault/keyvault-keys/src/identifier.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ export interface KeyVaultKeyId {
4747
*```
4848
4949
* @param id - The Id of the Key Vault Key.
50+
* @internal
5051
*/
5152
export function parseKeyVaultKeyId(id: string): KeyVaultKeyId {
5253
const urlParts = id.split("/");

sdk/keyvault/keyvault-keys/src/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,6 @@ export {
132132
KeyType,
133133
KnownKeyTypes,
134134
KeyPollerOptions,
135-
parseKeyVaultKeyId,
136135
BeginDeleteKeyOptions,
137136
BeginRecoverDeletedKeyOptions,
138137
KeyProperties,

0 commit comments

Comments
 (0)