Package com.azure.security.keyvault.keys.models

Class KeyRotationPolicyProperties

java.lang.Object

com.azure.security.keyvault.keys.models.KeyRotationPolicyProperties

Direct Known Subclasses:

KeyRotationPolicy

public class KeyRotationPolicyProperties
extends Object

The properties of a key rotation policy that the client can set for a given key. You may also reset the key rotation policy to its default values by setting lifetimeActions to an empty array.

See Also:

KeyRotationPolicy

Field Summary

Fields

Modifier and Type	Field	Description
protected String	expiryTime	The expiry time in ISO-8601 format.
protected List<KeyRotationLifetimeAction>	keyRotationLifetimeActions	The KeyRotationLifetimeAction.

Constructor Summary

Constructors

Constructor	Description
KeyRotationPolicyProperties()

Method Summary

Modifier and Type	Method	Description
String	getExpiryTime()	Get the optional key expiration period used to define the duration after which a newly rotated key will expire.
List<KeyRotationLifetimeAction>	getLifetimeActions()	Get the actions that will be performed by Key Vault over the lifetime of a key.
KeyRotationPolicyProperties	setExpiryTime(String expiryTime)	Set the optional key expiration period used to define the duration after which a newly rotated key will expire.
KeyRotationPolicyProperties	setLifetimeActions(List<KeyRotationLifetimeAction> keyRotationLifetimeActions)	Set the actions that will be performed by Key Vault over the lifetime of a key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

expiryTime

protected String expiryTime

The expiry time in ISO-8601 format.

keyRotationLifetimeActions

protected List<KeyRotationLifetimeAction> keyRotationLifetimeActions

The KeyRotationLifetimeAction.

Constructor Detail

KeyRotationPolicyProperties

public KeyRotationPolicyProperties()

Method Detail

getExpiryTime

public String getExpiryTime()

Get the optional key expiration period used to define the duration after which a newly rotated key will expire. It should be defined as an ISO 8601 duration. For example, 90 days would be formatted as follows: "P90D", 3 months would be "P3M", 48 hours would be "PT48H" and 1 year and 10 days would be "P1Y10D".

Returns:

The expiry time in ISO 8601 format.

setExpiryTime

public KeyRotationPolicyProperties setExpiryTime(String expiryTime)

Set the optional key expiration period used to define the duration after which a newly rotated key will expire. It should be defined as an ISO 8601 duration. For example, 90 days would be formatted as follows: "P90D", 3 months would be "P3M", 48 hours would be "PT48H" and 1 year and 10 days would be "P1Y10D".

Parameters:

expiryTime - The expiry time to set in ISO 8601 format.

Returns:

The updated KeyRotationPolicyProperties object.

getLifetimeActions

public List<KeyRotationLifetimeAction> getLifetimeActions()

Get the actions that will be performed by Key Vault over the lifetime of a key.

You may also pass an empty array to restore to its default values.

Returns:

The actions in this policy.

setLifetimeActions

public KeyRotationPolicyProperties setLifetimeActions(List<KeyRotationLifetimeAction> keyRotationLifetimeActions)

Set the actions that will be performed by Key Vault over the lifetime of a key.

You may also pass an empty array to restore to its default values.

Parameters:

keyRotationLifetimeActions - The actions to set.

Returns:

The updated KeyRotationPolicyProperties object.