[KeyVault] - Replace keyId: URL with certificateKeyId: string #13908
[KeyVault] - Replace keyId: URL with certificateKeyId: string #13908maorleger merged 7 commits intoAzure:masterfrom
keyId: URL with certificateKeyId: string #13908Conversation
sadasant
left a comment
There was a problem hiding this comment.
I love it! Thank you so much 🌞
86c6cd3 to
fc42dfc
Compare
|
@bterlson / @xirzec - mind giving this a quick look when you have a second? I want to make sure this isn't harmful (or if it is, if there's a better way to handle it - We can't remove the field entirely to avoid breaking compilation (see #9639) so we deprecate it, make it unknown, and introduce a better named field that's a string instead (also taken from feedback on #9639). Then we can remove dom as a dependency? |
xirzec
left a comment
There was a problem hiding this comment.
I'm a fan of this approach. We should start using deprecation more to signal when things are going to move in the next major.
| * this field specifies the corresponding key backing the KV certificate. | ||
| * **NOTE: This property will not be serialized. It can only be populated by | ||
| * the server.** | ||
| * @deprecated Please use {@link SecretProperties.certificateKeyId} instead. This field will always be undefined. |
There was a problem hiding this comment.
Nit: Some may take the "this" here to refer to certificateKeyId :)
How about the below?
The
keyIdfield has and will be left as undefined.
what
secretProperties.keyIdand replace it withsecretProperties.certificateKeyIddomfrom tsconfigwhy
secretProperties.keyIdbeing a URL is the only reason we needdomlib in this library.Even though it has never been populated we cannot remove it because we might break
someone's compilation (although it would have never worked at runtime).
Instead we'll deprecate it, note that it will always be undefined, and make it an any so
we can remove the dependency on
dom.Refer to #9639 for previous work in this area.
Resolves #10726