KeyInner Class

Package:

com.azure.resourcemanager.keyvault.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-keyvault:2.54.1

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.keyvault.fluent.models.KeyInner

public final class KeyInner
extends Resource

The key resource.

Method Summary

Modifier and Type	Method and Description
KeyAttributes	attributes() Get the attributes property: The attributes of the key.
JsonWebKeyCurveName	curveName() Get the curveName property: The elliptic curve name.
static KeyInner	fromJson(JsonReader jsonReader) Reads an instance of KeyInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
List<JsonWebKeyOperation>	keyOps() Get the keyOps property: The keyOps property.
Integer	keySize() Get the keySize property: The key size in bits.
String	keyUri() Get the keyUri property: The URI to retrieve the current version of the key.
String	keyUriWithVersion() Get the keyUriWithVersion property: The URI to retrieve the specific version of the key.
JsonWebKeyType	kty() Get the kty property: The type of the key.
String	location() Get the location property: The supported Azure location where the managed HSM Pool should be created.
String	name() Get the name property: The name of the resource.
KeyReleasePolicy	releasePolicy() Get the releasePolicy property: Key release policy in response.
RotationPolicy	rotationPolicy() Get the rotationPolicy property: Key rotation policy in response.
SystemData	systemData() Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Map<String,String>	tags() Get the tags property: Resource tags.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

attributes

public KeyAttributes attributes()

Get the attributes property: The attributes of the key.

Returns:

the attributes value.

curveName

public JsonWebKeyCurveName curveName()

Get the curveName property: The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256.

Returns:

the curveName value.

fromJson

public static KeyInner fromJson(JsonReader jsonReader)

Reads an instance of KeyInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of KeyInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

KeyInner.id()

Returns:

the id value.

keyOps

public List<JsonWebKeyOperation> keyOps()

Get the keyOps property: The keyOps property.

Returns:

the keyOps value.

keySize

public Integer keySize()

Get the keySize property: The key size in bits. For example: 2048, 3072, or 4096 for RSA. Default for RSA and RSA-HSM keys is 2048. Exception made for bring your own key (BYOK), key exchange keys default to 4096.

Returns:

the keySize value.

keyUri

public String keyUri()

Get the keyUri property: The URI to retrieve the current version of the key.

Returns:

the keyUri value.

keyUriWithVersion

public String keyUriWithVersion()

Get the keyUriWithVersion property: The URI to retrieve the specific version of the key.

Returns:

the keyUriWithVersion value.

kty

public JsonWebKeyType kty()

Get the kty property: The type of the key. For valid values, see JsonWebKeyType.

Returns:

the kty value.

location

public String location()

Get the location property: The supported Azure location where the managed HSM Pool should be created.

Overrides:

KeyInner.location()

Returns:

the location value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

KeyInner.name()

Returns:

the name value.

releasePolicy

public KeyReleasePolicy releasePolicy()

Get the releasePolicy property: Key release policy in response. It will be used for both output and input. Omitted if empty.

Returns:

the releasePolicy value.

rotationPolicy

public RotationPolicy rotationPolicy()

Get the rotationPolicy property: Key rotation policy in response. It will be used for both output and input. Omitted if empty.

Returns:

the rotationPolicy value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

tags

public Map<String,String> tags()

Get the tags property: Resource tags.

Overrides:

KeyInner.tags()

Returns:

the tags value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

KeyInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

KeyInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.