BatchClient.ReplaceNodeUser Method

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

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

Overloads

ReplaceNodeUser(String, String, String, BatchNodeUserUpdateContent, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken)

Updates the password and expiration time of a user Account on the specified Compute Node.

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

[Protocol Method] Updates the password and expiration time of a user Account on 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 ReplaceNodeUser(String, String, String, BatchNodeUserUpdateContent, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken) convenience overload with strongly typed models first.

ReplaceNodeUser(String, String, String, BatchNodeUserUpdateContent, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken)

Updates the password and expiration time of a user Account on the specified Compute Node.

public virtual Azure.Response ReplaceNodeUser (string poolId, string nodeId, string userName, Azure.Compute.Batch.BatchNodeUserUpdateContent content, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReplaceNodeUser : string * string * string * Azure.Compute.Batch.BatchNodeUserUpdateContent * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.Response
override this.ReplaceNodeUser : string * string * string * Azure.Compute.Batch.BatchNodeUserUpdateContent * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function ReplaceNodeUser (poolId As String, nodeId As String, userName As String, content As BatchNodeUserUpdateContent, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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 update a user Account.

userName

String

The name of the user Account to update.

content

BatchNodeUserUpdateContent

The options to use for updating 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

Response

Exceptions

ArgumentNullException

poolId, nodeId, userName or content is null.

ArgumentException

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

Examples

This sample shows how to call ReplaceNodeUser.

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

BatchNodeUserUpdateContent content = new BatchNodeUserUpdateContent();
Response response = client.ReplaceNodeUser("<poolId>", "<nodeId>", "<userName>", content);

This sample shows how to call ReplaceNodeUser with all parameters.

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

BatchNodeUserUpdateContent content = new BatchNodeUserUpdateContent
{
    Password = "<password>",
    ExpiryTime = DateTimeOffset.Parse("2022-05-10T18:57:31.2311892Z"),
    SshPublicKey = "<sshPublicKey>",
};
Response response = client.ReplaceNodeUser("<poolId>", "<nodeId>", "<userName>", content, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"));

Remarks

This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state.

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

[Protocol Method] Updates the password and expiration time of a user Account on 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 ReplaceNodeUser(String, String, String, BatchNodeUserUpdateContent, Nullable<Int32>, Nullable<DateTimeOffset>, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response ReplaceNodeUser (string poolId, string nodeId, string userName, Azure.Core.RequestContent content, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, Azure.RequestContext context = default);

abstract member ReplaceNodeUser : string * string * string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestContext -> Azure.Response
override this.ReplaceNodeUser : string * string * string * Azure.Core.RequestContent * Nullable<int> * Nullable<DateTimeOffset> * Azure.RequestContext -> Azure.Response

Public Overridable Function ReplaceNodeUser (poolId As String, nodeId As String, userName 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 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 update a user Account.

userName

String

The name of the user Account to update.

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

Response

The response returned from the service.

Exceptions

ArgumentNullException

poolId, nodeId, userName or content is null.

ArgumentException

poolId, nodeId or userName 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 ReplaceNodeUser.

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 object());
Response response = client.ReplaceNodeUser("<poolId>", "<nodeId>", "<userName>", content);

Console.WriteLine(response.Status);

This sample shows how to call ReplaceNodeUser 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
{
    password = "<password>",
    expiryTime = "2022-05-10T18:57:31.2311892Z",
    sshPublicKey = "<sshPublicKey>",
});
Response response = client.ReplaceNodeUser("<poolId>", "<nodeId>", "<userName>", content, timeOutInSeconds: 1234, ocpdate: DateTimeOffset.Parse("Tue, 10 May 2022 18:57:31 GMT"));

Console.WriteLine(response.Status);