BatchClient.DeallocateNode Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| DeallocateNode(String, String, BatchNodeDeallocateOptions, Nullable<TimeSpan>, Nullable<DateTimeOffset>, CancellationToken) |
Deallocates the specified Compute Node. |
| DeallocateNode(WaitUntil, String, String, BatchNodeDeallocateOptions, Nullable<TimeSpan>, Nullable<DateTimeOffset>, CancellationToken) |
Deallocates the specified Compute Node. |
DeallocateNode(String, String, BatchNodeDeallocateOptions, Nullable<TimeSpan>, Nullable<DateTimeOffset>, CancellationToken)
- Source:
- BatchClientCustom.cs
Deallocates the specified Compute Node.
public virtual Azure.Compute.Batch.DeallocateNodeOperation DeallocateNode(string poolId, string nodeId, Azure.Compute.Batch.BatchNodeDeallocateOptions parameters = default, TimeSpan? timeOutInSeconds = default, DateTimeOffset? ocpDate = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeallocateNode : string * string * Azure.Compute.Batch.BatchNodeDeallocateOptions * Nullable<TimeSpan> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.Compute.Batch.DeallocateNodeOperation
override this.DeallocateNode : string * string * Azure.Compute.Batch.BatchNodeDeallocateOptions * Nullable<TimeSpan> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.Compute.Batch.DeallocateNodeOperationPublic Overridable Function DeallocateNode (poolId As String, nodeId As String, Optional parameters As BatchNodeDeallocateOptions = Nothing, Optional timeOutInSeconds As Nullable(Of TimeSpan) = Nothing, Optional ocpDate As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As DeallocateNodeOperationParameters
- poolId
- String
The ID of the Pool that contains the Compute Node.
- nodeId
- String
The ID of the Compute Node that you want to restart.
- parameters
- BatchNodeDeallocateOptions
The options to use for deallocating the Compute Node.
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
The DeallocateNodeOperation object to allow for polling of operation status.
Exceptions
poolId or nodeId is null.
poolId or nodeId is an empty string, and was expected to be non-empty.
Remarks
You can deallocate a Compute Node only if it is in an idle or running state.
Applies to
DeallocateNode(WaitUntil, String, String, BatchNodeDeallocateOptions, Nullable<TimeSpan>, Nullable<DateTimeOffset>, CancellationToken)
- Source:
- BatchClientCustom.cs
Deallocates the specified Compute Node.
public virtual Azure.Compute.Batch.DeallocateNodeOperation DeallocateNode(Azure.WaitUntil waitUntil, string poolId, string nodeId, Azure.Compute.Batch.BatchNodeDeallocateOptions options = default, TimeSpan? timeout = default, DateTimeOffset? ocpDate = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeallocateNode : Azure.WaitUntil * string * string * Azure.Compute.Batch.BatchNodeDeallocateOptions * Nullable<TimeSpan> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.Compute.Batch.DeallocateNodeOperation
override this.DeallocateNode : Azure.WaitUntil * string * string * Azure.Compute.Batch.BatchNodeDeallocateOptions * Nullable<TimeSpan> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.Compute.Batch.DeallocateNodeOperationPublic Overridable Function DeallocateNode (waitUntil As WaitUntil, poolId As String, nodeId As String, Optional options As BatchNodeDeallocateOptions = Nothing, Optional timeout As Nullable(Of TimeSpan) = Nothing, Optional ocpDate As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As DeallocateNodeOperationParameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation.
- poolId
- String
The ID of the Pool that contains the Compute Node.
- nodeId
- String
The ID of the Compute Node that you want to restart.
- options
- BatchNodeDeallocateOptions
The options to use for deallocating the Compute Node.
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
The DeallocateNodeOperation object to allow for polling of operation status.
Exceptions
poolId or nodeId is null.
poolId or nodeId is an empty string, and was expected to be non-empty.
Remarks
You can deallocate a Compute Node only if it is in an idle or running state.
