Class KeyVaultKey

java.lang.Object

com.azure.security.keyvault.keys.models.KeyVaultKey

All Implemented Interfaces:

com.azure.json.JsonSerializable<KeyVaultKey>

Direct Known Subclasses:

DeletedKey

public class KeyVaultKey
extends Object
implements com.azure.json.JsonSerializable<KeyVaultKey>

Key is the resource consisting of name, JsonWebKey and its attributes specified in KeyProperties. It is managed by Key Service.

See Also:

• KeyClient
• KeyAsyncClient

Method Summary

Modifier and Type	Method	Description
static KeyVaultKey	fromJson(com.azure.json.JsonReader jsonReader)	Reads a JSON stream into a KeyVaultKey.
String	getId()	Get the key identifier.
JsonWebKey	getKey()	Get the JSON Web Key.
List<KeyOperation>	getKeyOperations()	Get the key operations.
KeyType	getKeyType()	Get the key type.
String	getName()	Get the key name.
KeyProperties	getProperties()	Get the key properties.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class Object

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

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Method Details

getKey

public JsonWebKey getKey()

Get the JSON Web Key.

Returns:

The JSON Web Key.

getProperties

public KeyProperties getProperties()

Get the key properties.

Returns:

The key properties.

getId

public String getId()

Get the key identifier.

Returns:

The key identifier.

getName

public String getName()

Get the key name.

Returns:

The key name.

getKeyType

public KeyType getKeyType()

Get the key type.

Returns:

The key type.

getKeyOperations

public List<KeyOperation> getKeyOperations()

Get the key operations.

Returns:

The key operations.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<KeyVaultKey>

Throws:

IOException

fromJson

public static KeyVaultKey fromJson(com.azure.json.JsonReader jsonReader)
                            throws IOException

Reads a JSON stream into a KeyVaultKey.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of KeyVaultKey that the JSON stream represented, may return null.

Throws:

IOException - If a KeyVaultKey fails to be read from the jsonReader.