BatchClient.CreateNodeUserAsync Method

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

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

Overloads

CreateNodeUserAsync(String, String, BatchNodeUserCreateContent, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken)	Adds a user Account to the specified Compute Node.
CreateNodeUserAsync(String, String, RequestContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestContext)	[Protocol Method] Adds a user Account to the specified Compute Node. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CreateNodeUserAsync(String, String, BatchNodeUserCreateContent, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken) convenience overload with strongly typed models first.

CreateNodeUserAsync(String, String, BatchNodeUserCreateContent, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken)

Adds a user Account to the specified Compute Node.

public virtual System.Threading.Tasks.Task<Azure.Response> CreateNodeUserAsync (string poolId, string nodeId, Azure.Compute.Batch.BatchNodeUserCreateContent user, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateNodeUserAsync : string * string * Azure.Compute.Batch.BatchNodeUserCreateContent * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateNodeUserAsync : string * string * Azure.Compute.Batch.BatchNodeUserCreateContent * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CreateNodeUserAsync (poolId As String, nodeId As String, user As BatchNodeUserCreateContent, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

poolId

String

The ID of the Pool that contains the Compute Node.

nodeId

String

The ID of the machine on which you want to create a user Account.

user

BatchNodeUserCreateContent

The options to use for creating the user.

timeOutInSeconds

Nullable<Int32>

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".

ocpdate

Nullable<DateTimeOffset>

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response>

Exceptions

ArgumentNullException

poolId, nodeId or user is null.

ArgumentException

poolId or nodeId is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call CreateNodeUserAsync.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

BatchNodeUserCreateContent user = new BatchNodeUserCreateContent("<name>");
Response response = await client.CreateNodeUserAsync("<poolId>", "<nodeId>", user);

This sample shows how to call CreateNodeUserAsync with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

BatchNodeUserCreateContent user = new BatchNodeUserCreateContent("<name>")
{
    IsAdmin = true,
    ExpiryTime = DateTimeOffset.Parse("2022-05-10T18:57:31.2311892Z"),
    Password = "<password>",
    SshPublicKey = "<sshPublicKey>",
};
Response response = await client.CreateNodeUserAsync("<poolId>", "<nodeId>", user, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"));

Remarks

You can add a user Account to a Compute Node only when it is in the idle or running state.

CreateNodeUserAsync(String, String, RequestContent, Nullable<Int32>, Nullable<DateTimeOffset>, RequestContext)

[Protocol Method] Adds a user Account to the specified Compute Node.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler CreateNodeUserAsync(String, String, BatchNodeUserCreateContent, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> CreateNodeUserAsync (string poolId, string nodeId, Azure.Core.RequestContent content, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, Azure.RequestContext context = default);

abstract member CreateNodeUserAsync : string * string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateNodeUserAsync : string * string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CreateNodeUserAsync (poolId As String, nodeId As String, content As RequestContent, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

poolId

String

The ID of the Pool that contains the Compute Node.

nodeId

String

The ID of the machine on which you want to create a user Account.

content

RequestContent

The content to send as the body of the request.

timeOutInSeconds

Nullable<Int32>

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".

ocpdate

Nullable<DateTimeOffset>

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

poolId, nodeId or content is null.

ArgumentException

poolId or nodeId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call CreateNodeUserAsync.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

using RequestContent content = RequestContent.Create(new
{
    name = "<name>",
});
Response response = await client.CreateNodeUserAsync("<poolId>", "<nodeId>", content);

Console.WriteLine(response.Status);

This sample shows how to call CreateNodeUserAsync with all parameters and request content.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
BatchClient client = new BatchClient(endpoint, credential);

using RequestContent content = RequestContent.Create(new
{
    name = "<name>",
    isAdmin = true,
    expiryTime = "2022-05-10T18:57:31.2311892Z",
    password = "<password>",
    sshPublicKey = "<sshPublicKey>",
});
Response response = await client.CreateNodeUserAsync("<poolId>", "<nodeId>", content, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"));

Console.WriteLine(response.Status);