public class KeyProperties extends Object
KeyProperties
is the resource containing all the properties of the key except its JsonWebKey
material. It is managed by the Key Service.KeyClient
,
KeyAsyncClient
Constructor and Description |
---|
KeyProperties() |
Modifier and Type | Method and Description |
---|---|
OffsetDateTime |
getCreatedOn()
Get the
time at which key was created in UTC. |
OffsetDateTime |
getExpiresOn()
Get the
key expiration time in UTC. |
String |
getId()
Get the key identifier.
|
String |
getName()
Get the key name.
|
OffsetDateTime |
getNotBefore()
Get the
key's notBefore time in UTC. |
Integer |
getRecoverableDays()
Gets the number of days a key is retained before being deleted for a soft delete-enabled Key Vault.
|
String |
getRecoveryLevel()
Get the key recovery level.
|
Map<String,String> |
getTags()
Get the tags associated with the key.
|
OffsetDateTime |
getUpdatedOn()
Get the
time at which key was last updated in UTC. |
String |
getVersion()
Get the version of the key.
|
Boolean |
isEnabled()
Get the enabled value.
|
Boolean |
isManaged()
Get the managed value.
|
KeyProperties |
setEnabled(Boolean enabled)
Set a value that indicates if the key is enabled.
|
KeyProperties |
setExpiresOn(OffsetDateTime expiresOn)
Set the
key expiration time in UTC. |
KeyProperties |
setNotBefore(OffsetDateTime notBefore)
Set the
key's notBefore time in UTC. |
KeyProperties |
setTags(Map<String,String> tags)
Set the tags to be associated with the key.
|
public Integer getRecoverableDays()
public String getRecoveryLevel()
public String getName()
public Boolean isEnabled()
public KeyProperties setEnabled(Boolean enabled)
enabled
- The enabled value to set.KeyProperties
object.public OffsetDateTime getNotBefore()
key's notBefore time
in UTC.key's notBefore time
in UTC.public KeyProperties setNotBefore(OffsetDateTime notBefore)
key's notBefore time
in UTC.notBefore
- The key's notBefore time
in UTC.KeyProperties
object.public OffsetDateTime getExpiresOn()
key expiration time
in UTC.key expiration time
in UTC.public KeyProperties setExpiresOn(OffsetDateTime expiresOn)
key expiration time
in UTC.expiresOn
- The key expiration time
in UTC.KeyProperties
object.public OffsetDateTime getCreatedOn()
time at which key was created
in UTC.time at which key was created
in UTC.public OffsetDateTime getUpdatedOn()
time at which key was last updated
in UTC.time at which key was last updated
in UTC.public String getId()
public Map<String,String> getTags()
public KeyProperties setTags(Map<String,String> tags)
tags
- The tags to set.KeyProperties
object.public Boolean isManaged()
public String getVersion()
Copyright © 2021 Microsoft Corporation. All rights reserved.