Package com.azure.resourcemanager.keyvault.fluent.models

Class KeyProperties

java.lang.Object
com.azure.resourcemanager.keyvault.fluent.models.KeyProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<KeyProperties>
public final class KeyProperties extends Object implements com.azure.json.JsonSerializable<KeyProperties>
The properties of the key.

  • Constructor Details

    • KeyProperties

      public KeyProperties()
      Creates an instance of KeyProperties class.

  • Method Details

    • attributes

      public KeyAttributes attributes()
      Get the attributes property: The attributes of the key.
      Returns:
      the attributes value.

    • withAttributes

      public KeyProperties withAttributes(KeyAttributes attributes)
      Set the attributes property: The attributes of the key.
      Parameters:
      attributes - the attributes value to set.
      Returns:
      the KeyProperties object itself.

    • kty

      public JsonWebKeyType kty()
      Get the kty property: The type of the key. For valid values, see JsonWebKeyType.
      Returns:
      the kty value.

    • withKty

      public KeyProperties 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 KeyProperties object itself.

    • keyOps

      public List<JsonWebKeyOperation> keyOps()
      Get the keyOps property: The keyOps property.
      Returns:
      the keyOps value.

    • withKeyOps

      public KeyProperties withKeyOps(List<JsonWebKeyOperation> keyOps)
      Set the keyOps property: The keyOps property.
      Parameters:
      keyOps - the keyOps value to set.
      Returns:
      the KeyProperties object itself.

    • 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.

    • withKeySize

      public KeyProperties withKeySize(Integer keySize)
      Set 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.
      Parameters:
      keySize - the keySize value to set.
      Returns:
      the KeyProperties object itself.

    • 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.

    • withCurveName

      public KeyProperties withCurveName(JsonWebKeyCurveName curveName)
      Set the curveName property: The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256.
      Parameters:
      curveName - the curveName value to set.
      Returns:
      the KeyProperties object itself.

    • 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.

    • 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.

    • withRotationPolicy

      public KeyProperties withRotationPolicy(RotationPolicy 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 KeyProperties object itself.

    • 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.

    • withReleasePolicy

      public KeyProperties withReleasePolicy(KeyReleasePolicy 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 KeyProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<KeyProperties>
      Throws:
      IOException

    • fromJson

      public static KeyProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of KeyProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of KeyProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the KeyProperties.