Skip to content

Commit

Permalink
[KeyVault] - Add release policy grammar links (#20941)
Browse files Browse the repository at this point in the history
### 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.
  • Loading branch information
maorleger authored Mar 21, 2022
1 parent f94c26a commit efde84b
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions sdk/keyvault/keyvault-keys/src/keysModels.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 };
Expand Down Expand Up @@ -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;
}

Expand Down

0 comments on commit efde84b

Please sign in to comment.