KeyReleasePolicy interface

Package:

@azure/keyvault-keys

The policy rules under which a key can be exported.

Properties

contentType	Content type and version of key release policy. Defaults to "application/json; charset=utf-8" if omitted.
encodedPolicy	The policy rules under which the key can be released. Encoded based on the 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.
immutable	Marks a release policy as immutable. An immutable release policy cannot be changed or updated after being marked immutable.

Property Details

contentType

Content type and version of key release policy.

Defaults to "application/json; charset=utf-8" if omitted.

contentType?: string

Property Value

string

encodedPolicy

The policy rules under which the key can be released. Encoded based on the 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

Property Value

Uint8Array

immutable

Marks a release policy as immutable. An immutable release policy cannot be changed or updated after being marked immutable.

immutable?: boolean

Property Value

boolean