ComputeBatchModelFactory.BatchNodeUserCreateContent Method

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

Azure.Compute.Batch v1.0.0-beta.1

Source:

ComputeBatchModelFactory.cs

Initializes a new instance of BatchNodeUserCreateContent.

public static Azure.Compute.Batch.BatchNodeUserCreateContent BatchNodeUserCreateContent (string name = default, bool? isAdmin = default, DateTimeOffset? expiryTime = default, string password = default, string sshPublicKey = default);

static member BatchNodeUserCreateContent : string * Nullable<bool> * Nullable<DateTimeOffset> * string * string -> Azure.Compute.Batch.BatchNodeUserCreateContent

Public Shared Function BatchNodeUserCreateContent (Optional name As String = Nothing, Optional isAdmin As Nullable(Of Boolean) = Nothing, Optional expiryTime As Nullable(Of DateTimeOffset) = Nothing, Optional password As String = Nothing, Optional sshPublicKey As String = Nothing) As BatchNodeUserCreateContent

Parameters

name

String

The user name of the Account.

isAdmin

Nullable<Boolean>

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

expiryTime

Nullable<DateTimeOffset>

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.

password

String

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

String

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

Returns

BatchNodeUserCreateContent

A new BatchNodeUserCreateContent instance for mocking.