ManagedHsmKeyInner Class

public final class ManagedHsmKeyInner
extends ProxyResourceWithoutSystemData

The key resource.

Constructor Summary

Constructor Description
ManagedHsmKeyInner()

Creates an instance of ManagedHsmKeyInner class.

Method Summary

Modifier and Type Method and Description
ManagedHsmKeyAttributes attributes()

Get the attributes property: The attributes of the key.

JsonWebKeyCurveName curveName()

Get the curveName property: The elliptic curve name.

static ManagedHsmKeyInner fromJson(JsonReader jsonReader)

Reads an instance of ManagedHsmKeyInner 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 name()

Get the name property: The name of the resource.

ManagedHsmKeyReleasePolicy releasePolicy()

Get the releasePolicy property: Key release policy in response.

ManagedHsmRotationPolicy rotationPolicy()

Get the rotationPolicy property: Key rotation policy in response.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

void validate()

Validates the instance.

ManagedHsmKeyInner withAttributes(ManagedHsmKeyAttributes attributes)

Set the attributes property: The attributes of the key.

ManagedHsmKeyInner withCurveName(JsonWebKeyCurveName curveName)

Set the curveName property: The elliptic curve name.

ManagedHsmKeyInner withKeyOps(List<JsonWebKeyOperation> keyOps)

Set the keyOps property: The keyOps property.

ManagedHsmKeyInner withKeySize(Integer keySize)

Set the keySize property: The key size in bits.

ManagedHsmKeyInner withKty(JsonWebKeyType kty)

Set the kty property: The type of the key.

ManagedHsmKeyInner withReleasePolicy(ManagedHsmKeyReleasePolicy releasePolicy)

Set the releasePolicy property: Key release policy in response.

ManagedHsmKeyInner withRotationPolicy(ManagedHsmRotationPolicy rotationPolicy)

Set the rotationPolicy property: Key rotation policy in response.

ManagedHsmKeyInner withTags(Map<String,String> tags)

Set the tags property: Resource tags.

Methods inherited from ProxyResourceWithoutSystemData

Methods inherited from java.lang.Object

Constructor Details

ManagedHsmKeyInner

public ManagedHsmKeyInner()

Creates an instance of ManagedHsmKeyInner class.

Method Details

attributes

public ManagedHsmKeyAttributes 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.

Returns:

the curveName value.

fromJson

public static ManagedHsmKeyInner fromJson(JsonReader jsonReader)

Reads an instance of ManagedHsmKeyInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ManagedHsmKeyInner 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:

ManagedHsmKeyInner.id()

Returns:

the id value.

keyOps

public List 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.

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.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ManagedHsmKeyInner.name()

Returns:

the name value.

releasePolicy

public ManagedHsmKeyReleasePolicy 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 ManagedHsmRotationPolicy 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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ManagedHsmKeyInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

ManagedHsmKeyInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

ManagedHsmKeyInner.validate()

withAttributes

public ManagedHsmKeyInner withAttributes(ManagedHsmKeyAttributes attributes)

Set the attributes property: The attributes of the key.

Parameters:

attributes - the attributes value to set.

Returns:

the ManagedHsmKeyInner object itself.

withCurveName

public ManagedHsmKeyInner withCurveName(JsonWebKeyCurveName curveName)

Set the curveName property: The elliptic curve name. For valid values, see JsonWebKeyCurveName.

Parameters:

curveName - the curveName value to set.

Returns:

the ManagedHsmKeyInner object itself.

withKeyOps

public ManagedHsmKeyInner withKeyOps(List keyOps)

Set the keyOps property: The keyOps property.

Parameters:

keyOps - the keyOps value to set.

Returns:

the ManagedHsmKeyInner object itself.

withKeySize

public ManagedHsmKeyInner withKeySize(Integer keySize)

Set the keySize property: The key size in bits. For example: 2048, 3072, or 4096 for RSA.

Parameters:

keySize - the keySize value to set.

Returns:

the ManagedHsmKeyInner object itself.

withKty

public ManagedHsmKeyInner withKty(JsonWebKeyType kty)

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

Parameters:

kty - the kty value to set.

Returns:

the ManagedHsmKeyInner object itself.

withReleasePolicy

public ManagedHsmKeyInner withReleasePolicy(ManagedHsmKeyReleasePolicy releasePolicy)

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

Parameters:

releasePolicy - the releasePolicy value to set.

Returns:

the ManagedHsmKeyInner object itself.

withRotationPolicy

public ManagedHsmKeyInner withRotationPolicy(ManagedHsmRotationPolicy rotationPolicy)

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

Parameters:

rotationPolicy - the rotationPolicy value to set.

Returns:

the ManagedHsmKeyInner object itself.

withTags

public ManagedHsmKeyInner withTags(Map tags)

Set the tags property: Resource tags.

Overrides:

ManagedHsmKeyInner.withTags(Map<String,String> tags)

Parameters:

tags

Applies to