796 строки
79 KiB
YAML
796 строки
79 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.ComputeNodeOperations"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations"
|
|
name: "ComputeNodeOperations"
|
|
nameWithType: "ComputeNodeOperations"
|
|
summary: "Performs compute node-related operations on an Azure Batch account."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedMembers:
|
|
- "java.lang.Object.clone()"
|
|
- "java.lang.Object.equals(java.lang.Object)"
|
|
- "java.lang.Object.finalize()"
|
|
- "java.lang.Object.getClass()"
|
|
- "java.lang.Object.hashCode()"
|
|
- "java.lang.Object.notify()"
|
|
- "java.lang.Object.notifyAll()"
|
|
- "java.lang.Object.toString()"
|
|
- "java.lang.Object.wait()"
|
|
- "java.lang.Object.wait(long)"
|
|
- "java.lang.Object.wait(long,int)"
|
|
syntax: "public class ComputeNodeOperations implements IInheritedBehaviors"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.addComputeNodeUser(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.ComputeNodeUser)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.addComputeNodeUser(String poolId, String nodeId, ComputeNodeUser user)"
|
|
name: "addComputeNodeUser(String poolId, String nodeId, ComputeNodeUser user)"
|
|
nameWithType: "ComputeNodeOperations.addComputeNodeUser(String poolId, String nodeId, ComputeNodeUser user)"
|
|
summary: "Adds a user account to the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node where the user account will be created."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The user account to be created."
|
|
name: "user"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeUser?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeUser&text=ComputeNodeUser\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void addComputeNodeUser(String poolId, String nodeId, ComputeNodeUser user)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Adds a user account to the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.addComputeNodeUser(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.ComputeNodeUser,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.addComputeNodeUser(String poolId, String nodeId, ComputeNodeUser user, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "addComputeNodeUser(String poolId, String nodeId, ComputeNodeUser user, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.addComputeNodeUser(String poolId, String nodeId, ComputeNodeUser user, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Adds a user account to the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node where the user account will be created."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The user account to be created."
|
|
name: "user"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeUser?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeUser&text=ComputeNodeUser\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public void addComputeNodeUser(String poolId, String nodeId, ComputeNodeUser user, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Adds a user account to the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.customBehaviors()"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.customBehaviors()"
|
|
name: "customBehaviors()"
|
|
nameWithType: "ComputeNodeOperations.customBehaviors()"
|
|
summary: "Gets a collection of behaviors that modify or customize requests to the Batch service."
|
|
syntax: "public Collection<BatchClientBehavior> customBehaviors()"
|
|
desc: "Gets a collection of behaviors that modify or customize requests to the Batch service."
|
|
returns:
|
|
description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.deleteComputeNodeUser(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.deleteComputeNodeUser(String poolId, String nodeId, String userName)"
|
|
name: "deleteComputeNodeUser(String poolId, String nodeId, String userName)"
|
|
nameWithType: "ComputeNodeOperations.deleteComputeNodeUser(String poolId, String nodeId, String userName)"
|
|
summary: "Deletes the specified user account from the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node where the user account will be deleted."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the user account to be deleted."
|
|
name: "userName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void deleteComputeNodeUser(String poolId, String nodeId, String userName)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Deletes the specified user account from the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.deleteComputeNodeUser(java.lang.String,java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.deleteComputeNodeUser(String poolId, String nodeId, String userName, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "deleteComputeNodeUser(String poolId, String nodeId, String userName, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.deleteComputeNodeUser(String poolId, String nodeId, String userName, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Deletes the specified user account from the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node where the user account will be deleted."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the user account to be deleted."
|
|
name: "userName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public void deleteComputeNodeUser(String poolId, String nodeId, String userName, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Deletes the specified user account from the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.disableComputeNodeScheduling(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.disableComputeNodeScheduling(String poolId, String nodeId)"
|
|
name: "disableComputeNodeScheduling(String poolId, String nodeId)"
|
|
nameWithType: "ComputeNodeOperations.disableComputeNodeScheduling(String poolId, String nodeId)"
|
|
summary: "Disables task scheduling on the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the ID of the compute node."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void disableComputeNodeScheduling(String poolId, String nodeId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Disables task scheduling on the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.disableComputeNodeScheduling(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.DisableComputeNodeSchedulingOption)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.disableComputeNodeScheduling(String poolId, String nodeId, DisableComputeNodeSchedulingOption nodeDisableSchedulingOption)"
|
|
name: "disableComputeNodeScheduling(String poolId, String nodeId, DisableComputeNodeSchedulingOption nodeDisableSchedulingOption)"
|
|
nameWithType: "ComputeNodeOperations.disableComputeNodeScheduling(String poolId, String nodeId, DisableComputeNodeSchedulingOption nodeDisableSchedulingOption)"
|
|
summary: "Disables task scheduling on the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Specifies what to do with currently running tasks."
|
|
name: "nodeDisableSchedulingOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.DisableComputeNodeSchedulingOption?alt=com.microsoft.azure.batch.protocol.models.DisableComputeNodeSchedulingOption&text=DisableComputeNodeSchedulingOption\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void disableComputeNodeScheduling(String poolId, String nodeId, DisableComputeNodeSchedulingOption nodeDisableSchedulingOption)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Disables task scheduling on the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.disableComputeNodeScheduling(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.DisableComputeNodeSchedulingOption,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.disableComputeNodeScheduling(String poolId, String nodeId, DisableComputeNodeSchedulingOption nodeDisableSchedulingOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "disableComputeNodeScheduling(String poolId, String nodeId, DisableComputeNodeSchedulingOption nodeDisableSchedulingOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.disableComputeNodeScheduling(String poolId, String nodeId, DisableComputeNodeSchedulingOption nodeDisableSchedulingOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Disables task scheduling on the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Specifies what to do with currently running tasks."
|
|
name: "nodeDisableSchedulingOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.DisableComputeNodeSchedulingOption?alt=com.microsoft.azure.batch.protocol.models.DisableComputeNodeSchedulingOption&text=DisableComputeNodeSchedulingOption\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public void disableComputeNodeScheduling(String poolId, String nodeId, DisableComputeNodeSchedulingOption nodeDisableSchedulingOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Disables task scheduling on the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.enableComputeNodeScheduling(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.enableComputeNodeScheduling(String poolId, String nodeId)"
|
|
name: "enableComputeNodeScheduling(String poolId, String nodeId)"
|
|
nameWithType: "ComputeNodeOperations.enableComputeNodeScheduling(String poolId, String nodeId)"
|
|
summary: "Enables task scheduling on the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void enableComputeNodeScheduling(String poolId, String nodeId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Enables task scheduling on the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.enableComputeNodeScheduling(java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.enableComputeNodeScheduling(String poolId, String nodeId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "enableComputeNodeScheduling(String poolId, String nodeId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.enableComputeNodeScheduling(String poolId, String nodeId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Enables task scheduling on the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public void enableComputeNodeScheduling(String poolId, String nodeId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Enables task scheduling on the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNode(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNode(String poolId, String nodeId)"
|
|
name: "getComputeNode(String poolId, String nodeId)"
|
|
nameWithType: "ComputeNodeOperations.getComputeNode(String poolId, String nodeId)"
|
|
summary: "Gets the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the ID of the compute node to get from the pool."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ComputeNode getComputeNode(String poolId, String nodeId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Gets the specified compute node."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputeNode\"></xref> containing information about the specified compute node."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNode?alt=com.microsoft.azure.batch.protocol.models.ComputeNode&text=ComputeNode\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNode(java.lang.String,java.lang.String,com.microsoft.azure.batch.DetailLevel)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNode(String poolId, String nodeId, DetailLevel detailLevel)"
|
|
name: "getComputeNode(String poolId, String nodeId, DetailLevel detailLevel)"
|
|
nameWithType: "ComputeNodeOperations.getComputeNode(String poolId, String nodeId, DetailLevel detailLevel)"
|
|
summary: "Gets the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node to get from the pool."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "A <xref uid=\"com.microsoft.azure.batch.DetailLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DetailLevel\"></xref> used for controlling which properties are retrieved from the service."
|
|
name: "detailLevel"
|
|
type: "<xref href=\"com.microsoft.azure.batch.DetailLevel?alt=com.microsoft.azure.batch.DetailLevel&text=DetailLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ComputeNode getComputeNode(String poolId, String nodeId, DetailLevel detailLevel)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Gets the specified compute node."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputeNode\"></xref> containing information about the specified compute node."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNode?alt=com.microsoft.azure.batch.protocol.models.ComputeNode&text=ComputeNode\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNode(java.lang.String,java.lang.String,com.microsoft.azure.batch.DetailLevel,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNode(String poolId, String nodeId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "getComputeNode(String poolId, String nodeId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.getComputeNode(String poolId, String nodeId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Gets the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node to get from the pool."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "A <xref uid=\"com.microsoft.azure.batch.DetailLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DetailLevel\"></xref> used for controlling which properties are retrieved from the service."
|
|
name: "detailLevel"
|
|
type: "<xref href=\"com.microsoft.azure.batch.DetailLevel?alt=com.microsoft.azure.batch.DetailLevel&text=DetailLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public ComputeNode getComputeNode(String poolId, String nodeId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Gets the specified compute node."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputeNode\"></xref> containing information about the specified compute node."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNode?alt=com.microsoft.azure.batch.protocol.models.ComputeNode&text=ComputeNode\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNodeRemoteDesktop(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNodeRemoteDesktop(String poolId, String nodeId)"
|
|
name: "getComputeNodeRemoteDesktop(String poolId, String nodeId)"
|
|
nameWithType: "ComputeNodeOperations.getComputeNodeRemoteDesktop(String poolId, String nodeId)"
|
|
summary: "Gets a Remote Desktop Protocol (RDP) file for the specified node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node for which to get a Remote Desktop file."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public String getComputeNodeRemoteDesktop(String poolId, String nodeId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Gets a Remote Desktop Protocol (RDP) file for the specified node."
|
|
returns:
|
|
description: "The RDP file contents."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNodeRemoteDesktop(java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNodeRemoteDesktop(String poolId, String nodeId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "getComputeNodeRemoteDesktop(String poolId, String nodeId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.getComputeNodeRemoteDesktop(String poolId, String nodeId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Gets a Remote Desktop Protocol (RDP) file for the specified node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node for which to get a Remote Desktop file."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public String getComputeNodeRemoteDesktop(String poolId, String nodeId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Gets a Remote Desktop Protocol (RDP) file for the specified node."
|
|
returns:
|
|
description: "The RDP file contents."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNodeRemoteLoginSettings(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNodeRemoteLoginSettings(String poolId, String nodeId)"
|
|
name: "getComputeNodeRemoteLoginSettings(String poolId, String nodeId)"
|
|
nameWithType: "ComputeNodeOperations.getComputeNodeRemoteLoginSettings(String poolId, String nodeId)"
|
|
summary: "Gets the settings required for remote login to a compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node for which to get a remote login settings."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ComputeNodeGetRemoteLoginSettingsResult getComputeNodeRemoteLoginSettings(String poolId, String nodeId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Gets the settings required for remote login to a compute node."
|
|
returns:
|
|
description: "The remote settings for the specified compute node."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeGetRemoteLoginSettingsResult?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeGetRemoteLoginSettingsResult&text=ComputeNodeGetRemoteLoginSettingsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNodeRemoteLoginSettings(java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.getComputeNodeRemoteLoginSettings(String poolId, String nodeId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "getComputeNodeRemoteLoginSettings(String poolId, String nodeId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.getComputeNodeRemoteLoginSettings(String poolId, String nodeId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Gets the settings required for remote login to a compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node for which to get a remote login settings."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public ComputeNodeGetRemoteLoginSettingsResult getComputeNodeRemoteLoginSettings(String poolId, String nodeId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Gets the settings required for remote login to a compute node."
|
|
returns:
|
|
description: "The remote login settings for the specified compute node."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeGetRemoteLoginSettingsResult?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeGetRemoteLoginSettingsResult&text=ComputeNodeGetRemoteLoginSettingsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.listComputeNodes(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.listComputeNodes(String poolId)"
|
|
name: "listComputeNodes(String poolId)"
|
|
nameWithType: "ComputeNodeOperations.listComputeNodes(String poolId)"
|
|
summary: "Lists the <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"compute nodes\"></xref> of the specified pool."
|
|
parameters:
|
|
- description: "The ID of the pool."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PagedList<ComputeNode> listComputeNodes(String poolId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Lists the <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"compute nodes\"></xref> of the specified pool."
|
|
returns:
|
|
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputeNode\"></xref> objects."
|
|
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNode?alt=com.microsoft.azure.batch.protocol.models.ComputeNode&text=ComputeNode\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.listComputeNodes(java.lang.String,com.microsoft.azure.batch.DetailLevel)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.listComputeNodes(String poolId, DetailLevel detailLevel)"
|
|
name: "listComputeNodes(String poolId, DetailLevel detailLevel)"
|
|
nameWithType: "ComputeNodeOperations.listComputeNodes(String poolId, DetailLevel detailLevel)"
|
|
summary: "Lists the <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"compute nodes\"></xref> of the specified pool."
|
|
parameters:
|
|
- description: "The ID of the pool."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "A <xref uid=\"com.microsoft.azure.batch.DetailLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DetailLevel\"></xref> used for filtering the list and for controlling which properties are retrieved from the service."
|
|
name: "detailLevel"
|
|
type: "<xref href=\"com.microsoft.azure.batch.DetailLevel?alt=com.microsoft.azure.batch.DetailLevel&text=DetailLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PagedList<ComputeNode> listComputeNodes(String poolId, DetailLevel detailLevel)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Lists the <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"compute nodes\"></xref> of the specified pool."
|
|
returns:
|
|
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputeNode\"></xref> objects."
|
|
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNode?alt=com.microsoft.azure.batch.protocol.models.ComputeNode&text=ComputeNode\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.listComputeNodes(java.lang.String,com.microsoft.azure.batch.DetailLevel,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.listComputeNodes(String poolId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "listComputeNodes(String poolId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.listComputeNodes(String poolId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Lists the <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"compute nodes\"></xref> of the specified pool."
|
|
parameters:
|
|
- description: "The ID of the pool."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "A <xref uid=\"com.microsoft.azure.batch.DetailLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DetailLevel\"></xref> used for filtering the list and for controlling which properties are retrieved from the service."
|
|
name: "detailLevel"
|
|
type: "<xref href=\"com.microsoft.azure.batch.DetailLevel?alt=com.microsoft.azure.batch.DetailLevel&text=DetailLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public PagedList<ComputeNode> listComputeNodes(String poolId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Lists the <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"compute nodes\"></xref> of the specified pool."
|
|
returns:
|
|
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputeNode\"></xref> objects."
|
|
type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNode?alt=com.microsoft.azure.batch.protocol.models.ComputeNode&text=ComputeNode\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.rebootComputeNode(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.rebootComputeNode(String poolId, String nodeId)"
|
|
name: "rebootComputeNode(String poolId, String nodeId)"
|
|
nameWithType: "ComputeNodeOperations.rebootComputeNode(String poolId, String nodeId)"
|
|
summary: "Reboots the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node to reboot."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void rebootComputeNode(String poolId, String nodeId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reboots the specified compute node.\n\nYou can reboot a compute node only when it is in the <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNodeState.IDLE\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Idle\"></xref> or <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNodeState.RUNNING\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Running\"></xref> state."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.rebootComputeNode(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.ComputeNodeRebootOption)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.rebootComputeNode(String poolId, String nodeId, ComputeNodeRebootOption nodeRebootOption)"
|
|
name: "rebootComputeNode(String poolId, String nodeId, ComputeNodeRebootOption nodeRebootOption)"
|
|
nameWithType: "ComputeNodeOperations.rebootComputeNode(String poolId, String nodeId, ComputeNodeRebootOption nodeRebootOption)"
|
|
summary: "Reboots the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node to reboot."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Specifies when to reboot the node and what to do with currently running tasks."
|
|
name: "nodeRebootOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeRebootOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeRebootOption&text=ComputeNodeRebootOption\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void rebootComputeNode(String poolId, String nodeId, ComputeNodeRebootOption nodeRebootOption)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reboots the specified compute node.\n\nYou can reboot a compute node only when it is in the <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNodeState.IDLE\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Idle\"></xref> or <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNodeState.RUNNING\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Running\"></xref> state."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.rebootComputeNode(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.ComputeNodeRebootOption,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.rebootComputeNode(String poolId, String nodeId, ComputeNodeRebootOption nodeRebootOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "rebootComputeNode(String poolId, String nodeId, ComputeNodeRebootOption nodeRebootOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.rebootComputeNode(String poolId, String nodeId, ComputeNodeRebootOption nodeRebootOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Reboots the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node to reboot."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Specifies when to reboot the node and what to do with currently running tasks."
|
|
name: "nodeRebootOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeRebootOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeRebootOption&text=ComputeNodeRebootOption\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public void rebootComputeNode(String poolId, String nodeId, ComputeNodeRebootOption nodeRebootOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reboots the specified compute node.\n\nYou can reboot a compute node only when it is in the <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNodeState.IDLE\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Idle\"></xref> or <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNodeState.RUNNING\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Running\"></xref> state."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.reimageComputeNode(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.reimageComputeNode(String poolId, String nodeId)"
|
|
name: "reimageComputeNode(String poolId, String nodeId)"
|
|
nameWithType: "ComputeNodeOperations.reimageComputeNode(String poolId, String nodeId)"
|
|
summary: "Reinstalls the operating system on the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node to reimage."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void reimageComputeNode(String poolId, String nodeId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reinstalls the operating system on the specified compute node.\n\nYou can reimage a compute node only when it is in the <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNodeState.IDLE\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Idle\"></xref> or <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNodeState.RUNNING\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Running\"></xref> state."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.reimageComputeNode(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.ComputeNodeReimageOption)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.reimageComputeNode(String poolId, String nodeId, ComputeNodeReimageOption nodeReimageOption)"
|
|
name: "reimageComputeNode(String poolId, String nodeId, ComputeNodeReimageOption nodeReimageOption)"
|
|
nameWithType: "ComputeNodeOperations.reimageComputeNode(String poolId, String nodeId, ComputeNodeReimageOption nodeReimageOption)"
|
|
summary: "Reinstalls the operating system on the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node to reimage."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Specifies when to reimage the node and what to do with currently running tasks."
|
|
name: "nodeReimageOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeReimageOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeReimageOption&text=ComputeNodeReimageOption\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void reimageComputeNode(String poolId, String nodeId, ComputeNodeReimageOption nodeReimageOption)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reinstalls the operating system on the specified compute node.\n\nYou can reimage a compute node only when it is in the <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNodeState.IDLE\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Idle\"></xref> or <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNodeState.RUNNING\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Running\"></xref> state."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.reimageComputeNode(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.ComputeNodeReimageOption,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.reimageComputeNode(String poolId, String nodeId, ComputeNodeReimageOption nodeReimageOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "reimageComputeNode(String poolId, String nodeId, ComputeNodeReimageOption nodeReimageOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.reimageComputeNode(String poolId, String nodeId, ComputeNodeReimageOption nodeReimageOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Reinstalls the operating system on the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node to reimage."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Specifies when to reimage the node and what to do with currently running tasks."
|
|
name: "nodeReimageOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeReimageOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeReimageOption&text=ComputeNodeReimageOption\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public void reimageComputeNode(String poolId, String nodeId, ComputeNodeReimageOption nodeReimageOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reinstalls the operating system on the specified compute node.\n\nYou can reimage a compute node only when it is in the <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNodeState.IDLE\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Idle\"></xref> or <xref uid=\"com.microsoft.azure.batch.protocol.models.ComputeNodeState.RUNNING\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Running\"></xref> state."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.updateComputeNodeUser(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.updateComputeNodeUser(String poolId, String nodeId, String userName, String sshPublicKey)"
|
|
name: "updateComputeNodeUser(String poolId, String nodeId, String userName, String sshPublicKey)"
|
|
nameWithType: "ComputeNodeOperations.updateComputeNodeUser(String poolId, String nodeId, String userName, String sshPublicKey)"
|
|
summary: "Updates the specified user account on the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node where the user account will be updated."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the user account to update."
|
|
name: "userName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The SSH public key that can be used for remote login to the compute node. If null, the SSH public key is removed."
|
|
name: "sshPublicKey"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void updateComputeNodeUser(String poolId, String nodeId, String userName, String sshPublicKey)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Updates the specified user account on the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.updateComputeNodeUser(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.updateComputeNodeUser(String poolId, String nodeId, String userName, String sshPublicKey, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "updateComputeNodeUser(String poolId, String nodeId, String userName, String sshPublicKey, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.updateComputeNodeUser(String poolId, String nodeId, String userName, String sshPublicKey, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Updates the specified user account on the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node where the user account will be updated."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the user account to update."
|
|
name: "userName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The SSH public key that can be used for remote login to the compute node. If null, the SSH public key is removed."
|
|
name: "sshPublicKey"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public void updateComputeNodeUser(String poolId, String nodeId, String userName, String sshPublicKey, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Updates the specified user account on the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.updateComputeNodeUser(java.lang.String,java.lang.String,java.lang.String,java.lang.String,org.joda.time.DateTime)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.updateComputeNodeUser(String poolId, String nodeId, String userName, String password, DateTime expiryTime)"
|
|
name: "updateComputeNodeUser(String poolId, String nodeId, String userName, String password, DateTime expiryTime)"
|
|
nameWithType: "ComputeNodeOperations.updateComputeNodeUser(String poolId, String nodeId, String userName, String password, DateTime expiryTime)"
|
|
summary: "Updates the specified user account on the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node where the user account will be updated."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the user account to update."
|
|
name: "userName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The password of the account. If null, the password is removed."
|
|
name: "password"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The time at which the account should expire. If null, the expiry time is replaced with its default value."
|
|
name: "expiryTime"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void updateComputeNodeUser(String poolId, String nodeId, String userName, String password, DateTime expiryTime)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Updates the specified user account on the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.updateComputeNodeUser(java.lang.String,java.lang.String,java.lang.String,java.lang.String,org.joda.time.DateTime,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.updateComputeNodeUser(String poolId, String nodeId, String userName, String password, DateTime expiryTime, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "updateComputeNodeUser(String poolId, String nodeId, String userName, String password, DateTime expiryTime, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.updateComputeNodeUser(String poolId, String nodeId, String userName, String password, DateTime expiryTime, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Updates the specified user account on the specified compute node."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node where the user account will be updated."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the user account to update."
|
|
name: "userName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The password of the account. If null, the password is removed."
|
|
name: "password"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The time at which the account should expire. If null, the expiry time is replaced with its default value."
|
|
name: "expiryTime"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public void updateComputeNodeUser(String poolId, String nodeId, String userName, String password, DateTime expiryTime, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Updates the specified user account on the specified compute node."
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.uploadBatchServiceLogs(java.lang.String,java.lang.String,java.lang.String,org.joda.time.DateTime)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.uploadBatchServiceLogs(String poolId, String nodeId, String containerUrl, DateTime startTime)"
|
|
name: "uploadBatchServiceLogs(String poolId, String nodeId, String containerUrl, DateTime startTime)"
|
|
nameWithType: "ComputeNodeOperations.uploadBatchServiceLogs(String poolId, String nodeId, String containerUrl, DateTime startTime)"
|
|
summary: "Upload Azure Batch service log files from the specified compute node to Azure Blob Storage."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node from which you want to upload the Azure Batch service log files."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s)."
|
|
name: "containerUrl"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The start of the time range from which to upload Batch Service log file(s)."
|
|
name: "startTime"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public UploadBatchServiceLogsResult uploadBatchServiceLogs(String poolId, String nodeId, String containerUrl, DateTime startTime)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Upload Azure Batch service log files from the specified compute node to Azure Blob Storage. 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."
|
|
returns:
|
|
description: "The result of uploading Batch service log files from a specific compute node."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.UploadBatchServiceLogsResult?alt=com.microsoft.azure.batch.protocol.models.UploadBatchServiceLogsResult&text=UploadBatchServiceLogsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.uploadBatchServiceLogs(java.lang.String,java.lang.String,java.lang.String,org.joda.time.DateTime,org.joda.time.DateTime,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.uploadBatchServiceLogs(String poolId, String nodeId, String containerUrl, DateTime startTime, DateTime endTime, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "uploadBatchServiceLogs(String poolId, String nodeId, String containerUrl, DateTime startTime, DateTime endTime, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "ComputeNodeOperations.uploadBatchServiceLogs(String poolId, String nodeId, String containerUrl, DateTime startTime, DateTime endTime, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Upload Azure Batch service log files from the specified compute node to Azure Blob Storage."
|
|
parameters:
|
|
- description: "The ID of the pool that contains the compute node."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The ID of the compute node from which you want to upload the Azure Batch service log files."
|
|
name: "nodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s)."
|
|
name: "containerUrl"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The start of the time range from which to upload Batch Service log file(s)."
|
|
name: "startTime"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The end of the time range from which to upload Batch Service log file(s)."
|
|
name: "endTime"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are applied to the Batch service request."
|
|
name: "additionalBehaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public UploadBatchServiceLogsResult uploadBatchServiceLogs(String poolId, String nodeId, String containerUrl, DateTime startTime, DateTime endTime, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.BatchErrorException?alt=com.microsoft.azure.batch.protocol.models.BatchErrorException&text=BatchErrorException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Exception thrown when an error response is received from the Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Upload Azure Batch service log files from the specified compute node to Azure Blob Storage. 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."
|
|
returns:
|
|
description: "The result of uploading Batch service log files from a specific compute node."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.UploadBatchServiceLogsResult?alt=com.microsoft.azure.batch.protocol.models.UploadBatchServiceLogsResult&text=UploadBatchServiceLogsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.ComputeNodeOperations.withCustomBehaviors(java.util.Collection<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.ComputeNodeOperations.withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
|
|
name: "withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
|
|
nameWithType: "ComputeNodeOperations.withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
|
|
summary: "Sets a collection of behaviors that modify or customize requests to the Batch service."
|
|
parameters:
|
|
- description: "The collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances."
|
|
name: "behaviors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public IInheritedBehaviors withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
|
|
desc: "Sets a collection of behaviors that modify or customize requests to the Batch service."
|
|
returns:
|
|
description: "The current instance."
|
|
type: "<xref href=\"com.microsoft.azure.batch.IInheritedBehaviors?alt=com.microsoft.azure.batch.IInheritedBehaviors&text=IInheritedBehaviors\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Performs compute node-related operations on an Azure Batch account."
|
|
implements:
|
|
- "<xref href=\"com.microsoft.azure.batch.IInheritedBehaviors?alt=com.microsoft.azure.batch.IInheritedBehaviors&text=IInheritedBehaviors\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch"
|
|
artifact: com.microsoft.azure:azure-batch:9.0.0
|