BatchNodeUserCreateContent Class

Definition

Parameters for creating a user account for RDP or SSH access on an Azure Batch Compute Node.

public class BatchNodeUserCreateContent : System.ClientModel.Primitives.IJsonModel<Azure.Compute.Batch.BatchNodeUserCreateContent>, System.ClientModel.Primitives.IPersistableModel<Azure.Compute.Batch.BatchNodeUserCreateContent>
type BatchNodeUserCreateContent = class
    interface IJsonModel<BatchNodeUserCreateContent>
    interface IPersistableModel<BatchNodeUserCreateContent>
Public Class BatchNodeUserCreateContent
Implements IJsonModel(Of BatchNodeUserCreateContent), IPersistableModel(Of BatchNodeUserCreateContent)
Inheritance
BatchNodeUserCreateContent
Implements

Constructors

BatchNodeUserCreateContent(String)

Initializes a new instance of BatchNodeUserCreateContent.

Properties

ExpiryTime

The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day.

IsAdmin

Whether the Account should be an administrator on the Compute Node. The default value is false.

Name

The user name of the Account.

Password

The password of the Account. The password is required for Windows Compute Nodes (those created with 'virtualMachineConfiguration' using a Windows Image reference). For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property.

SshPublicKey

The SSH public key that can be used for remote login to the Compute Node. 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).

Explicit Interface Implementations

IJsonModel<BatchNodeUserCreateContent>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<BatchNodeUserCreateContent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<BatchNodeUserCreateContent>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<BatchNodeUserCreateContent>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<BatchNodeUserCreateContent>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to