KeyProperties Class

Definition

Namespace:
Azure.Security.KeyVault.Keys
Assembly:
Azure.Security.KeyVault.Keys.dll
Package:
Azure.Security.KeyVault.Keys v4.10.0
Package:
Azure.Security.KeyVault.Keys v4.8.0-beta.1
Source:
KeyProperties.cs
Source:
KeyProperties.cs

KeyProperties is the resource containing all the properties of the KeyVaultKey except JsonWebKey properties.

public class KeyProperties
type KeyProperties = class
Public Class KeyProperties
Inheritance
Object
KeyProperties

Constructors

Name Description
KeyProperties(String)

Initializes a new instance of the KeyProperties class.
KeyProperties(Uri)

Initializes a new instance of the KeyProperties class.

Properties

Name Description
Attestation

Gets the KeyAttestation object containing the attestation policy.
CreatedOn

Gets a DateTimeOffset indicating when the key was created.
Enabled

Gets or sets a value indicating whether the key is enabled and useable for cryptographic operations.
ExpiresOn

Gets or sets a DateTimeOffset indicating when the key will expire and cannot be used for cryptographic operations.
Exportable

Gets or sets a value indicating whether the private key can be exported.
HsmPlatform

Gets the underlying HSM platform.
Id

Gets the key identifier.
KeySize

Gets the key size in bits for keys. For example: 128, 192, or 256 for AES keys.
Managed

Gets a value indicating whether the key's lifetime is managed by Key Vault. If this key is backing a Key Vault certificate, the value will be true.
Name

Gets the name of the key.
NotBefore

Gets or sets a DateTimeOffset indicating when the key will be valid and can be used for cryptographic operations.
RecoverableDays

Gets the number of days a key is retained before being deleted for a soft delete-enabled Key Vault.
RecoveryLevel

Gets the recovery level currently in effect for keys in the Key Vault. If Purgeable, the key can be permanently deleted by an authorized user; otherwise, only the service can purge the keys at the end of the retention interval.
ReleasePolicy

Gets or sets the policy rules under which the key can be exported.
Tags

Gets a dictionary of tags with specific metadata about the key.
UpdatedOn

Gets a DateTimeOffset indicating when the key was updated.
VaultUri

Gets the Key Vault base Uri.
Version

Gets the version of the key.

Applies to