NodeUpdateUserParameter.SshPublicKey Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Batch.Protocol.Models
Assembly:
Microsoft.Azure.Batch.dll
Package:
Microsoft.Azure.Batch v16.3.1
Source:
NodeUpdateUserParameter.cs

Gets or sets the SSH public key that can be used for remote login to the Compute Node.

[Newtonsoft.Json.JsonProperty(PropertyName="sshPublicKey")]
public string SshPublicKey { get; set; }
[<Newtonsoft.Json.JsonProperty(PropertyName="sshPublicKey")>]
member this.SshPublicKey : string with get, set
Public Property SshPublicKey As String

Property Value

String
Attributes
Newtonsoft.Json.JsonPropertyAttribute

Remarks

The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If omitted, any existing SSH public key is removed.

Applies to