xml/Microsoft.Azure.Batch/PoolOperations.xml

<Type Name="PoolOperations" FullName="Microsoft.Azure.Batch.PoolOperations"> <TypeSignature Language="C#" Value="public class PoolOperations : Microsoft.Azure.Batch.IInheritedBehaviors" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PoolOperations extends System.Object implements class Microsoft.Azure.Batch.IInheritedBehaviors" /> <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.PoolOperations" /> <TypeSignature Language="VB.NET" Value="Public Class PoolOperations
Implements IInheritedBehaviors" /> <TypeSignature Language="F#" Value="type PoolOperations = class
 interface IInheritedBehaviors" /> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>14.0.0.0</AssemblyVersion> <AssemblyVersion>15.0.0.0</AssemblyVersion> <AssemblyVersion>15.1.0.0</AssemblyVersion> <AssemblyVersion>15.3.0.0</AssemblyVersion> <AssemblyVersion>15.4.0.0</AssemblyVersion> <AssemblyVersion>16.0.0.0</AssemblyVersion> <AssemblyVersion>16.1.0.0</AssemblyVersion> <AssemblyVersion>16.2.0.0</AssemblyVersion> <AssemblyVersion>16.3.0.0</AssemblyVersion> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>System.Object</BaseTypeName> </Base> <Interfaces> <Interface> <InterfaceName>Microsoft.Azure.Batch.IInheritedBehaviors</InterfaceName> </Interface> </Interfaces> <Docs> <summary> Performs pool-related operations on an Azure Batch account. </summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName="CopyNodeFileContentToStream"> <MemberSignature Language="C#" Value="public void CopyNodeFileContentToStream (string poolId, string computeNodeId, string filePath, System.IO.Stream stream, Microsoft.Azure.Batch.GetFileRequestByteRange byteRange = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CopyNodeFileContentToStream(string poolId, string computeNodeId, string filePath, class System.IO.Stream stream, class Microsoft.Azure.Batch.GetFileRequestByteRange byteRange, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.CopyNodeFileContentToStream(System.String,System.String,System.String,System.IO.Stream,Microsoft.Azure.Batch.GetFileRequestByteRange,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub CopyNodeFileContentToStream (poolId As String, computeNodeId As String, filePath As String, stream As Stream, Optional byteRange As GetFileRequestByteRange = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.CopyNodeFileContentToStream : string * string * string * System.IO.Stream * Microsoft.Azure.Batch.GetFileRequestByteRange * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.CopyNodeFileContentToStream (poolId, computeNodeId, filePath, stream, byteRange, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="filePath" Type="System.String" /> <Parameter Name="stream" Type="System.IO.Stream" /> <Parameter Name="byteRange" Type="Microsoft.Azure.Batch.GetFileRequestByteRange" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="filePath">The path of the file to retrieve.</param> <param name="stream">The stream to copy the file contents to.</param> <param name="byteRange">A byte range defining what section of the file to copy. If omitted, the entire file is downloaded.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Copies the contents of a file from the specified node to the given <see cref="T:System.IO.Stream" />. </summary> <remarks>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.CopyNodeFileContentToStreamAsync(System.String,System.String,System.String,System.IO.Stream,Microsoft.Azure.Batch.GetFileRequestByteRange,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</remarks> </Docs> </Member> <Member MemberName="CopyNodeFileContentToStreamAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task CopyNodeFileContentToStreamAsync (string poolId, string computeNodeId, string filePath, System.IO.Stream stream, Microsoft.Azure.Batch.GetFileRequestByteRange byteRange = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task CopyNodeFileContentToStreamAsync(string poolId, string computeNodeId, string filePath, class System.IO.Stream stream, class Microsoft.Azure.Batch.GetFileRequestByteRange byteRange, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.CopyNodeFileContentToStreamAsync(System.String,System.String,System.String,System.IO.Stream,Microsoft.Azure.Batch.GetFileRequestByteRange,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function CopyNodeFileContentToStreamAsync (poolId As String, computeNodeId As String, filePath As String, stream As Stream, Optional byteRange As GetFileRequestByteRange = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.CopyNodeFileContentToStreamAsync : string * string * string * System.IO.Stream * Microsoft.Azure.Batch.GetFileRequestByteRange * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.CopyNodeFileContentToStreamAsync (poolId, computeNodeId, filePath, stream, byteRange, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="filePath" Type="System.String" /> <Parameter Name="stream" Type="System.IO.Stream" /> <Parameter Name="byteRange" Type="Microsoft.Azure.Batch.GetFileRequestByteRange" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="filePath">The path of the file to retrieve.</param> <param name="stream">The stream to copy the file contents to.</param> <param name="byteRange">A byte range defining what section of the file to copy. If omitted, the entire file is downloaded.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Copies the contents of a file from the specified node to the given <see cref="T:System.IO.Stream" />. </summary> <returns>To be added.</returns> <remarks>The get file operation runs asynchronously.</remarks> </Docs> </Member> <Member MemberName="CopyNodeFileContentToString"> <MemberSignature Language="C#" Value="public string CopyNodeFileContentToString (string poolId, string computeNodeId, string filePath, System.Text.Encoding encoding = default, Microsoft.Azure.Batch.GetFileRequestByteRange byteRange = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string CopyNodeFileContentToString(string poolId, string computeNodeId, string filePath, class System.Text.Encoding encoding, class Microsoft.Azure.Batch.GetFileRequestByteRange byteRange, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.CopyNodeFileContentToString(System.String,System.String,System.String,System.Text.Encoding,Microsoft.Azure.Batch.GetFileRequestByteRange,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function CopyNodeFileContentToString (poolId As String, computeNodeId As String, filePath As String, Optional encoding As Encoding = Nothing, Optional byteRange As GetFileRequestByteRange = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As String" /> <MemberSignature Language="F#" Value="member this.CopyNodeFileContentToString : string * string * string * System.Text.Encoding * Microsoft.Azure.Batch.GetFileRequestByteRange * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> string" Usage="poolOperations.CopyNodeFileContentToString (poolId, computeNodeId, filePath, encoding, byteRange, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="filePath" Type="System.String" /> <Parameter Name="encoding" Type="System.Text.Encoding" /> <Parameter Name="byteRange" Type="Microsoft.Azure.Batch.GetFileRequestByteRange" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="filePath">The path of the file to retrieve.</param> <param name="encoding">The encoding to use. If no value or null is specified, UTF8 is used.</param> <param name="byteRange">A byte range defining what section of the file to copy. If omitted, the entire file is downloaded.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Reads the contents of a file from the specified node into a string. </summary> <returns>The contents of the file, as a string</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CopyNodeFileContentToStringAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<string> CopyNodeFileContentToStringAsync (string poolId, string computeNodeId, string filePath, System.Text.Encoding encoding = default, Microsoft.Azure.Batch.GetFileRequestByteRange byteRange = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<string> CopyNodeFileContentToStringAsync(string poolId, string computeNodeId, string filePath, class System.Text.Encoding encoding, class Microsoft.Azure.Batch.GetFileRequestByteRange byteRange, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.CopyNodeFileContentToStringAsync(System.String,System.String,System.String,System.Text.Encoding,Microsoft.Azure.Batch.GetFileRequestByteRange,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function CopyNodeFileContentToStringAsync (poolId As String, computeNodeId As String, filePath As String, Optional encoding As Encoding = Nothing, Optional byteRange As GetFileRequestByteRange = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of String)" /> <MemberSignature Language="F#" Value="member this.CopyNodeFileContentToStringAsync : string * string * string * System.Text.Encoding * Microsoft.Azure.Batch.GetFileRequestByteRange * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>" Usage="poolOperations.CopyNodeFileContentToStringAsync (poolId, computeNodeId, filePath, encoding, byteRange, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.String></ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="filePath" Type="System.String" /> <Parameter Name="encoding" Type="System.Text.Encoding" /> <Parameter Name="byteRange" Type="Microsoft.Azure.Batch.GetFileRequestByteRange" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="filePath">The path of the file to retrieve.</param> <param name="encoding">The encoding to use. If no value or null is specified, UTF8 is used.</param> <param name="byteRange">A byte range defining what section of the file to copy. If omitted, the entire file is downloaded.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Reads the contents of a file from the specified node into a string. </summary> <returns>The contents of the file, as a string</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CreateComputeNodeUser"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.ComputeNodeUser CreateComputeNodeUser (string poolId, string computeNodeId);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.ComputeNodeUser CreateComputeNodeUser(string poolId, string computeNodeId) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.CreateComputeNodeUser(System.String,System.String)" /> <MemberSignature Language="VB.NET" Value="Public Function CreateComputeNodeUser (poolId As String, computeNodeId As String) As ComputeNodeUser" /> <MemberSignature Language="F#" Value="member this.CreateComputeNodeUser : string * string -> Microsoft.Azure.Batch.ComputeNodeUser" Usage="poolOperations.CreateComputeNodeUser (poolId, computeNodeId)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.ComputeNodeUser</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node where the user account will be created.</param> <summary> Creates a <see cref="T:Microsoft.Azure.Batch.ComputeNodeUser" /> representing a new compute node user account that does not yet exist in the Batch service. </summary> <returns>An unbound <see cref="T:Microsoft.Azure.Batch.ComputeNodeUser" /> representing a new user account that has not been added to the compute node.</returns> <remarks>To add the new user, call <see cref="M:Microsoft.Azure.Batch.ComputeNodeUser.CommitAsync(Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</remarks> </Docs> </Member> <Member MemberName="CreatePool"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.CloudPool CreatePool ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.CloudPool CreatePool() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.CreatePool" /> <MemberSignature Language="VB.NET" Value="Public Function CreatePool () As CloudPool" /> <MemberSignature Language="F#" Value="member this.CreatePool : unit -> Microsoft.Azure.Batch.CloudPool" Usage="poolOperations.CreatePool " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.CloudPool</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary> Creates an instance of CloudPool that is unbound and does not have a consistency relationship to any pool in the Batch service. </summary> <returns>A <see cref="T:Microsoft.Azure.Batch.CloudPool" /> representing a new pool that has not been added to the Batch service. To add the pool to the Batch account, call <see cref="M:Microsoft.Azure.Batch.CloudPool.CommitAsync(System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CreatePool"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.CloudPool CreatePool (string poolId, string virtualMachineSize, Microsoft.Azure.Batch.VirtualMachineConfiguration virtualMachineConfiguration, int? targetDedicatedComputeNodes = default, int? targetLowPriorityComputeNodes = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.CloudPool CreatePool(string poolId, string virtualMachineSize, class Microsoft.Azure.Batch.VirtualMachineConfiguration virtualMachineConfiguration, valuetype System.Nullable`1<int32> targetDedicatedComputeNodes, valuetype System.Nullable`1<int32> targetLowPriorityComputeNodes) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.CreatePool(System.String,System.String,Microsoft.Azure.Batch.VirtualMachineConfiguration,System.Nullable{System.Int32},System.Nullable{System.Int32})" /> <MemberSignature Language="VB.NET" Value="Public Function CreatePool (poolId As String, virtualMachineSize As String, virtualMachineConfiguration As VirtualMachineConfiguration, Optional targetDedicatedComputeNodes As Nullable(Of Integer) = Nothing, Optional targetLowPriorityComputeNodes As Nullable(Of Integer) = Nothing) As CloudPool" /> <MemberSignature Language="F#" Value="member this.CreatePool : string * string * Microsoft.Azure.Batch.VirtualMachineConfiguration * Nullable<int> * Nullable<int> -> Microsoft.Azure.Batch.CloudPool" Usage="poolOperations.CreatePool (poolId, virtualMachineSize, virtualMachineConfiguration, targetDedicatedComputeNodes, targetLowPriorityComputeNodes)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.CloudPool</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="virtualMachineSize" Type="System.String" /> <Parameter Name="virtualMachineConfiguration" Type="Microsoft.Azure.Batch.VirtualMachineConfiguration" /> <Parameter Name="targetDedicatedComputeNodes" Type="System.Nullable<System.Int32>" /> <Parameter Name="targetLowPriorityComputeNodes" Type="System.Nullable<System.Int32>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="virtualMachineSize">The size of virtual machines in the pool. See https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/ for windows sizes and https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ for linux sizes. </param> <param name="virtualMachineConfiguration">The <see cref="T:Microsoft.Azure.Batch.VirtualMachineConfiguration" /> for the pool.</param> <param name="targetDedicatedComputeNodes"> The desired number of dedicated compute nodes in the pool. If <paramref name="targetDedicatedComputeNodes" /> and <paramref name="targetLowPriorityComputeNodes" /> are omitted, you must set the <see cref="P:Microsoft.Azure.Batch.CloudPool.AutoScaleEnabled" /> and <see cref="P:Microsoft.Azure.Batch.CloudPool.AutoScaleFormula" /> properties. </param> <param name="targetLowPriorityComputeNodes"> The desired number of low-priority compute nodes in the pool. If <paramref name="targetDedicatedComputeNodes" /> and <paramref name="targetLowPriorityComputeNodes" /> are omitted, you must set the <see cref="P:Microsoft.Azure.Batch.CloudPool.AutoScaleEnabled" /> and <see cref="P:Microsoft.Azure.Batch.CloudPool.AutoScaleFormula" /> properties. </param> <summary> Creates an instance of CloudPool that is unbound and does not have a consistency relationship to any pool in the Batch service. </summary> <returns>A <see cref="T:Microsoft.Azure.Batch.CloudPool" /> representing a new pool that has not been added to the Batch service. To add the pool to the Batch account, call <see cref="M:Microsoft.Azure.Batch.CloudPool.CommitAsync(System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CustomBehaviors"> <MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.BatchClientBehavior> CustomBehaviors { get; set; }" /> <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.BatchClientBehavior> CustomBehaviors" /> <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" /> <MemberSignature Language="VB.NET" Value="Public Property CustomBehaviors As IList(Of BatchClientBehavior)" /> <MemberSignature Language="F#" Value="member this.CustomBehaviors : System.Collections.Generic.IList<Microsoft.Azure.Batch.BatchClientBehavior> with get, set" Usage="Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" /> <MemberType>Property</MemberType> <Implements> <InterfaceMember>P:Microsoft.Azure.Batch.IInheritedBehaviors.CustomBehaviors</InterfaceMember> </Implements> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Batch.BatchClientBehavior></ReturnType> </ReturnValue> <Docs> <summary> Gets or sets a list of behaviors that modify or customize requests to the Batch service made via this <see cref="T:Microsoft.Azure.Batch.PoolOperations" />. </summary> <value>To be added.</value> <remarks> <para>These behaviors are inherited by child objects.</para> <para>Modifications are applied in the order of the collection. The last write wins.</para> </remarks> </Docs> </Member> <Member MemberName="DeleteComputeNodeUser"> <MemberSignature Language="C#" Value="public void DeleteComputeNodeUser (string poolId, string computeNodeId, string userName, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DeleteComputeNodeUser(string poolId, string computeNodeId, string userName, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.DeleteComputeNodeUser(System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub DeleteComputeNodeUser (poolId As String, computeNodeId As String, userName As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.DeleteComputeNodeUser : string * string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.DeleteComputeNodeUser (poolId, computeNodeId, userName, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="userName" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node from which you want to delete the user account.</param> <param name="userName">The name of the user account to be deleted.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Deletes the specified user account from the specified compute node. </summary> <remarks> <para>You can delete a user account from a compute node only when it is in the <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeState.Idle" /> or <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeState.Running" /> state.</para> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.DeleteComputeNodeUserAsync(System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</para> </remarks> </Docs> </Member> <Member MemberName="DeleteComputeNodeUserAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeleteComputeNodeUserAsync (string poolId, string computeNodeId, string userName, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeleteComputeNodeUserAsync(string poolId, string computeNodeId, string userName, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.DeleteComputeNodeUserAsync(System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function DeleteComputeNodeUserAsync (poolId As String, computeNodeId As String, userName As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.DeleteComputeNodeUserAsync : string * string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.DeleteComputeNodeUserAsync (poolId, computeNodeId, userName, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="userName" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node from which you want to delete the user account.</param> <param name="userName">The name of the user account to be deleted.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Deletes the specified user account from the specified compute node. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para>You can delete a user account from a compute node only when it is in the <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeState.Idle" /> or <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeState.Running" /> state.</para> <para>The delete operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="DeleteNodeFile"> <MemberSignature Language="C#" Value="public void DeleteNodeFile (string poolId, string computeNodeId, string filePath, bool? recursive = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DeleteNodeFile(string poolId, string computeNodeId, string filePath, valuetype System.Nullable`1<bool> recursive, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.DeleteNodeFile(System.String,System.String,System.String,System.Nullable{System.Boolean},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub DeleteNodeFile (poolId As String, computeNodeId As String, filePath As String, Optional recursive As Nullable(Of Boolean) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.DeleteNodeFile : string * string * string * Nullable<bool> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.DeleteNodeFile (poolId, computeNodeId, filePath, recursive, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="filePath" Type="System.String" /> <Parameter Name="recursive" Type="System.Nullable<System.Boolean>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="filePath">The path of the file to delete.</param> <param name="recursive"> If the file-path parameter represents a directory instead of a file, you can set the optional recursive parameter to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail. </param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Deletes the specified file from the specified compute node. </summary> <remarks>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.DeleteNodeFileAsync(System.String,System.String,System.String,System.Nullable{System.Boolean},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</remarks> </Docs> </Member> <Member MemberName="DeleteNodeFileAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeleteNodeFileAsync (string poolId, string computeNodeId, string filePath, bool? recursive = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeleteNodeFileAsync(string poolId, string computeNodeId, string filePath, valuetype System.Nullable`1<bool> recursive, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.DeleteNodeFileAsync(System.String,System.String,System.String,System.Nullable{System.Boolean},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function DeleteNodeFileAsync (poolId As String, computeNodeId As String, filePath As String, Optional recursive As Nullable(Of Boolean) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.DeleteNodeFileAsync : string * string * string * Nullable<bool> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.DeleteNodeFileAsync (poolId, computeNodeId, filePath, recursive, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="filePath" Type="System.String" /> <Parameter Name="recursive" Type="System.Nullable<System.Boolean>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="filePath">The path of the file to delete.</param> <param name="recursive"> If the file-path parameter represents a directory instead of a file, you can set the optional recursive parameter to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail. </param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Deletes the specified file from the specified compute node. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks>The delete operation runs asynchronously.</remarks> </Docs> </Member> <Member MemberName="DeletePool"> <MemberSignature Language="C#" Value="public void DeletePool (string poolId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DeletePool(string poolId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.DeletePool(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub DeletePool (poolId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.DeletePool : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.DeletePool (poolId, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool to delete.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Deletes the specified pool. </summary> <remarks> <para>The delete operation requests that the pool be deleted. The request puts the pool in the <see cref="F:Microsoft.Azure.Batch.Common.PoolState.Deleting" /> state. The Batch service will requeue any running tasks and perform the actual pool deletion without any further client action.</para> <remarks>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.DeletePoolAsync(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</remarks> </remarks> </Docs> </Member> <Member MemberName="DeletePoolAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeletePoolAsync (string poolId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeletePoolAsync(string poolId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.DeletePoolAsync(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function DeletePoolAsync (poolId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.DeletePoolAsync : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.DeletePoolAsync (poolId, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool to delete.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Deletes the specified pool. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> object that represents the asynchronous operation.</returns> <remarks> <para>The delete operation requests that the pool be deleted. The request puts the pool in the <see cref="F:Microsoft.Azure.Batch.Common.PoolState.Deleting" /> state. The Batch service will requeue any running tasks and perform the actual pool deletion without any further client action.</para> <para>The delete operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="DisableAutoScale"> <MemberSignature Language="C#" Value="public void DisableAutoScale (string poolId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DisableAutoScale(string poolId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.DisableAutoScale(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub DisableAutoScale (poolId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.DisableAutoScale : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.DisableAutoScale (poolId, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Disables automatic scaling on the specified pool. </summary> <remarks> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.DisableAutoScaleAsync(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</para> </remarks> </Docs> </Member> <Member MemberName="DisableAutoScaleAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DisableAutoScaleAsync (string poolId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DisableAutoScaleAsync(string poolId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.DisableAutoScaleAsync(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function DisableAutoScaleAsync (poolId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.DisableAutoScaleAsync : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.DisableAutoScaleAsync (poolId, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Disables automatic scaling on the specified pool. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para>The disable autoscale operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="DisableComputeNodeScheduling"> <MemberSignature Language="C#" Value="public void DisableComputeNodeScheduling (string poolId, string computeNodeId, Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption? disableComputeNodeSchedulingOption, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DisableComputeNodeScheduling(string poolId, string computeNodeId, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption> disableComputeNodeSchedulingOption, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.DisableComputeNodeScheduling(System.String,System.String,System.Nullable{Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub DisableComputeNodeScheduling (poolId As String, computeNodeId As String, disableComputeNodeSchedulingOption As Nullable(Of DisableComputeNodeSchedulingOption), Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.DisableComputeNodeScheduling : string * string * Nullable<Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.DisableComputeNodeScheduling (poolId, computeNodeId, disableComputeNodeSchedulingOption, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="disableComputeNodeSchedulingOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="disableComputeNodeSchedulingOption">Specifies what to do with currently running tasks. The default is <see cref="F:Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption.Requeue" />.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Disables task scheduling on the specified compute node. </summary> <remarks>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.DisableComputeNodeSchedulingAsync(System.String,System.String,System.Nullable{Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</remarks> </Docs> </Member> <Member MemberName="DisableComputeNodeSchedulingAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DisableComputeNodeSchedulingAsync (string poolId, string computeNodeId, Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption? disableComputeNodeSchedulingOption, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DisableComputeNodeSchedulingAsync(string poolId, string computeNodeId, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption> disableComputeNodeSchedulingOption, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.DisableComputeNodeSchedulingAsync(System.String,System.String,System.Nullable{Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function DisableComputeNodeSchedulingAsync (poolId As String, computeNodeId As String, disableComputeNodeSchedulingOption As Nullable(Of DisableComputeNodeSchedulingOption), Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.DisableComputeNodeSchedulingAsync : string * string * Nullable<Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.DisableComputeNodeSchedulingAsync (poolId, computeNodeId, disableComputeNodeSchedulingOption, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="disableComputeNodeSchedulingOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="disableComputeNodeSchedulingOption">Specifies what to do with currently running tasks. The default is <see cref="F:Microsoft.Azure.Batch.Common.DisableComputeNodeSchedulingOption.Requeue" />.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Disables task scheduling on the specified compute node. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks>This operation runs asynchronously.</remarks> </Docs> </Member> <Member MemberName="EnableAutoScale"> <MemberSignature Language="C#" Value="public void EnableAutoScale (string poolId, string autoscaleFormula = default, TimeSpan? autoscaleEvaluationInterval = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EnableAutoScale(string poolId, string autoscaleFormula, valuetype System.Nullable`1<valuetype System.TimeSpan> autoscaleEvaluationInterval, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.EnableAutoScale(System.String,System.String,System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub EnableAutoScale (poolId As String, Optional autoscaleFormula As String = Nothing, Optional autoscaleEvaluationInterval As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.EnableAutoScale : string * string * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.EnableAutoScale (poolId, autoscaleFormula, autoscaleEvaluationInterval, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="autoscaleFormula" Type="System.String" /> <Parameter Name="autoscaleEvaluationInterval" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="autoscaleFormula">The formula for the desired number of compute nodes in the pool.</param> <param name="autoscaleEvaluationInterval">The time interval at which to automatically adjust the pool size according to the AutoScale formula. The default value is 15 minutes. The minimum allowed value is 5 minutes.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Enables automatic scaling on the specified pool. </summary> <remarks> <para>The formula is checked for validity before it is applied to the pool. If the formula is not valid, an exception occurs.</para> <para>You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool.</para> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.EnableAutoScaleAsync(System.String,System.String,System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</para> </remarks> </Docs> </Member> <Member MemberName="EnableAutoScaleAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task EnableAutoScaleAsync (string poolId, string autoscaleFormula = default, TimeSpan? autoscaleEvaluationInterval = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task EnableAutoScaleAsync(string poolId, string autoscaleFormula, valuetype System.Nullable`1<valuetype System.TimeSpan> autoscaleEvaluationInterval, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.EnableAutoScaleAsync(System.String,System.String,System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function EnableAutoScaleAsync (poolId As String, Optional autoscaleFormula As String = Nothing, Optional autoscaleEvaluationInterval As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.EnableAutoScaleAsync : string * string * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.EnableAutoScaleAsync (poolId, autoscaleFormula, autoscaleEvaluationInterval, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="autoscaleFormula" Type="System.String" /> <Parameter Name="autoscaleEvaluationInterval" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="autoscaleFormula">The formula for the desired number of compute nodes in the pool.</param> <param name="autoscaleEvaluationInterval">The time interval at which to automatically adjust the pool size according to the AutoScale formula. The default value is 15 minutes. The minimum allowed value is 5 minutes.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Enables automatic scaling on the specified pool. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para>The formula is checked for validity before it is applied to the pool. If the formula is not valid, an exception occurs.</para> <para>You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool.</para> <para>The enable autoscale operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="EnableComputeNodeScheduling"> <MemberSignature Language="C#" Value="public void EnableComputeNodeScheduling (string poolId, string computeNodeId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EnableComputeNodeScheduling(string poolId, string computeNodeId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.EnableComputeNodeScheduling(System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub EnableComputeNodeScheduling (poolId As String, computeNodeId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.EnableComputeNodeScheduling : string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.EnableComputeNodeScheduling (poolId, computeNodeId, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Enables task scheduling on the specified compute node. </summary> <remarks>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.EnableComputeNodeScheduling(System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" />.</remarks> </Docs> </Member> <Member MemberName="EnableComputeNodeSchedulingAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task EnableComputeNodeSchedulingAsync (string poolId, string computeNodeId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task EnableComputeNodeSchedulingAsync(string poolId, string computeNodeId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.EnableComputeNodeSchedulingAsync(System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function EnableComputeNodeSchedulingAsync (poolId As String, computeNodeId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.EnableComputeNodeSchedulingAsync : string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.EnableComputeNodeSchedulingAsync (poolId, computeNodeId, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Enables task scheduling on the specified compute node. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks>This operation runs asynchronously.</remarks> </Docs> </Member> <Member MemberName="EvaluateAutoScale"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.AutoScaleRun EvaluateAutoScale (string poolId, string autoscaleFormula, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.AutoScaleRun EvaluateAutoScale(string poolId, string autoscaleFormula, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.EvaluateAutoScale(System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function EvaluateAutoScale (poolId As String, autoscaleFormula As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As AutoScaleRun" /> <MemberSignature Language="F#" Value="member this.EvaluateAutoScale : string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.AutoScaleRun" Usage="poolOperations.EvaluateAutoScale (poolId, autoscaleFormula, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.AutoScaleRun</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="autoscaleFormula" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="autoscaleFormula">The formula to be evaluated on the pool.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Gets the result of evaluating an automatic scaling formula on the specified pool. This is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. </summary> <returns>The result of evaluating the <paramref name="autoscaleFormula" /> on the specified pool.</returns> <remarks> <para>The formula is validated and its results calculated, but is not applied to the pool. To apply the formula to the pool, use <see cref="M:Microsoft.Azure.Batch.PoolOperations.EnableAutoScale(System.String,System.String,System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" />.</para> <para>This method does not change any state of the pool, and does not affect the <see cref="P:Microsoft.Azure.Batch.CloudPool.LastModified" /> or <see cref="P:Microsoft.Azure.Batch.CloudPool.ETag" />.</para> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.EvaluateAutoScaleAsync(System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</para> </remarks> </Docs> </Member> <Member MemberName="EvaluateAutoScaleAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Batch.AutoScaleRun> EvaluateAutoScaleAsync (string poolId, string autoscaleFormula, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Batch.AutoScaleRun> EvaluateAutoScaleAsync(string poolId, string autoscaleFormula, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.EvaluateAutoScaleAsync(System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function EvaluateAutoScaleAsync (poolId As String, autoscaleFormula As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AutoScaleRun)" /> <MemberSignature Language="F#" Value="member this.EvaluateAutoScaleAsync : string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.AutoScaleRun>" Usage="poolOperations.EvaluateAutoScaleAsync (poolId, autoscaleFormula, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Batch.AutoScaleRun></ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="autoscaleFormula" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="autoscaleFormula">The formula to be evaluated on the pool.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Gets the result of evaluating an automatic scaling formula on the specified pool. This is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. </summary> <returns>The result of evaluating the <paramref name="autoscaleFormula" /> on the specified pool.</returns> <remarks> <para>The formula is validated and its results calculated, but is not applied to the pool. To apply the formula to the pool, use <see cref="M:Microsoft.Azure.Batch.PoolOperations.EnableAutoScaleAsync(System.String,System.String,System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</para> <para>This method does not change any state of the pool, and does not affect the <see cref="P:Microsoft.Azure.Batch.CloudPool.LastModified" /> or <see cref="P:Microsoft.Azure.Batch.CloudPool.ETag" />.</para> <para>The evaluate operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="GetComputeNode"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.ComputeNode GetComputeNode (string poolId, string computeNodeId, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.ComputeNode GetComputeNode(string poolId, string computeNodeId, class Microsoft.Azure.Batch.DetailLevel detailLevel, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.GetComputeNode(System.String,System.String,Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function GetComputeNode (poolId As String, computeNodeId As String, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As ComputeNode" /> <MemberSignature Language="F#" Value="member this.GetComputeNode : string * string * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.ComputeNode" Usage="poolOperations.GetComputeNode (poolId, computeNodeId, detailLevel, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.ComputeNode</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="detailLevel" Type="Microsoft.Azure.Batch.DetailLevel" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodeId">The id of the compute node to get from the pool.</param> <param name="detailLevel">A <see cref="T:Microsoft.Azure.Batch.DetailLevel" /> used for controlling which properties are retrieved from the service.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Gets the specified compute node. </summary> <returns>A <see cref="T:Microsoft.Azure.Batch.ComputeNode" /> containing information about the specified compute node.</returns> <remarks>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.GetComputeNodeAsync(System.String,System.String,Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</remarks> </Docs> </Member> <Member MemberName="GetComputeNodeAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Batch.ComputeNode> GetComputeNodeAsync (string poolId, string computeNodeId, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Batch.ComputeNode> GetComputeNodeAsync(string poolId, string computeNodeId, class Microsoft.Azure.Batch.DetailLevel detailLevel, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.GetComputeNodeAsync(System.String,System.String,Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function GetComputeNodeAsync (poolId As String, computeNodeId As String, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ComputeNode)" /> <MemberSignature Language="F#" Value="member this.GetComputeNodeAsync : string * string * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.ComputeNode>" Usage="poolOperations.GetComputeNodeAsync (poolId, computeNodeId, detailLevel, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Batch.ComputeNode></ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="detailLevel" Type="Microsoft.Azure.Batch.DetailLevel" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodeId">The id of the compute node to get from the pool.</param> <param name="detailLevel">A <see cref="T:Microsoft.Azure.Batch.DetailLevel" /> used for controlling which properties are retrieved from the service.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" /> and <paramref name="detailLevel" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Gets the specified compute node. </summary> <returns>A <see cref="T:Microsoft.Azure.Batch.ComputeNode" /> containing information about the specified compute node.</returns> <remarks>The get node operation runs asynchronously.</remarks> </Docs> </Member> <Member MemberName="GetComputeNodeExtension"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.NodeVMExtension GetComputeNodeExtension (string poolId, string computeNodeId, string extensionName, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.NodeVMExtension GetComputeNodeExtension(string poolId, string computeNodeId, string extensionName, class Microsoft.Azure.Batch.DetailLevel detailLevel, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.GetComputeNodeExtension(System.String,System.String,System.String,Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function GetComputeNodeExtension (poolId As String, computeNodeId As String, extensionName As String, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As NodeVMExtension" /> <MemberSignature Language="F#" Value="member this.GetComputeNodeExtension : string * string * string * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.NodeVMExtension" Usage="poolOperations.GetComputeNodeExtension (poolId, computeNodeId, extensionName, detailLevel, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.NodeVMExtension</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="extensionName" Type="System.String" /> <Parameter Name="detailLevel" Type="Microsoft.Azure.Batch.DetailLevel" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodeId">The id of the compute node to get from the pool.</param> <param name="extensionName">The name of the extension to get from the pool.</param> <param name="detailLevel">A <see cref="T:Microsoft.Azure.Batch.DetailLevel" /> used for controlling which properties are retrieved from the service.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Gets the specified compute node. </summary> <returns>A <see cref="T:Microsoft.Azure.Batch.NodeVMExtension" /> containing information about the specified compute node extension.</returns> <remarks>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.GetComputeNodeExtensionAsync(System.String,System.String,System.String,Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</remarks> </Docs> </Member> <Member MemberName="GetComputeNodeExtensionAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Batch.NodeVMExtension> GetComputeNodeExtensionAsync (string poolId, string computeNodeId, string extensionName, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Batch.NodeVMExtension> GetComputeNodeExtensionAsync(string poolId, string computeNodeId, string extensionName, class Microsoft.Azure.Batch.DetailLevel detailLevel, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.GetComputeNodeExtensionAsync(System.String,System.String,System.String,Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function GetComputeNodeExtensionAsync (poolId As String, computeNodeId As String, extensionName As String, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NodeVMExtension)" /> <MemberSignature Language="F#" Value="member this.GetComputeNodeExtensionAsync : string * string * string * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.NodeVMExtension>" Usage="poolOperations.GetComputeNodeExtensionAsync (poolId, computeNodeId, extensionName, detailLevel, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Batch.NodeVMExtension></ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="extensionName" Type="System.String" /> <Parameter Name="detailLevel" Type="Microsoft.Azure.Batch.DetailLevel" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodeId">The id of the compute node that has the extension.</param> <param name="extensionName">The name of the extension to get from the pool.</param> <param name="detailLevel">A <see cref="T:Microsoft.Azure.Batch.DetailLevel" /> used for controlling which properties are retrieved from the service.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" /> and <paramref name="detailLevel" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Gets the specified compute node extension. </summary> <returns>A <see cref="T:Microsoft.Azure.Batch.NodeVMExtension" /> containing information about the specified compute node extension.</returns> <remarks>The get node extension operation runs asynchronously.</remarks> </Docs> </Member> <Member MemberName="GetNodeFile"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.NodeFile GetNodeFile (string poolId, string computeNodeId, string filePath, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.NodeFile GetNodeFile(string poolId, string computeNodeId, string filePath, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.GetNodeFile(System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function GetNodeFile (poolId As String, computeNodeId As String, filePath As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As NodeFile" /> <MemberSignature Language="F#" Value="member this.GetNodeFile : string * string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.NodeFile" Usage="poolOperations.GetNodeFile (poolId, computeNodeId, filePath, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.NodeFile</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="filePath" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="filePath">The path of the file to retrieve.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Gets information about a file on a compute node. </summary> <returns>A <see cref="T:Microsoft.Azure.Batch.NodeFile" /> containing information about the file, and which can be used to download the file (see <see cref="M:Microsoft.Azure.Batch.NodeFile.CopyToStream(System.IO.Stream,Microsoft.Azure.Batch.GetFileRequestByteRange,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" />).</returns> <remarks>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.GetNodeFileAsync(System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</remarks> </Docs> </Member> <Member MemberName="GetNodeFileAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Batch.NodeFile> GetNodeFileAsync (string poolId, string computeNodeId, string filePath, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Batch.NodeFile> GetNodeFileAsync(string poolId, string computeNodeId, string filePath, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.GetNodeFileAsync(System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function GetNodeFileAsync (poolId As String, computeNodeId As String, filePath As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NodeFile)" /> <MemberSignature Language="F#" Value="member this.GetNodeFileAsync : string * string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.NodeFile>" Usage="poolOperations.GetNodeFileAsync (poolId, computeNodeId, filePath, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Batch.NodeFile></ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="filePath" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="filePath">The path of the file to retrieve.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Gets information about a file on a compute node. </summary> <returns>A <see cref="T:Microsoft.Azure.Batch.NodeFile" /> containing information about the file, and which can be used to download the file (see <see cref="M:Microsoft.Azure.Batch.NodeFile.CopyToStreamAsync(System.IO.Stream,Microsoft.Azure.Batch.GetFileRequestByteRange,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />).</returns> <remarks>The get file operation runs asynchronously.</remarks> </Docs> </Member> <Member MemberName="GetPool"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.CloudPool GetPool (string poolId, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.CloudPool GetPool(string poolId, class Microsoft.Azure.Batch.DetailLevel detailLevel, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.GetPool(System.String,Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function GetPool (poolId As String, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As CloudPool" /> <MemberSignature Language="F#" Value="member this.GetPool : string * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.CloudPool" Usage="poolOperations.GetPool (poolId, detailLevel, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.CloudPool</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="detailLevel" Type="Microsoft.Azure.Batch.DetailLevel" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool to get.</param> <param name="detailLevel">A <see cref="T:Microsoft.Azure.Batch.DetailLevel" /> used for controlling which properties are retrieved from the service.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" /> and <paramref name="detailLevel" />.</param> <summary> Gets the specified <see cref="T:Microsoft.Azure.Batch.CloudPool" />. </summary> <returns>A <see cref="T:Microsoft.Azure.Batch.CloudPool" /> containing information about the specified Azure Batch pool.</returns> <remarks>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.GetPoolAsync(System.String,Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</remarks> </Docs> </Member> <Member MemberName="GetPoolAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Batch.CloudPool> GetPoolAsync (string poolId, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Batch.CloudPool> GetPoolAsync(string poolId, class Microsoft.Azure.Batch.DetailLevel detailLevel, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.GetPoolAsync(System.String,Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function GetPoolAsync (poolId As String, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CloudPool)" /> <MemberSignature Language="F#" Value="member this.GetPoolAsync : string * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.CloudPool>" Usage="poolOperations.GetPoolAsync (poolId, detailLevel, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Batch.CloudPool></ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="detailLevel" Type="Microsoft.Azure.Batch.DetailLevel" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool to get.</param> <param name="detailLevel">A <see cref="T:Microsoft.Azure.Batch.DetailLevel" /> used for controlling which properties are retrieved from the service.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" /> and <paramref name="detailLevel" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Gets the specified <see cref="T:Microsoft.Azure.Batch.CloudPool" />. </summary> <returns>A <see cref="T:Microsoft.Azure.Batch.CloudPool" /> containing information about the specified Azure Batch pool.</returns> <remarks>The get pool operation runs asynchronously.</remarks> </Docs> </Member> <Member MemberName="GetRemoteLoginSettings"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.RemoteLoginSettings GetRemoteLoginSettings (string poolId, string computeNodeId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.RemoteLoginSettings GetRemoteLoginSettings(string poolId, string computeNodeId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.GetRemoteLoginSettings(System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function GetRemoteLoginSettings (poolId As String, computeNodeId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As RemoteLoginSettings" /> <MemberSignature Language="F#" Value="member this.GetRemoteLoginSettings : string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.RemoteLoginSettings" Usage="poolOperations.GetRemoteLoginSettings (poolId, computeNodeId, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.RemoteLoginSettings</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node for which to get a Remote Desktop file.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Gets the settings required for remote login to a compute node. </summary> <returns>To be added.</returns> <remarks> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.GetRemoteLoginSettingsAsync(System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</para> <para>This method can be invoked only if the pool is created with a <see cref="T:Microsoft.Azure.Batch.VirtualMachineConfiguration" /> property.</para> </remarks> </Docs> </Member> <Member MemberName="GetRemoteLoginSettingsAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Batch.RemoteLoginSettings> GetRemoteLoginSettingsAsync (string poolId, string computeNodeId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Batch.RemoteLoginSettings> GetRemoteLoginSettingsAsync(string poolId, string computeNodeId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.GetRemoteLoginSettingsAsync(System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function GetRemoteLoginSettingsAsync (poolId As String, computeNodeId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RemoteLoginSettings)" /> <MemberSignature Language="F#" Value="member this.GetRemoteLoginSettingsAsync : string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.RemoteLoginSettings>" Usage="poolOperations.GetRemoteLoginSettingsAsync (poolId, computeNodeId, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Batch.RemoteLoginSettings></ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node for which to get a Remote Desktop file.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Gets the settings required for remote login to a compute node. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para>The get remote login settings operation runs asynchronously.</para> <para>This method can be invoked only if the pool is created with a <see cref="T:Microsoft.Azure.Batch.VirtualMachineConfiguration" /> property.</para> </remarks> </Docs> </Member> <Member MemberName="ListComputeNodeExtensions"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.NodeVMExtension> ListComputeNodeExtensions (string poolId, string nodeId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.IPagedEnumerable`1<class Microsoft.Azure.Batch.NodeVMExtension> ListComputeNodeExtensions(string poolId, string nodeId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.ListComputeNodeExtensions(System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function ListComputeNodeExtensions (poolId As String, nodeId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As IPagedEnumerable(Of NodeVMExtension)" /> <MemberSignature Language="F#" Value="member this.ListComputeNodeExtensions : string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.NodeVMExtension>" Usage="poolOperations.ListComputeNodeExtensions (poolId, nodeId, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.NodeVMExtension></ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="nodeId" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The Id of the <see cref="T:Microsoft.Azure.Batch.CloudPool">pool</see> to which the <see cref="T:Microsoft.Azure.Batch.NodeVMExtension">extension</see> belongs.</param> <param name="nodeId">The Id of the <see cref="T:Microsoft.Azure.Batch.ComputeNode" /> of the returned extensions.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Enumerates the <see cref="T:Microsoft.Azure.Batch.NodeVMExtension">extensions</see> of the specified <see cref="T:Microsoft.Azure.Batch.ComputeNode" />. </summary> <returns>An <see cref="T:Microsoft.Azure.Batch.IPagedEnumerable`1" /> that can be used to enumerate certificates asynchronously or synchronously.</returns> <remarks>This method returns immediately; the certificates are retrieved from the Batch service only when the collection is enumerated. Retrieval is non-atomic; certificates are retrieved in pages during enumeration of the collection.</remarks> </Docs> </Member> <Member MemberName="ListComputeNodes"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.ComputeNode> ListComputeNodes (string poolId, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.IPagedEnumerable`1<class Microsoft.Azure.Batch.ComputeNode> ListComputeNodes(string poolId, class Microsoft.Azure.Batch.DetailLevel detailLevel, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.ListComputeNodes(System.String,Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function ListComputeNodes (poolId As String, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As IPagedEnumerable(Of ComputeNode)" /> <MemberSignature Language="F#" Value="member this.ListComputeNodes : string * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.ComputeNode>" Usage="poolOperations.ListComputeNodes (poolId, detailLevel, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.ComputeNode></ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="detailLevel" Type="Microsoft.Azure.Batch.DetailLevel" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="detailLevel">A <see cref="T:Microsoft.Azure.Batch.DetailLevel" /> used for filtering the list and for controlling which properties are retrieved from the service.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" /> and <paramref name="detailLevel" />.</param> <summary> Enumerates the <see cref="T:Microsoft.Azure.Batch.ComputeNode">compute nodes</see> of the specified pool. </summary> <returns>An <see cref="T:Microsoft.Azure.Batch.IPagedEnumerable`1" /> that can be used to enumerate compute nodes asynchronously or synchronously.</returns> <remarks>This method returns immediately; the nodes are retrieved from the Batch service only when the collection is enumerated. Retrieval is non-atomic; nodes are retrieved in pages during enumeration of the collection.</remarks> </Docs> </Member> <Member MemberName="ListNodeFiles"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.NodeFile> ListNodeFiles (string poolId, string computeNodeId, bool? recursive = default, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.IPagedEnumerable`1<class Microsoft.Azure.Batch.NodeFile> ListNodeFiles(string poolId, string computeNodeId, valuetype System.Nullable`1<bool> recursive, class Microsoft.Azure.Batch.DetailLevel detailLevel, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.ListNodeFiles(System.String,System.String,System.Nullable{System.Boolean},Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function ListNodeFiles (poolId As String, computeNodeId As String, Optional recursive As Nullable(Of Boolean) = Nothing, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As IPagedEnumerable(Of NodeFile)" /> <MemberSignature Language="F#" Value="member this.ListNodeFiles : string * string * Nullable<bool> * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.NodeFile>" Usage="poolOperations.ListNodeFiles (poolId, computeNodeId, recursive, detailLevel, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.NodeFile></ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="recursive" Type="System.Nullable<System.Boolean>" /> <Parameter Name="detailLevel" Type="Microsoft.Azure.Batch.DetailLevel" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="recursive">If true, recursively enumerates all files on the compute node. If false, enumerates only the files in the compute node root directory.</param> <param name="detailLevel">A <see cref="T:Microsoft.Azure.Batch.DetailLevel" /> used for filtering the list and for controlling which properties are retrieved from the service.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" /> and <paramref name="detailLevel" />.</param> <summary> Enumerates files on the specified compute node. </summary> <returns>An <see cref="T:Microsoft.Azure.Batch.IPagedEnumerable`1" /> that can be used to enumerate files asynchronously or synchronously.</returns> <remarks>This method returns immediately; the file data is retrieved from the Batch service only when the collection is enumerated. Retrieval is non-atomic; file data is retrieved in pages during enumeration of the collection.</remarks> </Docs> </Member> <Member MemberName="ListPoolNodeCounts"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.PoolNodeCounts> ListPoolNodeCounts (Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.IPagedEnumerable`1<class Microsoft.Azure.Batch.PoolNodeCounts> ListPoolNodeCounts(class Microsoft.Azure.Batch.DetailLevel detailLevel, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.ListPoolNodeCounts(Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function ListPoolNodeCounts (Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As IPagedEnumerable(Of PoolNodeCounts)" /> <MemberSignature Language="F#" Value="member this.ListPoolNodeCounts : Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.PoolNodeCounts>" Usage="poolOperations.ListPoolNodeCounts (detailLevel, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.PoolNodeCounts></ReturnType> </ReturnValue> <Parameters> <Parameter Name="detailLevel" Type="Microsoft.Azure.Batch.DetailLevel" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="detailLevel">A <see cref="T:Microsoft.Azure.Batch.DetailLevel" /> used for filtering the list and for controlling which properties are retrieved from the service.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" /> and <paramref name="detailLevel" />.</param> <summary> Lists the number of nodes in each state, grouped by pool. </summary> <returns>An <see cref="T:Microsoft.Azure.Batch.IPagedEnumerable`1" /> that can be used to enumerate pool node count details asynchronously or synchronously.</returns> <remarks>This method returns immediately; the pool counts are retrieved from the Batch service only when the collection is enumerated. Retrieval is non-atomic; pool counts are retrieved in pages during enumeration of the collection.</remarks> </Docs> </Member> <Member MemberName="ListPools"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.CloudPool> ListPools (Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.IPagedEnumerable`1<class Microsoft.Azure.Batch.CloudPool> ListPools(class Microsoft.Azure.Batch.DetailLevel detailLevel, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.ListPools(Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function ListPools (Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As IPagedEnumerable(Of CloudPool)" /> <MemberSignature Language="F#" Value="member this.ListPools : Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.CloudPool>" Usage="poolOperations.ListPools (detailLevel, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.CloudPool></ReturnType> </ReturnValue> <Parameters> <Parameter Name="detailLevel" Type="Microsoft.Azure.Batch.DetailLevel" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="detailLevel">A <see cref="T:Microsoft.Azure.Batch.DetailLevel" /> used for filtering the list and for controlling which properties are retrieved from the service.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" /> and <paramref name="detailLevel" />.</param> <summary> Enumerates the <see cref="T:Microsoft.Azure.Batch.CloudPool">pools</see> in the Batch account. </summary> <returns>An <see cref="T:Microsoft.Azure.Batch.IPagedEnumerable`1" /> that can be used to enumerate pools asynchronously or synchronously.</returns> <remarks>This method returns immediately; the pools are retrieved from the Batch service only when the collection is enumerated. Retrieval is non-atomic; pools are retrieved in pages during enumeration of the collection.</remarks> </Docs> </Member> <Member MemberName="ListPoolUsageMetrics"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.PoolUsageMetrics> ListPoolUsageMetrics (DateTime? startTime = default, DateTime? endTime = default, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.IPagedEnumerable`1<class Microsoft.Azure.Batch.PoolUsageMetrics> ListPoolUsageMetrics(valuetype System.Nullable`1<valuetype System.DateTime> startTime, valuetype System.Nullable`1<valuetype System.DateTime> endTime, class Microsoft.Azure.Batch.DetailLevel detailLevel, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.ListPoolUsageMetrics(System.Nullable{System.DateTime},System.Nullable{System.DateTime},Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function ListPoolUsageMetrics (Optional startTime As Nullable(Of DateTime) = Nothing, Optional endTime As Nullable(Of DateTime) = Nothing, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As IPagedEnumerable(Of PoolUsageMetrics)" /> <MemberSignature Language="F#" Value="member this.ListPoolUsageMetrics : Nullable<DateTime> * Nullable<DateTime> * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.PoolUsageMetrics>" Usage="poolOperations.ListPoolUsageMetrics (startTime, endTime, detailLevel, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.PoolUsageMetrics></ReturnType> </ReturnValue> <Parameters> <Parameter Name="startTime" Type="System.Nullable<System.DateTime>" /> <Parameter Name="endTime" Type="System.Nullable<System.DateTime>" /> <Parameter Name="detailLevel" Type="Microsoft.Azure.Batch.DetailLevel" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="startTime">The start time of the aggregation interval covered by this entry.</param> <param name="endTime">The end time of the aggregation interval for this entry.</param> <param name="detailLevel">A <see cref="T:Microsoft.Azure.Batch.DetailLevel" /> used for filtering the list and for controlling which properties are retrieved from the service.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" /> and <paramref name="detailLevel" />.</param> <summary> Enumerates pool usage metrics. </summary> <returns>An <see cref="T:Microsoft.Azure.Batch.IPagedEnumerable`1" /> that can be used to enumerate metrics asynchronously or synchronously.</returns> <remarks>This method returns immediately; the metrics data is retrieved from the Batch service only when the collection is enumerated. Retrieval is non-atomic; metrics data is retrieved in pages during enumeration of the collection.</remarks> </Docs> </Member> <Member MemberName="ListSupportedImages"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.ImageInformation> ListSupportedImages (Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.IPagedEnumerable`1<class Microsoft.Azure.Batch.ImageInformation> ListSupportedImages(class Microsoft.Azure.Batch.DetailLevel detailLevel, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.ListSupportedImages(Microsoft.Azure.Batch.DetailLevel,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function ListSupportedImages (Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As IPagedEnumerable(Of ImageInformation)" /> <MemberSignature Language="F#" Value="member this.ListSupportedImages : Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.ImageInformation>" Usage="poolOperations.ListSupportedImages (detailLevel, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.ImageInformation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="detailLevel" Type="Microsoft.Azure.Batch.DetailLevel" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="detailLevel">A <see cref="T:Microsoft.Azure.Batch.DetailLevel" /> used for filtering the list and for controlling which properties are retrieved from the service.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" /> and <paramref name="detailLevel" />.</param> <summary> Enumerates the node agent Sku values supported by Batch Service. </summary> <returns>An <see cref="T:Microsoft.Azure.Batch.IPagedEnumerable`1" /> that can be used to enumerate node agent sku values asynchronously or synchronously.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Reboot"> <MemberSignature Language="C#" Value="public void Reboot (string poolId, string computeNodeId, Microsoft.Azure.Batch.Common.ComputeNodeRebootOption? rebootOption = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Reboot(string poolId, string computeNodeId, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeRebootOption> rebootOption, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.Reboot(System.String,System.String,System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeRebootOption},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub Reboot (poolId As String, computeNodeId As String, Optional rebootOption As Nullable(Of ComputeNodeRebootOption) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.Reboot : string * string * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeRebootOption> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.Reboot (poolId, computeNodeId, rebootOption, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="rebootOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeRebootOption>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node to reboot.</param> <param name="rebootOption">Specifies when to reboot the node and what to do with currently running tasks. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeRebootOption.Requeue" />.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Reboots the specified compute node. </summary> <remarks> <para>You can reboot a compute node only when it is in the <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeState.Idle" /> or <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeState.Running" /> state.</para> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.RebootAsync(System.String,System.String,System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeRebootOption},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</para> </remarks> </Docs> </Member> <Member MemberName="RebootAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RebootAsync (string poolId, string computeNodeId, Microsoft.Azure.Batch.Common.ComputeNodeRebootOption? rebootOption = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task RebootAsync(string poolId, string computeNodeId, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeRebootOption> rebootOption, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.RebootAsync(System.String,System.String,System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeRebootOption},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function RebootAsync (poolId As String, computeNodeId As String, Optional rebootOption As Nullable(Of ComputeNodeRebootOption) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.RebootAsync : string * string * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeRebootOption> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.RebootAsync (poolId, computeNodeId, rebootOption, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="rebootOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeRebootOption>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node to reboot.</param> <param name="rebootOption">Specifies when to reboot the node and what to do with currently running tasks. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeRebootOption.Requeue" />.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Reboots the specified compute node. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para>You can reboot a compute node only when it is in the <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeState.Idle" /> or <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeState.Running" /> state.</para> <para>The reboot operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="Reimage"> <MemberSignature Language="C#" Value="public void Reimage (string poolId, string computeNodeId, Microsoft.Azure.Batch.Common.ComputeNodeReimageOption? reimageOption = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Reimage(string poolId, string computeNodeId, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeReimageOption> reimageOption, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.Reimage(System.String,System.String,System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeReimageOption},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub Reimage (poolId As String, computeNodeId As String, Optional reimageOption As Nullable(Of ComputeNodeReimageOption) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.Reimage : string * string * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeReimageOption> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.Reimage (poolId, computeNodeId, reimageOption, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="reimageOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeReimageOption>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node to reimage.</param> <param name="reimageOption">Specifies when to reimage the node and what to do with currently running tasks. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeReimageOption.Requeue" />.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Reinstalls the operating system on the specified compute node. </summary> <remarks> <para>You can reimage a compute node only when it is in the <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeState.Idle" /> or <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeState.Running" /> state.</para> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.ReimageAsync(System.String,System.String,System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeReimageOption},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</para> </remarks> </Docs> </Member> <Member MemberName="ReimageAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ReimageAsync (string poolId, string computeNodeId, Microsoft.Azure.Batch.Common.ComputeNodeReimageOption? reimageOption = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task ReimageAsync(string poolId, string computeNodeId, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeReimageOption> reimageOption, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.ReimageAsync(System.String,System.String,System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeReimageOption},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function ReimageAsync (poolId As String, computeNodeId As String, Optional reimageOption As Nullable(Of ComputeNodeReimageOption) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.ReimageAsync : string * string * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeReimageOption> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.ReimageAsync (poolId, computeNodeId, reimageOption, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="reimageOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeReimageOption>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node to reimage.</param> <param name="reimageOption">Specifies when to reimage the node and what to do with currently running tasks. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeReimageOption.Requeue" />.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Reinstalls the operating system on the specified compute node. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para>You can reimage a compute node only when it is in the <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeState.Idle" /> or <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeState.Running" /> state.</para> <para>The reimage operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="RemoveFromPool"> <MemberSignature Language="C#" Value="public void RemoveFromPool (string poolId, Microsoft.Azure.Batch.ComputeNode computeNode, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveFromPool(string poolId, class Microsoft.Azure.Batch.ComputeNode computeNode, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> deallocationOption, valuetype System.Nullable`1<valuetype System.TimeSpan> resizeTimeout, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPool(System.String,Microsoft.Azure.Batch.ComputeNode,System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub RemoveFromPool (poolId As String, computeNode As ComputeNode, Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.RemoveFromPool : string * Microsoft.Azure.Batch.ComputeNode * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.RemoveFromPool (poolId, computeNode, deallocationOption, resizeTimeout, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNode" Type="Microsoft.Azure.Batch.ComputeNode" /> <Parameter Name="deallocationOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption>" /> <Parameter Name="resizeTimeout" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNode">The <see cref="T:Microsoft.Azure.Batch.ComputeNode" /> to remove from the pool.</param> <param name="deallocationOption"> Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption.Requeue" />. </param> <param name="resizeTimeout">Specifies the timeout for removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Removes the specified compute node from the specified pool. </summary> <remarks> <para>If you need to remove multiple compute nodes from a pool, it is more efficient to use the <see cref="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPool(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.ComputeNode},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> overload.</para> <para>You can only remove nodes from a pool when the <see cref="P:Microsoft.Azure.Batch.CloudPool.AllocationState" /> of the pool is <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" />. If the pool is already resizing, an exception occurs.</para> <para>When you remove nodes from a pool, the pool's AllocationState changes from Steady to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Resizing" />.</para> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPoolAsync(System.String,Microsoft.Azure.Batch.ComputeNode,System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" />.</para> </remarks> </Docs> </Member> <Member MemberName="RemoveFromPool"> <MemberSignature Language="C#" Value="public void RemoveFromPool (string poolId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.ComputeNode> computeNodes, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveFromPool(string poolId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.ComputeNode> computeNodes, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> deallocationOption, valuetype System.Nullable`1<valuetype System.TimeSpan> resizeTimeout, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPool(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.ComputeNode},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub RemoveFromPool (poolId As String, computeNodes As IEnumerable(Of ComputeNode), Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.RemoveFromPool : string * seq<Microsoft.Azure.Batch.ComputeNode> * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.RemoveFromPool (poolId, computeNodes, deallocationOption, resizeTimeout, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodes" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.ComputeNode>" /> <Parameter Name="deallocationOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption>" /> <Parameter Name="resizeTimeout" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodes">The <see cref="T:Microsoft.Azure.Batch.ComputeNode">compute nodes</see> to remove from the pool.</param> <param name="deallocationOption"> Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption.Requeue" />. </param> <param name="resizeTimeout">Specifies the timeout for removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Removes the specified compute nodes from the specified pool. </summary> <remarks> <para>You can only remove nodes from a pool when the <see cref="P:Microsoft.Azure.Batch.CloudPool.AllocationState" /> of the pool is <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" />. If the pool is already resizing, an exception occurs.</para> <para>When you remove nodes from a pool, the pool's AllocationState changes from Steady to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Resizing" />.</para> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPoolAsync(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.ComputeNode},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</para> </remarks> </Docs> </Member> <Member MemberName="RemoveFromPool"> <MemberSignature Language="C#" Value="public void RemoveFromPool (string poolId, System.Collections.Generic.IEnumerable<string> computeNodeIds, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveFromPool(string poolId, class System.Collections.Generic.IEnumerable`1<string> computeNodeIds, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> deallocationOption, valuetype System.Nullable`1<valuetype System.TimeSpan> resizeTimeout, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPool(System.String,System.Collections.Generic.IEnumerable{System.String},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub RemoveFromPool (poolId As String, computeNodeIds As IEnumerable(Of String), Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.RemoveFromPool : string * seq<string> * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.RemoveFromPool (poolId, computeNodeIds, deallocationOption, resizeTimeout, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeIds" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="deallocationOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption>" /> <Parameter Name="resizeTimeout" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodeIds">The ids of the compute nodes to remove from the pool.</param> <param name="deallocationOption"> Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption.Requeue" />. </param> <param name="resizeTimeout">Specifies the timeout for removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Removes the specified compute nodes from the specified pool. </summary> <remarks> <para>You can only remove nodes from a pool when the <see cref="P:Microsoft.Azure.Batch.CloudPool.AllocationState" /> of the pool is <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" />. If the pool is already resizing, an exception occurs.</para> <para>When you remove nodes from a pool, the pool's AllocationState changes from Steady to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Resizing" />.</para> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPoolAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</para> </remarks> </Docs> </Member> <Member MemberName="RemoveFromPool"> <MemberSignature Language="C#" Value="public void RemoveFromPool (string poolId, string computeNodeId, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveFromPool(string poolId, string computeNodeId, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> deallocationOption, valuetype System.Nullable`1<valuetype System.TimeSpan> resizeTimeout, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPool(System.String,System.String,System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub RemoveFromPool (poolId As String, computeNodeId As String, Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.RemoveFromPool : string * string * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.RemoveFromPool (poolId, computeNodeId, deallocationOption, resizeTimeout, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="deallocationOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption>" /> <Parameter Name="resizeTimeout" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodeId">The id of the compute node to remove from the pool.</param> <param name="deallocationOption"> Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption.Requeue" />. </param> <param name="resizeTimeout">Specifies the timeout for removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Removes the specified compute node from the specified pool. </summary> <remarks> <para>If you need to remove multiple compute nodes from a pool, it is more efficient to use the <see cref="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPool(System.String,System.Collections.Generic.IEnumerable{System.String},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> overload.</para> <para>You can only remove nodes from a pool when the <see cref="P:Microsoft.Azure.Batch.CloudPool.AllocationState" /> of the pool is <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" />. If the pool is already resizing, an exception occurs.</para> <para>When you remove nodes from a pool, the pool's AllocationState changes from Steady to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Resizing" />.</para> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPoolAsync(System.String,System.String,System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" />.</para> </remarks> </Docs> </Member> <Member MemberName="RemoveFromPoolAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RemoveFromPoolAsync (string poolId, Microsoft.Azure.Batch.ComputeNode computeNode, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task RemoveFromPoolAsync(string poolId, class Microsoft.Azure.Batch.ComputeNode computeNode, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> deallocationOption, valuetype System.Nullable`1<valuetype System.TimeSpan> resizeTimeout, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPoolAsync(System.String,Microsoft.Azure.Batch.ComputeNode,System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function RemoveFromPoolAsync (poolId As String, computeNode As ComputeNode, Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.RemoveFromPoolAsync : string * Microsoft.Azure.Batch.ComputeNode * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> System.Threading.Tasks.Task" Usage="poolOperations.RemoveFromPoolAsync (poolId, computeNode, deallocationOption, resizeTimeout, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNode" Type="Microsoft.Azure.Batch.ComputeNode" /> <Parameter Name="deallocationOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption>" /> <Parameter Name="resizeTimeout" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNode">The <see cref="T:Microsoft.Azure.Batch.ComputeNode" /> to remove from the pool.</param> <param name="deallocationOption"> Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption.Requeue" />. </param> <param name="resizeTimeout">Specifies the timeout for removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Removes the specified compute node from the specified pool. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para>If you need to remove multiple compute nodes from a pool, it is more efficient to use the <see cref="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPoolAsync(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.ComputeNode},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> overload.</para> <para>You can only remove nodes from a pool when the <see cref="P:Microsoft.Azure.Batch.CloudPool.AllocationState" /> of the pool is <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" />. If the pool is already resizing, an exception occurs.</para> <para>When you remove nodes from a pool, the pool's AllocationState changes from Steady to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Resizing" />.</para> <para>The remove operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="RemoveFromPoolAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RemoveFromPoolAsync (string poolId, string computeNodeId, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task RemoveFromPoolAsync(string poolId, string computeNodeId, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> deallocationOption, valuetype System.Nullable`1<valuetype System.TimeSpan> resizeTimeout, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPoolAsync(System.String,System.String,System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function RemoveFromPoolAsync (poolId As String, computeNodeId As String, Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.RemoveFromPoolAsync : string * string * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> System.Threading.Tasks.Task" Usage="poolOperations.RemoveFromPoolAsync (poolId, computeNodeId, deallocationOption, resizeTimeout, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="deallocationOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption>" /> <Parameter Name="resizeTimeout" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodeId">The id of the compute node to remove from the pool.</param> <param name="deallocationOption"> Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption.Requeue" />. </param> <param name="resizeTimeout">Specifies the timeout for removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Removes the specified compute node from the specified pool. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para>If you need to remove multiple compute nodes from a pool, it is more efficient to use the <see cref="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPoolAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> overload.</para> <para>You can only remove nodes from a pool when the <see cref="P:Microsoft.Azure.Batch.CloudPool.AllocationState" /> of the pool is <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" />. If the pool is already resizing, an exception occurs.</para> <para>When you remove nodes from a pool, the pool's AllocationState changes from Steady to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Resizing" />.</para> <para>The remove operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="RemoveFromPoolAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RemoveFromPoolAsync (string poolId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.ComputeNode> computeNodes, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task RemoveFromPoolAsync(string poolId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.ComputeNode> computeNodes, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> deallocationOption, valuetype System.Nullable`1<valuetype System.TimeSpan> resizeTimeout, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPoolAsync(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.ComputeNode},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function RemoveFromPoolAsync (poolId As String, computeNodes As IEnumerable(Of ComputeNode), Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.RemoveFromPoolAsync : string * seq<Microsoft.Azure.Batch.ComputeNode> * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.RemoveFromPoolAsync (poolId, computeNodes, deallocationOption, resizeTimeout, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodes" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.ComputeNode>" /> <Parameter Name="deallocationOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption>" /> <Parameter Name="resizeTimeout" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodes">The <see cref="T:Microsoft.Azure.Batch.ComputeNode">compute nodes</see> to remove from the pool.</param> <param name="deallocationOption"> Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption.Requeue" />. </param> <param name="resizeTimeout">Specifies the timeout for removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Removes the specified compute nodes from the specified pool. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para>You can only remove nodes from a pool when the <see cref="P:Microsoft.Azure.Batch.CloudPool.AllocationState" /> of the pool is <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" />. If the pool is already resizing, an exception occurs.</para> <para>When you remove nodes from a pool, the pool's AllocationState changes from Steady to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Resizing" />.</para> <para>The remove operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="RemoveFromPoolAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RemoveFromPoolAsync (string poolId, System.Collections.Generic.IEnumerable<string> computeNodeIds, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, TimeSpan? resizeTimeout = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task RemoveFromPoolAsync(string poolId, class System.Collections.Generic.IEnumerable`1<string> computeNodeIds, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> deallocationOption, valuetype System.Nullable`1<valuetype System.TimeSpan> resizeTimeout, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPoolAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function RemoveFromPoolAsync (poolId As String, computeNodeIds As IEnumerable(Of String), Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.RemoveFromPoolAsync : string * seq<string> * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.RemoveFromPoolAsync (poolId, computeNodeIds, deallocationOption, resizeTimeout, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeIds" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="deallocationOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption>" /> <Parameter Name="resizeTimeout" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="computeNodeIds">The ids of the compute nodes to remove from the pool.</param> <param name="deallocationOption"> Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption.Requeue" />. </param> <param name="resizeTimeout">Specifies the timeout for removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Removes the specified compute nodes from the specified pool. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para>You can only remove nodes from a pool when the <see cref="P:Microsoft.Azure.Batch.CloudPool.AllocationState" /> of the pool is <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" />. If the pool is already resizing, an exception occurs.</para> <para>When you remove nodes from a pool, the pool's AllocationState changes from Steady to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Resizing" />.</para> <para>The remove operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="ResizePool"> <MemberSignature Language="C#" Value="public void ResizePool (string poolId, int? targetDedicatedComputeNodes = default, int? targetLowPriorityComputeNodes = default, TimeSpan? resizeTimeout = default, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ResizePool(string poolId, valuetype System.Nullable`1<int32> targetDedicatedComputeNodes, valuetype System.Nullable`1<int32> targetLowPriorityComputeNodes, valuetype System.Nullable`1<valuetype System.TimeSpan> resizeTimeout, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> deallocationOption, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.ResizePool(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.TimeSpan},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub ResizePool (poolId As String, Optional targetDedicatedComputeNodes As Nullable(Of Integer) = Nothing, Optional targetLowPriorityComputeNodes As Nullable(Of Integer) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.ResizePool : string * Nullable<int> * Nullable<int> * Nullable<TimeSpan> * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.ResizePool (poolId, targetDedicatedComputeNodes, targetLowPriorityComputeNodes, resizeTimeout, deallocationOption, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="targetDedicatedComputeNodes" Type="System.Nullable<System.Int32>" /> <Parameter Name="targetLowPriorityComputeNodes" Type="System.Nullable<System.Int32>" /> <Parameter Name="resizeTimeout" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="deallocationOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="targetDedicatedComputeNodes"> The desired number of dedicated compute nodes in the pool. At least one of <paramref name="targetDedicatedComputeNodes" /> and <paramref name="targetLowPriorityComputeNodes" /> is required. </param> <param name="targetLowPriorityComputeNodes"> The desired number of low-priority compute nodes in the pool. At least one of <paramref name="targetDedicatedComputeNodes" /> and <paramref name="targetLowPriorityComputeNodes" /> is required. </param> <param name="resizeTimeout">The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. If the pool has not reached the target size after this time, the resize is stopped. The default is 15 minutes.</param> <param name="deallocationOption"> Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool, if the pool size is decreasing. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption.Requeue" />. </param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Resizes the specified pool. </summary> <remarks> <para>The resize operation requests that the pool be resized. The request puts the pool in the <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Resizing" /> allocation state. The Batch service will perform the actual resize without any further client action, and set the allocation state to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" /> once complete.</para> <para> You can only resize a pool when its <see cref="P:Microsoft.Azure.Batch.CloudPool.AllocationState" /> is <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" />. You cannot resize pools which are configured for automatic scaling (that is, the <see cref="P:Microsoft.Azure.Batch.CloudPool.AutoScaleEnabled" /> property of the pool is true). If you decrease the pool size, the Batch service chooses which nodes to remove. To remove specific nodes, call <see cref="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPool(System.String,System.Collections.Generic.IEnumerable{System.String},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" />. </para> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.ResizePoolAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.TimeSpan},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</para> </remarks> </Docs> </Member> <Member MemberName="ResizePoolAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ResizePoolAsync (string poolId, int? targetDedicatedComputeNodes = default, int? targetLowPriorityComputeNodes = default, TimeSpan? resizeTimeout = default, Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption? deallocationOption = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task ResizePoolAsync(string poolId, valuetype System.Nullable`1<int32> targetDedicatedComputeNodes, valuetype System.Nullable`1<int32> targetLowPriorityComputeNodes, valuetype System.Nullable`1<valuetype System.TimeSpan> resizeTimeout, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> deallocationOption, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.ResizePoolAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.TimeSpan},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function ResizePoolAsync (poolId As String, Optional targetDedicatedComputeNodes As Nullable(Of Integer) = Nothing, Optional targetLowPriorityComputeNodes As Nullable(Of Integer) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional deallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.ResizePoolAsync : string * Nullable<int> * Nullable<int> * Nullable<TimeSpan> * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.ResizePoolAsync (poolId, targetDedicatedComputeNodes, targetLowPriorityComputeNodes, resizeTimeout, deallocationOption, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="targetDedicatedComputeNodes" Type="System.Nullable<System.Int32>" /> <Parameter Name="targetLowPriorityComputeNodes" Type="System.Nullable<System.Int32>" /> <Parameter Name="resizeTimeout" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="deallocationOption" Type="System.Nullable<Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="targetDedicatedComputeNodes"> The desired number of dedicated compute nodes in the pool. At least one of <paramref name="targetDedicatedComputeNodes" /> and <paramref name="targetLowPriorityComputeNodes" /> is required. </param> <param name="targetLowPriorityComputeNodes"> The desired number of low-priority compute nodes in the pool. At least one of <paramref name="targetDedicatedComputeNodes" /> and <paramref name="targetLowPriorityComputeNodes" /> is required. </param> <param name="resizeTimeout">The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. If the pool has not reached the target size after this time, the resize is stopped. The default is 15 minutes.</param> <param name="deallocationOption"> Specifies how to handle tasks already running, and when the nodes running them may be removed from the pool, if the pool size is decreasing. The default is <see cref="F:Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption.Requeue" />. </param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Resizes the specified pool. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para>The resize operation requests that the pool be resized. The request puts the pool in the <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Resizing" /> allocation state. The Batch service will perform the actual resize without any further client action, and set the allocation state to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" /> once complete.</para> <para> You can only resize a pool when its <see cref="P:Microsoft.Azure.Batch.CloudPool.AllocationState" /> is <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" />. You cannot resize pools which are configured for automatic scaling (that is, the <see cref="P:Microsoft.Azure.Batch.CloudPool.AutoScaleEnabled" /> property of the pool is true). If you decrease the pool size, the Batch service chooses which nodes to remove. To remove specific nodes, call <see cref="M:Microsoft.Azure.Batch.PoolOperations.RemoveFromPoolAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Nullable{Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption},System.Nullable{System.TimeSpan},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />. </para> <para>The resize operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="StopResizePool"> <MemberSignature Language="C#" Value="public void StopResizePool (string poolId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void StopResizePool(string poolId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.StopResizePool(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Sub StopResizePool (poolId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" /> <MemberSignature Language="F#" Value="member this.StopResizePool : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="poolOperations.StopResizePool (poolId, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Stops a pool resize operation. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para> This operation stops an ongoing resize operation on the pool. The pool size will stabilize at the number of nodes it is at when the stop operation is done. During the stop operation, the pool <see cref="P:Microsoft.Azure.Batch.CloudPool.AllocationState" /> changes first to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Stopping" /> and then to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" />. </para> <para>This is a blocking operation. For a non-blocking equivalent, see <see cref="M:Microsoft.Azure.Batch.PoolOperations.StopResizePoolAsync(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />.</para> </remarks> </Docs> </Member> <Member MemberName="StopResizePoolAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task StopResizePoolAsync (string poolId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task StopResizePoolAsync(string poolId, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.StopResizePoolAsync(System.String,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function StopResizePoolAsync (poolId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="member this.StopResizePoolAsync : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="poolOperations.StopResizePoolAsync (poolId, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool.</param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Stops a pool resize operation. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> <para> This operation stops an ongoing resize operation on the pool. The pool size will stabilize at the number of nodes it is at when the stop operation is done. During the stop operation, the pool <see cref="P:Microsoft.Azure.Batch.CloudPool.AllocationState" /> changes first to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Stopping" /> and then to <see cref="F:Microsoft.Azure.Batch.Common.AllocationState.Steady" />. </para> <para>The stop resize operation runs asynchronously.</para> </remarks> </Docs> </Member> <Member MemberName="UploadComputeNodeBatchServiceLogs"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.UploadBatchServiceLogsResult UploadComputeNodeBatchServiceLogs (string poolId, string computeNodeId, string containerUrl, DateTime startTime, DateTime? endTime = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.UploadBatchServiceLogsResult UploadComputeNodeBatchServiceLogs(string poolId, string computeNodeId, string containerUrl, valuetype System.DateTime startTime, valuetype System.Nullable`1<valuetype System.DateTime> endTime, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.UploadComputeNodeBatchServiceLogs(System.String,System.String,System.String,System.DateTime,System.Nullable{System.DateTime},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function UploadComputeNodeBatchServiceLogs (poolId As String, computeNodeId As String, containerUrl As String, startTime As DateTime, Optional endTime As Nullable(Of DateTime) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As UploadBatchServiceLogsResult" /> <MemberSignature Language="F#" Value="member this.UploadComputeNodeBatchServiceLogs : string * string * string * DateTime * Nullable<DateTime> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.UploadBatchServiceLogsResult" Usage="poolOperations.UploadComputeNodeBatchServiceLogs (poolId, computeNodeId, containerUrl, startTime, endTime, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.UploadBatchServiceLogsResult</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="containerUrl" Type="System.String" /> <Parameter Name="startTime" Type="System.DateTime" /> <Parameter Name="endTime" Type="System.Nullable<System.DateTime>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="containerUrl"> The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). If not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. </param> <param name="startTime"> The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded. </param> <param name="endTime"> The end of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded. If this is omitted, the default is the current time. </param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Upload Azure Batch service log files from the specified compute node. </summary> <returns>The result of uploading the batch service logs.</returns> <remarks> This is for gathering Azure Batch service log files in an automated fashion from nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service. </remarks> </Docs> </Member> <Member MemberName="UploadComputeNodeBatchServiceLogs"> <MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.UploadBatchServiceLogsResult UploadComputeNodeBatchServiceLogs (string poolId, string computeNodeId, string containerUrl, Microsoft.Azure.Batch.ComputeNodeIdentityReference identityReference, DateTime startTime, DateTime? endTime = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Batch.UploadBatchServiceLogsResult UploadComputeNodeBatchServiceLogs(string poolId, string computeNodeId, string containerUrl, class Microsoft.Azure.Batch.ComputeNodeIdentityReference identityReference, valuetype System.DateTime startTime, valuetype System.Nullable`1<valuetype System.DateTime> endTime, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.UploadComputeNodeBatchServiceLogs(System.String,System.String,System.String,Microsoft.Azure.Batch.ComputeNodeIdentityReference,System.DateTime,System.Nullable{System.DateTime},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" /> <MemberSignature Language="VB.NET" Value="Public Function UploadComputeNodeBatchServiceLogs (poolId As String, computeNodeId As String, containerUrl As String, identityReference As ComputeNodeIdentityReference, startTime As DateTime, Optional endTime As Nullable(Of DateTime) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As UploadBatchServiceLogsResult" /> <MemberSignature Language="F#" Value="member this.UploadComputeNodeBatchServiceLogs : string * string * string * Microsoft.Azure.Batch.ComputeNodeIdentityReference * DateTime * Nullable<DateTime> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.UploadBatchServiceLogsResult" Usage="poolOperations.UploadComputeNodeBatchServiceLogs (poolId, computeNodeId, containerUrl, identityReference, startTime, endTime, additionalBehaviors)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.Azure.Batch.UploadBatchServiceLogsResult</ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="containerUrl" Type="System.String" /> <Parameter Name="identityReference" Type="Microsoft.Azure.Batch.ComputeNodeIdentityReference" /> <Parameter Name="startTime" Type="System.DateTime" /> <Parameter Name="endTime" Type="System.Nullable<System.DateTime>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="containerUrl"> The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). If not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. </param> <param name="identityReference">A managed identity to use for writing to the container.</param> <param name="startTime"> The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded. </param> <param name="endTime"> The end of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded. If this is omitted, the default is the current time. </param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <summary> Upload Azure Batch service log files from the specified compute node. </summary> <returns>The result of uploading the batch service logs.</returns> <remarks> This is for gathering Azure Batch service log files in an automated fashion from nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service. </remarks> </Docs> </Member> <Member MemberName="UploadComputeNodeBatchServiceLogsAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Batch.UploadBatchServiceLogsResult> UploadComputeNodeBatchServiceLogsAsync (string poolId, string computeNodeId, string containerUrl, DateTime startTime, DateTime? endTime = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Batch.UploadBatchServiceLogsResult> UploadComputeNodeBatchServiceLogsAsync(string poolId, string computeNodeId, string containerUrl, valuetype System.DateTime startTime, valuetype System.Nullable`1<valuetype System.DateTime> endTime, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.UploadComputeNodeBatchServiceLogsAsync(System.String,System.String,System.String,System.DateTime,System.Nullable{System.DateTime},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function UploadComputeNodeBatchServiceLogsAsync (poolId As String, computeNodeId As String, containerUrl As String, startTime As DateTime, Optional endTime As Nullable(Of DateTime) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of UploadBatchServiceLogsResult)" /> <MemberSignature Language="F#" Value="member this.UploadComputeNodeBatchServiceLogsAsync : string * string * string * DateTime * Nullable<DateTime> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.UploadBatchServiceLogsResult>" Usage="poolOperations.UploadComputeNodeBatchServiceLogsAsync (poolId, computeNodeId, containerUrl, startTime, endTime, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Batch.UploadBatchServiceLogsResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="containerUrl" Type="System.String" /> <Parameter Name="startTime" Type="System.DateTime" /> <Parameter Name="endTime" Type="System.Nullable<System.DateTime>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="containerUrl"> The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). If not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. </param> <param name="startTime"> The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded. </param> <param name="endTime"> The end of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded. If this is omitted, the default is the current time. </param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Upload Azure Batch service log files from the specified compute node. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> This is for gathering Azure Batch service log files in an automated fashion from nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service. </remarks> </Docs> </Member> <Member MemberName="UploadComputeNodeBatchServiceLogsAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Azure.Batch.UploadBatchServiceLogsResult> UploadComputeNodeBatchServiceLogsAsync (string poolId, string computeNodeId, string containerUrl, Microsoft.Azure.Batch.ComputeNodeIdentityReference identityReference, DateTime startTime, DateTime? endTime = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Batch.UploadBatchServiceLogsResult> UploadComputeNodeBatchServiceLogsAsync(string poolId, string computeNodeId, string containerUrl, class Microsoft.Azure.Batch.ComputeNodeIdentityReference identityReference, valuetype System.DateTime startTime, valuetype System.Nullable`1<valuetype System.DateTime> endTime, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.PoolOperations.UploadComputeNodeBatchServiceLogsAsync(System.String,System.String,System.String,Microsoft.Azure.Batch.ComputeNodeIdentityReference,System.DateTime,System.Nullable{System.DateTime},System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Function UploadComputeNodeBatchServiceLogsAsync (poolId As String, computeNodeId As String, containerUrl As String, identityReference As ComputeNodeIdentityReference, startTime As DateTime, Optional endTime As Nullable(Of DateTime) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of UploadBatchServiceLogsResult)" /> <MemberSignature Language="F#" Value="member this.UploadComputeNodeBatchServiceLogsAsync : string * string * string * Microsoft.Azure.Batch.ComputeNodeIdentityReference * DateTime * Nullable<DateTime> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.UploadBatchServiceLogsResult>" Usage="poolOperations.UploadComputeNodeBatchServiceLogsAsync (poolId, computeNodeId, containerUrl, identityReference, startTime, endTime, additionalBehaviors, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Batch</AssemblyName> <AssemblyVersion>16.3.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Batch.UploadBatchServiceLogsResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="poolId" Type="System.String" /> <Parameter Name="computeNodeId" Type="System.String" /> <Parameter Name="containerUrl" Type="System.String" /> <Parameter Name="identityReference" Type="Microsoft.Azure.Batch.ComputeNodeIdentityReference" /> <Parameter Name="startTime" Type="System.DateTime" /> <Parameter Name="endTime" Type="System.Nullable<System.DateTime>" /> <Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="poolId">The id of the pool that contains the compute node.</param> <param name="computeNodeId">The id of the compute node.</param> <param name="containerUrl"> The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). If not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. </param> <param name="identityReference">A managed identity to use for writing to the container.</param> <param name="startTime"> The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded. </param> <param name="endTime"> The end of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded. If this is omitted, the default is the current time. </param> <param name="additionalBehaviors">A collection of <see cref="T:Microsoft.Azure.Batch.BatchClientBehavior" /> instances that are applied to the Batch service request after the <see cref="P:Microsoft.Azure.Batch.PoolOperations.CustomBehaviors" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param> <summary> Upload Azure Batch service log files from the specified compute node. </summary> <returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns> <remarks> This is for gathering Azure Batch service log files in an automated fashion from nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service. </remarks> </Docs> </Member> </Members> </Type>

xml/Microsoft.Azure.Batch/PoolOperations.xml (2,246 lines of code) (raw):