azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.storage.models.SshPublicKey.yml

### YamlMime:JavaType
uid: "com.azure.resourcemanager.storage.models.SshPublicKey"
fullName: "com.azure.resourcemanager.storage.models.SshPublicKey"
name: "SshPublicKey"
nameWithType: "SshPublicKey"
summary: "The Ssh<wbr>Public<wbr>Key model."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **SshPublicKey**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.storage.models.SshPublicKey?alt=com.azure.resourcemanager.storage.models.SshPublicKey&text=SshPublicKey\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.storage.models.SshPublicKey.SshPublicKey()"
  fullName: "com.azure.resourcemanager.storage.models.SshPublicKey.SshPublicKey()"
  name: "SshPublicKey()"
  nameWithType: "SshPublicKey.SshPublicKey()"
  summary: "Creates an instance of Ssh<wbr>Public<wbr>Key class."
  syntax: "public SshPublicKey()"
  desc: "Creates an instance of SshPublicKey class."
methods:
- uid: "com.azure.resourcemanager.storage.models.SshPublicKey.description()"
  fullName: "com.azure.resourcemanager.storage.models.SshPublicKey.description()"
  name: "description()"
  nameWithType: "SshPublicKey.description()"
  summary: "Get the description property: Optional."
  syntax: "public String description()"
  desc: "Get the description property: Optional. It is used to store the function/usage of the key."
  returns:
    description: "the description value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.storage.models.SshPublicKey.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.resourcemanager.storage.models.SshPublicKey.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "SshPublicKey.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Ssh<wbr>Public<wbr>Key from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static SshPublicKey fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If an error occurs while reading the SshPublicKey."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of SshPublicKey from the JsonReader."
  returns:
    description: "An instance of SshPublicKey if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
    type: "<xref href=\"com.azure.resourcemanager.storage.models.SshPublicKey?alt=com.azure.resourcemanager.storage.models.SshPublicKey&text=SshPublicKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storage.models.SshPublicKey.key()"
  fullName: "com.azure.resourcemanager.storage.models.SshPublicKey.key()"
  name: "key()"
  nameWithType: "SshPublicKey.key()"
  summary: "Get the key property: Ssh public key base64 encoded."
  syntax: "public String key()"
  desc: "Get the key property: Ssh public key base64 encoded. The format should be: '<keyType> <keyData>', e.g. ssh-rsa AAAABBBB."
  returns:
    description: "the key value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.storage.models.SshPublicKey.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.resourcemanager.storage.models.SshPublicKey.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "SshPublicKey.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storage.models.SshPublicKey.validate()"
  fullName: "com.azure.resourcemanager.storage.models.SshPublicKey.validate()"
  name: "validate()"
  nameWithType: "SshPublicKey.validate()"
  summary: "Validates the instance."
  syntax: "public void validate()"
  desc: "Validates the instance."
- uid: "com.azure.resourcemanager.storage.models.SshPublicKey.withDescription(java.lang.String)"
  fullName: "com.azure.resourcemanager.storage.models.SshPublicKey.withDescription(String description)"
  name: "withDescription(String description)"
  nameWithType: "SshPublicKey.withDescription(String description)"
  summary: "Set the description property: Optional."
  parameters:
  - description: "the description value to set."
    name: "description"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SshPublicKey withDescription(String description)"
  desc: "Set the description property: Optional. It is used to store the function/usage of the key."
  returns:
    description: "the SshPublicKey object itself."
    type: "<xref href=\"com.azure.resourcemanager.storage.models.SshPublicKey?alt=com.azure.resourcemanager.storage.models.SshPublicKey&text=SshPublicKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storage.models.SshPublicKey.withKey(java.lang.String)"
  fullName: "com.azure.resourcemanager.storage.models.SshPublicKey.withKey(String key)"
  name: "withKey(String key)"
  nameWithType: "SshPublicKey.withKey(String key)"
  summary: "Set the key property: Ssh public key base64 encoded."
  parameters:
  - description: "the key value to set."
    name: "key"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SshPublicKey withKey(String key)"
  desc: "Set the key property: Ssh public key base64 encoded. The format should be: '<keyType> <keyData>', e.g. ssh-rsa AAAABBBB."
  returns:
    description: "the SshPublicKey object itself."
    type: "<xref href=\"com.azure.resourcemanager.storage.models.SshPublicKey?alt=com.azure.resourcemanager.storage.models.SshPublicKey&text=SshPublicKey\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The SshPublicKey model."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.storage.models.SshPublicKey?alt=com.azure.resourcemanager.storage.models.SshPublicKey&text=SshPublicKey\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.storage.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-storage:2.42.0