Class CreateEcKeyOptions

java.lang.Object

com.azure.security.keyvault.keys.models.CreateKeyOptions

com.azure.security.keyvault.keys.models.CreateEcKeyOptions

public class CreateEcKeyOptions
extends CreateKeyOptions

Represents the configurable options to create an EC key.

Constructor Summary

Constructors

Constructor	Description
CreateEcKeyOptions(String name)	Creates a CreateEcKeyOptions with name as name of the EC key.

Method Summary

Modifier and Type	Method	Description
KeyCurveName	getCurveName()	Get the curve.
Boolean	isHardwareProtected()	Get the HSM value of the key being created.
CreateEcKeyOptions	setCurveName(KeyCurveName curveName)	Set the curve name.
CreateEcKeyOptions	setEnabled(Boolean enabled)	Set a value that indicates if the key is enabled.
CreateEcKeyOptions	setExpiresOn(OffsetDateTime expiresOn)	Set the expires UTC time.
CreateEcKeyOptions	setExportable(Boolean exportable)	Set a flag that indicates if the private key can be exported.
CreateEcKeyOptions	setHardwareProtected(Boolean hardwareProtected)	Set whether the key being created is of HSM type or not.
CreateEcKeyOptions	setKeyOperations(KeyOperation... keyOperations)	Set the key operations.
CreateEcKeyOptions	setNotBefore(OffsetDateTime notBefore)	Set the notBefore UTC time.
CreateEcKeyOptions	setReleasePolicy(KeyReleasePolicy releasePolicy)	Set the policy rules under which the key can be exported.
CreateEcKeyOptions	setTags(Map<String,String> tags)	Set the tags to be associated with the key.

Methods inherited from class CreateKeyOptions

getExpiresOn, getKeyOperations, getKeyType, getName, getNotBefore, getReleasePolicy, getTags, isEnabled, isExportable

Methods inherited from class Object

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

Constructor Details

CreateEcKeyOptions

public CreateEcKeyOptions(String name)

Creates a CreateEcKeyOptions with name as name of the EC key.

Parameters:

name - The name of the EC key.

Method Details

getCurveName

public KeyCurveName getCurveName()

Get the curve.

Returns:

The curve name.

setCurveName

public CreateEcKeyOptions setCurveName(KeyCurveName curveName)

Set the curve name.

Parameters:

curveName - The curve name to set.

Returns:

The CreateEcKeyOptions object.

isHardwareProtected

public Boolean isHardwareProtected()

Get the HSM value of the key being created.

Returns:

The HSM value.

setHardwareProtected

public CreateEcKeyOptions setHardwareProtected(Boolean hardwareProtected)

Set whether the key being created is of HSM type or not.

Parameters:

hardwareProtected - The HSM value to set.

Returns:

The CreateEcKeyOptions object.

setKeyOperations

public CreateEcKeyOptions setKeyOperations(KeyOperation... keyOperations)

Set the key operations.

Overrides:

setKeyOperations in class CreateKeyOptions

Parameters:

keyOperations - The key operations to set.

Returns:

The CreateEcKeyOptions object.

setNotBefore

public CreateEcKeyOptions setNotBefore(OffsetDateTime notBefore)

Set the notBefore UTC time.

Overrides:

setNotBefore in class CreateKeyOptions

Parameters:

notBefore - The notBefore UTC time to set.

Returns:

The CreateEcKeyOptions object.

setExpiresOn

public CreateEcKeyOptions setExpiresOn(OffsetDateTime expiresOn)

Set the expires UTC time.

Overrides:

setExpiresOn in class CreateKeyOptions

Parameters:

expiresOn - The expiry time to set for the key.

Returns:

The CreateEcKeyOptions object.

setTags

public CreateEcKeyOptions setTags(Map<String,String> tags)

Set the tags to be associated with the key.

Overrides:

setTags in class CreateKeyOptions

Parameters:

tags - The tags to set.

Returns:

The CreateEcKeyOptions object.

setEnabled

public CreateEcKeyOptions setEnabled(Boolean enabled)

Set a value that indicates if the key is enabled.

Overrides:

setEnabled in class CreateKeyOptions

Parameters:

enabled - The enabled value to set.

Returns:

The CreateEcKeyOptions object.

setExportable

public CreateEcKeyOptions setExportable(Boolean exportable)

Set a flag that indicates if the private key can be exported.

Overrides:

setExportable in class CreateKeyOptions

Parameters:

exportable - A flag that indicates if the private key can be exported.

Returns:

The updated CreateEcKeyOptions object.

setReleasePolicy

public CreateEcKeyOptions setReleasePolicy(KeyReleasePolicy releasePolicy)

Set the policy rules under which the key can be exported.

Overrides:

setReleasePolicy in class CreateKeyOptions

Parameters:

releasePolicy - The policy rules to set.

Returns:

The updated CreateEcKeyOptions object.