Class KeyInner

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.core.management.Resource
com.azure.resourcemanager.keyvault.fluent.models.KeyInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class KeyInner extends com.azure.core.management.Resource
The key resource.

  • Method Summary

    Modifier and Type
    Method
    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(com.azure.json.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.
    com.azure.core.management.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.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    String
    type()
    Get the type property: The type of the resource.
    void
    validate()
    Validates the instance.

    Methods inherited from class com.azure.core.management.Resource

    withLocation, withTags

    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

    • location

      public String location()
      Get the location property: The supported Azure location where the managed HSM Pool should be created.
      Overrides:
      location in class com.azure.core.management.Resource
      Returns:
      the location value.

    • tags

      public Map<String,String> tags()
      Get the tags property: Resource tags.
      Overrides:
      tags in class com.azure.core.management.Resource
      Returns:
      the tags value.

    • systemData

      public com.azure.core.management.SystemData systemData()
      Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      Returns:
      the systemData value.

    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class com.azure.core.management.ProxyResource
      Returns:
      the type value.

    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class com.azure.core.management.ProxyResource
      Returns:
      the name value.

    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class com.azure.core.management.ProxyResource
      Returns:
      the id value.

    • attributes

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

    • kty

      public JsonWebKeyType kty()
      Get the kty property: The type of the key. For valid values, see JsonWebKeyType.
      Returns:
      the kty 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.

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

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

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

    • 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<com.azure.core.management.ProxyResource>
      Overrides:
      toJson in class com.azure.core.management.Resource
      Throws:
      IOException

    • fromJson

      public static KeyInner fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the KeyInner.