From efde84bf0f1bb039422c76650d37b89b2591b5f2 Mon Sep 17 00:00:00 2001 From: Maor Leger Date: Mon, 21 Mar 2022 09:34:03 -0700 Subject: [PATCH] [KeyVault] - Add release policy grammar links (#20941) ### Packages impacted by this PR @azure/keyvault-keys ### Issues associated with this PR #18400 ### Describe the problem that is addressed by this PR The service team would like to document the release policy grammar, and as such has asked us to link to their documentation. While the documentation is not live yet, I did get the content folks to point it to a valid url so that we can include it in our doc-comments now. --- sdk/keyvault/keyvault-keys/src/keysModels.ts | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/sdk/keyvault/keyvault-keys/src/keysModels.ts b/sdk/keyvault/keyvault-keys/src/keysModels.ts index 3c58934160ca..b4146d428cec 100644 --- a/sdk/keyvault/keyvault-keys/src/keysModels.ts +++ b/sdk/keyvault/keyvault-keys/src/keysModels.ts @@ -2,12 +2,14 @@ // Licensed under the MIT license. import * as coreHttp from "@azure/core-http"; + import { DeletionRecoveryLevel, + JsonWebKeyOperation as KeyOperation, JsonWebKeyType as KeyType, KnownJsonWebKeyType as KnownKeyTypes, - JsonWebKeyOperation as KeyOperation, } from "./generated/models"; + import { KeyCurveName } from "./cryptographyClientModels"; export { KeyType, KnownKeyTypes, KeyOperation }; @@ -285,10 +287,16 @@ export interface KeyReleasePolicy { */ contentType?: string; - /** Blob encoding the policy rules under which the key can be released. */ + /** + * The policy rules under which the key can be released. Encoded based on the {@link KeyReleasePolicy.contentType}. + * + * For more information regarding the release policy grammar for Azure Key Vault, please refer to: + * - https://aka.ms/policygrammarkeys for Azure Key Vault release policy grammar. + * - https://aka.ms/policygrammarmhsm for Azure Managed HSM release policy grammar. + */ encodedPolicy?: Uint8Array; - /** Marks a release policy as immutable. An immutable release policy cannot be changed or updated after marked immutable. */ + /** Marks a release policy as immutable. An immutable release policy cannot be changed or updated after being marked immutable. */ immutable?: boolean; }