1119 строки
120 KiB
YAML
1119 строки
120 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.PoolOperations"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations"
|
|
name: "PoolOperations"
|
|
nameWithType: "PoolOperations"
|
|
summary: "Performs pool-related operations on an Azure Batch account."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **PoolOperations**</br> implements <xref href=\"com.microsoft.azure.batch.IInheritedBehaviors?alt=com.microsoft.azure.batch.IInheritedBehaviors&text=IInheritedBehaviors\" data-throw-if-not-resolved=\"False\" />"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.createPool(com.microsoft.azure.batch.protocol.models.PoolAddParameter)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.createPool(PoolAddParameter pool)"
|
|
name: "createPool(PoolAddParameter pool)"
|
|
nameWithType: "PoolOperations.createPool(PoolAddParameter pool)"
|
|
summary: "Adds a pool to the Batch account."
|
|
parameters:
|
|
- description: "The pool to be added."
|
|
name: "pool"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolAddParameter?alt=com.microsoft.azure.batch.protocol.models.PoolAddParameter&text=PoolAddParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void createPool(PoolAddParameter pool)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Adds a pool to the Batch account."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.createPool(com.microsoft.azure.batch.protocol.models.PoolAddParameter,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.createPool(PoolAddParameter pool, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "createPool(PoolAddParameter pool, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.createPool(PoolAddParameter pool, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Adds a pool to the Batch account."
|
|
parameters:
|
|
- description: "The pool to be added."
|
|
name: "pool"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolAddParameter?alt=com.microsoft.azure.batch.protocol.models.PoolAddParameter&text=PoolAddParameter\" 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\n 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 createPool(PoolAddParameter pool, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Adds a pool to the Batch account."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.createPool(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration,int)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes)"
|
|
name: "createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes)"
|
|
nameWithType: "PoolOperations.createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes)"
|
|
summary: "Adds a pool to the Batch account."
|
|
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 size of virtual machines in the pool. See <a href=\"https://azure.microsoft.com/documentation/articles/virtual-machines-size-specs/\">https://azure.microsoft.com/documentation/articles/virtual-machines-size-specs/</a>\n for sizes."
|
|
name: "virtualMachineSize"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The <xref uid=\"com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"VirtualMachineConfiguration\"></xref> for the pool."
|
|
name: "virtualMachineConfiguration"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration?alt=com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration&text=VirtualMachineConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The desired number of dedicated compute nodes in the pool."
|
|
name: "targetDedicatedNodes"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Adds a pool to the Batch account."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.createPool(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration,int,int)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes)"
|
|
name: "createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes)"
|
|
nameWithType: "PoolOperations.createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes)"
|
|
summary: "Adds a pool to the Batch account."
|
|
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 size of virtual machines in the pool. See <a href=\"https://azure.microsoft.com/documentation/articles/virtual-machines-size-specs/\">https://azure.microsoft.com/documentation/articles/virtual-machines-size-specs/</a>\n for sizes."
|
|
name: "virtualMachineSize"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The <xref uid=\"com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"VirtualMachineConfiguration\"></xref> for the pool."
|
|
name: "virtualMachineConfiguration"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration?alt=com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration&text=VirtualMachineConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The desired number of dedicated compute nodes in the pool."
|
|
name: "targetDedicatedNodes"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The desired number of low-priority compute nodes in the pool."
|
|
name: "targetLowPriorityNodes"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Adds a pool to the Batch account."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.createPool(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration,int,int,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Adds a pool to the Batch account."
|
|
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 size of virtual machines in the pool. See <a href=\"https://azure.microsoft.com/documentation/articles/virtual-machines-size-specs/\">https://azure.microsoft.com/documentation/articles/virtual-machines-size-specs/</a>\n for sizes."
|
|
name: "virtualMachineSize"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The <xref uid=\"com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"VirtualMachineConfiguration\"></xref> for the pool."
|
|
name: "virtualMachineConfiguration"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration?alt=com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration&text=VirtualMachineConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The desired number of dedicated compute nodes in the pool."
|
|
name: "targetDedicatedNodes"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The desired number of low-priority compute nodes in the pool."
|
|
name: "targetLowPriorityNodes"
|
|
type: "<xref href=\"int?alt=int&text=int\" 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\n 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 createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Adds a pool to the Batch account."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.customBehaviors()"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.customBehaviors()"
|
|
name: "customBehaviors()"
|
|
nameWithType: "PoolOperations.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.PoolOperations.deletePool(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.deletePool(String poolId)"
|
|
name: "deletePool(String poolId)"
|
|
nameWithType: "PoolOperations.deletePool(String poolId)"
|
|
summary: "Deletes the specified pool."
|
|
parameters:
|
|
- description: "The ID of the pool to delete."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void deletePool(String poolId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Deletes the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.deletePool(java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.deletePool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "deletePool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.deletePool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Deletes the specified pool."
|
|
parameters:
|
|
- description: "The ID of the pool to delete."
|
|
name: "poolId"
|
|
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\n 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 deletePool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Deletes the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.disableAutoScale(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.disableAutoScale(String poolId)"
|
|
name: "disableAutoScale(String poolId)"
|
|
nameWithType: "PoolOperations.disableAutoScale(String poolId)"
|
|
summary: "Disables automatic scaling on 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 void disableAutoScale(String poolId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Disables automatic scaling on the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.disableAutoScale(java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.disableAutoScale(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "disableAutoScale(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.disableAutoScale(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Disables automatic scaling on 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 collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are\n 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 disableAutoScale(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Disables automatic scaling on the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.enableAutoScale(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.enableAutoScale(String poolId)"
|
|
name: "enableAutoScale(String poolId)"
|
|
nameWithType: "PoolOperations.enableAutoScale(String poolId)"
|
|
summary: "Enables automatic scaling on 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 void enableAutoScale(String poolId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Enables automatic scaling on the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.enableAutoScale(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.enableAutoScale(String poolId, String autoScaleFormula)"
|
|
name: "enableAutoScale(String poolId, String autoScaleFormula)"
|
|
nameWithType: "PoolOperations.enableAutoScale(String poolId, String autoScaleFormula)"
|
|
summary: "Enables automatic scaling on 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: "The formula for the desired number of compute nodes in the pool."
|
|
name: "autoScaleFormula"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void enableAutoScale(String poolId, String autoScaleFormula)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Enables automatic scaling on the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.enableAutoScale(java.lang.String,java.lang.String,org.joda.time.Period)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.enableAutoScale(String poolId, String autoScaleFormula, Period autoScaleEvaluationInterval)"
|
|
name: "enableAutoScale(String poolId, String autoScaleFormula, Period autoScaleEvaluationInterval)"
|
|
nameWithType: "PoolOperations.enableAutoScale(String poolId, String autoScaleFormula, Period autoScaleEvaluationInterval)"
|
|
summary: "Enables automatic scaling on 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: "The formula for the desired number of compute nodes in the pool."
|
|
name: "autoScaleFormula"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The time interval at which to automatically adjust the pool size."
|
|
name: "autoScaleEvaluationInterval"
|
|
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void enableAutoScale(String poolId, String autoScaleFormula, Period autoScaleEvaluationInterval)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Enables automatic scaling on the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.enableAutoScale(java.lang.String,java.lang.String,org.joda.time.Period,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.enableAutoScale(String poolId, String autoScaleFormula, Period autoScaleEvaluationInterval, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "enableAutoScale(String poolId, String autoScaleFormula, Period autoScaleEvaluationInterval, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.enableAutoScale(String poolId, String autoScaleFormula, Period autoScaleEvaluationInterval, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Enables automatic scaling on 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: "The formula for the desired number of compute nodes in the pool."
|
|
name: "autoScaleFormula"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The time interval at which to automatically adjust the pool size."
|
|
name: "autoScaleEvaluationInterval"
|
|
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" 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\n 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 enableAutoScale(String poolId, String autoScaleFormula, Period autoScaleEvaluationInterval, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Enables automatic scaling on the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.evaluateAutoScale(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.evaluateAutoScale(String poolId, String autoScaleFormula)"
|
|
name: "evaluateAutoScale(String poolId, String autoScaleFormula)"
|
|
nameWithType: "PoolOperations.evaluateAutoScale(String poolId, String autoScaleFormula)"
|
|
summary: "Gets the result of evaluating an automatic scaling formula on 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: "The formula to be evaluated on the pool."
|
|
name: "autoScaleFormula"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AutoScaleRun evaluateAutoScale(String poolId, String autoScaleFormula)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "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."
|
|
returns:
|
|
description: "The result of evaluating the formula on the specified pool."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.AutoScaleRun?alt=com.microsoft.azure.batch.protocol.models.AutoScaleRun&text=AutoScaleRun\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.evaluateAutoScale(java.lang.String,java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.evaluateAutoScale(String poolId, String autoScaleFormula, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "evaluateAutoScale(String poolId, String autoScaleFormula, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.evaluateAutoScale(String poolId, String autoScaleFormula, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Gets the result of evaluating an automatic scaling formula on 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: "The formula to be evaluated on the pool."
|
|
name: "autoScaleFormula"
|
|
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\n 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 AutoScaleRun evaluateAutoScale(String poolId, String autoScaleFormula, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "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."
|
|
returns:
|
|
description: "The result of evaluating the formula on the specified pool."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.AutoScaleRun?alt=com.microsoft.azure.batch.protocol.models.AutoScaleRun&text=AutoScaleRun\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.existsPool(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.existsPool(String poolId)"
|
|
name: "existsPool(String poolId)"
|
|
nameWithType: "PoolOperations.existsPool(String poolId)"
|
|
summary: "Checks whether the specified pool exists."
|
|
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 boolean existsPool(String poolId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Checks whether the specified pool exists."
|
|
returns:
|
|
description: "True if the pool exists; otherwise, false."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.existsPool(java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.existsPool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "existsPool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.existsPool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Checks whether the specified pool exists."
|
|
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 collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are\n 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 boolean existsPool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Checks whether the specified pool exists."
|
|
returns:
|
|
description: "True if the pool exists; otherwise, false."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.getPool(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.getPool(String poolId)"
|
|
name: "getPool(String poolId)"
|
|
nameWithType: "PoolOperations.getPool(String poolId)"
|
|
summary: "Gets the specified <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudPool\"></xref>."
|
|
parameters:
|
|
- description: "The ID of the pool to get."
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CloudPool getPool(String poolId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Gets the specified <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudPool\"></xref>."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudPool\"></xref> containing information about the specified Azure\n Batch pool."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudPool?alt=com.microsoft.azure.batch.protocol.models.CloudPool&text=CloudPool\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.getPool(java.lang.String,com.microsoft.azure.batch.DetailLevel)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.getPool(String poolId, DetailLevel detailLevel)"
|
|
name: "getPool(String poolId, DetailLevel detailLevel)"
|
|
nameWithType: "PoolOperations.getPool(String poolId, DetailLevel detailLevel)"
|
|
summary: "Gets the specified <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudPool\"></xref>."
|
|
parameters:
|
|
- description: "The ID of the pool to get."
|
|
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 controlling which properties are\n 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 CloudPool getPool(String poolId, DetailLevel detailLevel)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Gets the specified <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudPool\"></xref>."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudPool\"></xref> containing information about the specified Azure\n Batch pool."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudPool?alt=com.microsoft.azure.batch.protocol.models.CloudPool&text=CloudPool\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.getPool(java.lang.String,com.microsoft.azure.batch.DetailLevel,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.getPool(String poolId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "getPool(String poolId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.getPool(String poolId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Gets the specified <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudPool\"></xref>."
|
|
parameters:
|
|
- description: "The ID of the pool to get."
|
|
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 controlling which properties are\n 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\n 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 CloudPool getPool(String poolId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Gets the specified <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudPool\"></xref>."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudPool\"></xref> containing information about the specified Azure\n Batch pool."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudPool?alt=com.microsoft.azure.batch.protocol.models.CloudPool&text=CloudPool\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.listPoolUsageMetrics(org.joda.time.DateTime,org.joda.time.DateTime)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.listPoolUsageMetrics(DateTime startTime, DateTime endTime)"
|
|
name: "listPoolUsageMetrics(DateTime startTime, DateTime endTime)"
|
|
nameWithType: "PoolOperations.listPoolUsageMetrics(DateTime startTime, DateTime endTime)"
|
|
summary: "Lists pool usage metrics."
|
|
parameters:
|
|
- description: "The start time of the aggregation interval covered by this entry."
|
|
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 time of the aggregation interval for this entry."
|
|
name: "endTime"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PagedList<PoolUsageMetrics> listPoolUsageMetrics(DateTime startTime, DateTime endTime)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Lists pool usage metrics."
|
|
returns:
|
|
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.PoolUsageMetrics\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PoolUsageMetrics\"></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.PoolUsageMetrics?alt=com.microsoft.azure.batch.protocol.models.PoolUsageMetrics&text=PoolUsageMetrics\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.listPoolUsageMetrics(org.joda.time.DateTime,org.joda.time.DateTime,com.microsoft.azure.batch.DetailLevel)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.listPoolUsageMetrics(DateTime startTime, DateTime endTime, DetailLevel detailLevel)"
|
|
name: "listPoolUsageMetrics(DateTime startTime, DateTime endTime, DetailLevel detailLevel)"
|
|
nameWithType: "PoolOperations.listPoolUsageMetrics(DateTime startTime, DateTime endTime, DetailLevel detailLevel)"
|
|
summary: "Lists pool usage metrics."
|
|
parameters:
|
|
- description: "The start time of the aggregation interval covered by this entry."
|
|
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 time of the aggregation interval for this entry."
|
|
name: "endTime"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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\n 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<PoolUsageMetrics> listPoolUsageMetrics(DateTime startTime, DateTime endTime, DetailLevel detailLevel)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Lists pool usage metrics."
|
|
returns:
|
|
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.PoolUsageMetrics\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PoolUsageMetrics\"></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.PoolUsageMetrics?alt=com.microsoft.azure.batch.protocol.models.PoolUsageMetrics&text=PoolUsageMetrics\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.listPoolUsageMetrics(org.joda.time.DateTime,org.joda.time.DateTime,com.microsoft.azure.batch.DetailLevel,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.listPoolUsageMetrics(DateTime startTime, DateTime endTime, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "listPoolUsageMetrics(DateTime startTime, DateTime endTime, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.listPoolUsageMetrics(DateTime startTime, DateTime endTime, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Lists pool usage metrics."
|
|
parameters:
|
|
- description: "The start time of the aggregation interval covered by this entry."
|
|
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 time of the aggregation interval for this entry."
|
|
name: "endTime"
|
|
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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\n 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\n 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<PoolUsageMetrics> listPoolUsageMetrics(DateTime startTime, DateTime endTime, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Lists pool usage metrics."
|
|
returns:
|
|
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.PoolUsageMetrics\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PoolUsageMetrics\"></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.PoolUsageMetrics?alt=com.microsoft.azure.batch.protocol.models.PoolUsageMetrics&text=PoolUsageMetrics\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.listPools()"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.listPools()"
|
|
name: "listPools()"
|
|
nameWithType: "PoolOperations.listPools()"
|
|
summary: "Lists the <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pools\"></xref> in the Batch account."
|
|
syntax: "public PagedList<CloudPool> listPools()"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n 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.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pools\"></xref> in the Batch account."
|
|
returns:
|
|
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudPool\"></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.CloudPool?alt=com.microsoft.azure.batch.protocol.models.CloudPool&text=CloudPool\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.listPools(com.microsoft.azure.batch.DetailLevel)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.listPools(DetailLevel detailLevel)"
|
|
name: "listPools(DetailLevel detailLevel)"
|
|
nameWithType: "PoolOperations.listPools(DetailLevel detailLevel)"
|
|
summary: "Lists the <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pools\"></xref> in the Batch account."
|
|
parameters:
|
|
- 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\n 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<CloudPool> listPools(DetailLevel detailLevel)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n 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.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pools\"></xref> in the Batch account."
|
|
returns:
|
|
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudPool\"></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.CloudPool?alt=com.microsoft.azure.batch.protocol.models.CloudPool&text=CloudPool\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.listPools(com.microsoft.azure.batch.DetailLevel,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.listPools(DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "listPools(DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.listPools(DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Lists the <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pools\"></xref> in the Batch account."
|
|
parameters:
|
|
- 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\n 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\n 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<CloudPool> listPools(DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n 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.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pools\"></xref> in the Batch account."
|
|
returns:
|
|
description: "A list of <xref uid=\"com.microsoft.azure.batch.protocol.models.CloudPool\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudPool\"></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.CloudPool?alt=com.microsoft.azure.batch.protocol.models.CloudPool&text=CloudPool\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.patchPool(java.lang.String,com.microsoft.azure.batch.protocol.models.PoolPatchParameter)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.patchPool(String poolId, PoolPatchParameter param)"
|
|
name: "patchPool(String poolId, PoolPatchParameter param)"
|
|
nameWithType: "PoolOperations.patchPool(String poolId, PoolPatchParameter param)"
|
|
summary: "Updates 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: "The Pool patch properties"
|
|
name: "param"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolPatchParameter?alt=com.microsoft.azure.batch.protocol.models.PoolPatchParameter&text=PoolPatchParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void patchPool(String poolId, PoolPatchParameter param)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Updates the specified pool. This method only replaces the properties specified with non-null values."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.patchPool(java.lang.String,com.microsoft.azure.batch.protocol.models.PoolPatchParameter,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.patchPool(String poolId, PoolPatchParameter param, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "patchPool(String poolId, PoolPatchParameter param, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.patchPool(String poolId, PoolPatchParameter param, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Updates 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: "The Pool patch properties"
|
|
name: "param"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolPatchParameter?alt=com.microsoft.azure.batch.protocol.models.PoolPatchParameter&text=PoolPatchParameter\" 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 patchPool(String poolId, PoolPatchParameter param, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Updates the specified pool. This method only replaces the properties specified with non-null values."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.patchPool(java.lang.String,com.microsoft.azure.batch.protocol.models.StartTask,java.util.Collection<com.microsoft.azure.batch.protocol.models.CertificateReference>,java.util.Collection<com.microsoft.azure.batch.protocol.models.ApplicationPackageReference>,java.util.Collection<com.microsoft.azure.batch.protocol.models.MetadataItem>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.patchPool(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata)"
|
|
name: "patchPool(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata)"
|
|
nameWithType: "PoolOperations.patchPool(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata)"
|
|
summary: "Updates 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 task to run on each compute node as it joins the pool. If null,\n any existing start task is left unchanged."
|
|
name: "startTask"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.StartTask?alt=com.microsoft.azure.batch.protocol.models.StartTask&text=StartTask\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A collection of certificates to be installed on each compute node\n in the pool. If null, any existing certificate references are left\n unchanged."
|
|
name: "certificateReferences"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.protocol.models.CertificateReference?alt=com.microsoft.azure.batch.protocol.models.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "A collection of application packages to be installed on each\n compute node in the pool. If null, any existing application\n packages references are left unchanged."
|
|
name: "applicationPackageReferences"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.protocol.models.ApplicationPackageReference?alt=com.microsoft.azure.batch.protocol.models.ApplicationPackageReference&text=ApplicationPackageReference\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "A collection of name-value pairs associated with the pool as\n metadata. If null, any existing metadata is left unchanged."
|
|
name: "metadata"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.protocol.models.MetadataItem?alt=com.microsoft.azure.batch.protocol.models.MetadataItem&text=MetadataItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public void patchPool(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Updates the specified pool. This method only replaces the properties specified with non-null values."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.patchPool(java.lang.String,com.microsoft.azure.batch.protocol.models.StartTask,java.util.Collection<com.microsoft.azure.batch.protocol.models.CertificateReference>,java.util.Collection<com.microsoft.azure.batch.protocol.models.ApplicationPackageReference>,java.util.Collection<com.microsoft.azure.batch.protocol.models.MetadataItem>,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.patchPool(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "patchPool(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.patchPool(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Updates 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 task to run on each compute node as it joins the pool. If null,\n any existing start task is left unchanged."
|
|
name: "startTask"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.StartTask?alt=com.microsoft.azure.batch.protocol.models.StartTask&text=StartTask\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A collection of certificates to be installed on each compute node\n in the pool. If null, any existing certificate references are left\n unchanged."
|
|
name: "certificateReferences"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.protocol.models.CertificateReference?alt=com.microsoft.azure.batch.protocol.models.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "A collection of application packages to be installed on each\n compute node in the pool. If null, any existing application\n packages references are left unchanged."
|
|
name: "applicationPackageReferences"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.protocol.models.ApplicationPackageReference?alt=com.microsoft.azure.batch.protocol.models.ApplicationPackageReference&text=ApplicationPackageReference\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "A collection of name-value pairs associated with the pool as\n metadata. If null, any existing metadata is left unchanged."
|
|
name: "metadata"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.protocol.models.MetadataItem?alt=com.microsoft.azure.batch.protocol.models.MetadataItem&text=MetadataItem\" 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\n 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 patchPool(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Updates the specified pool. This method only replaces the properties specified with non-null values."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.removeNodeFromPool(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.removeNodeFromPool(String poolId, String computeNodeId)"
|
|
name: "removeNodeFromPool(String poolId, String computeNodeId)"
|
|
nameWithType: "PoolOperations.removeNodeFromPool(String poolId, String computeNodeId)"
|
|
summary: "Removes the specified compute node from 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: "The ID of the compute node to remove from the pool."
|
|
name: "computeNodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void removeNodeFromPool(String poolId, String computeNodeId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Removes the specified compute node from the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.removeNodeFromPool(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.removeNodeFromPool(String poolId, String computeNodeId, ComputeNodeDeallocationOption deallocationOption)"
|
|
name: "removeNodeFromPool(String poolId, String computeNodeId, ComputeNodeDeallocationOption deallocationOption)"
|
|
nameWithType: "PoolOperations.removeNodeFromPool(String poolId, String computeNodeId, ComputeNodeDeallocationOption deallocationOption)"
|
|
summary: "Removes the specified compute node from 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: "The ID of the compute node to remove from the pool."
|
|
name: "computeNodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Specifies when nodes may be removed from the pool."
|
|
name: "deallocationOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption&text=ComputeNodeDeallocationOption\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void removeNodeFromPool(String poolId, String computeNodeId, ComputeNodeDeallocationOption deallocationOption)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Removes the specified compute node from the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.removeNodeFromPool(java.lang.String,java.lang.String,com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption,org.joda.time.Period,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.removeNodeFromPool(String poolId, String computeNodeId, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "removeNodeFromPool(String poolId, String computeNodeId, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.removeNodeFromPool(String poolId, String computeNodeId, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Removes the specified compute node from 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: "The ID of the compute node to remove from the pool."
|
|
name: "computeNodeId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Specifies when nodes may be removed from the pool."
|
|
name: "deallocationOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption&text=ComputeNodeDeallocationOption\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Specifies the timeout for removal of compute nodes from the pool."
|
|
name: "resizeTimeout"
|
|
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" 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\n 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 removeNodeFromPool(String poolId, String computeNodeId, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Removes the specified compute node from the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.removeNodesFromPool(java.lang.String,java.util.Collection<com.microsoft.azure.batch.protocol.models.ComputeNode>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes)"
|
|
name: "removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes)"
|
|
nameWithType: "PoolOperations.removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes)"
|
|
summary: "Removes the specified compute nodes from 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: "The compute nodes to remove from the pool."
|
|
name: "computeNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<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\" />>"
|
|
syntax: "public void removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Removes the specified compute nodes from the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.removeNodesFromPool(java.lang.String,java.util.Collection<com.microsoft.azure.batch.protocol.models.ComputeNode>,com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes, ComputeNodeDeallocationOption deallocationOption)"
|
|
name: "removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes, ComputeNodeDeallocationOption deallocationOption)"
|
|
nameWithType: "PoolOperations.removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes, ComputeNodeDeallocationOption deallocationOption)"
|
|
summary: "Removes the specified compute nodes from 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: "The compute nodes to remove from the pool."
|
|
name: "computeNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<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\" />>"
|
|
- description: "Specifies when nodes may be removed from the pool."
|
|
name: "deallocationOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption&text=ComputeNodeDeallocationOption\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes, ComputeNodeDeallocationOption deallocationOption)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Removes the specified compute nodes from the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.removeNodesFromPool(java.lang.String,java.util.Collection<com.microsoft.azure.batch.protocol.models.ComputeNode>,com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption,org.joda.time.Period,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Removes the specified compute nodes from 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: "The compute nodes to remove from the pool."
|
|
name: "computeNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<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\" />>"
|
|
- description: "Specifies when nodes may be removed from the pool."
|
|
name: "deallocationOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption&text=ComputeNodeDeallocationOption\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Specifies the timeout for removal of compute nodes from the pool."
|
|
name: "resizeTimeout"
|
|
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" 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\n 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 removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Removes the specified compute nodes from the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.removeNodesFromPool(java.lang.String,java.util.List<java.lang.String>,com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption,org.joda.time.Period,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.removeNodesFromPool(String poolId, List<String> computeNodeIds, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "removeNodesFromPool(String poolId, List<String> computeNodeIds, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.removeNodesFromPool(String poolId, List<String> computeNodeIds, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Removes the specified compute nodes from 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: "The IDs of the compute nodes to remove from the pool."
|
|
name: "computeNodeIds"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- description: "Specifies when nodes may be removed from the pool."
|
|
name: "deallocationOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption&text=ComputeNodeDeallocationOption\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Specifies the timeout for removal of compute nodes from the pool."
|
|
name: "resizeTimeout"
|
|
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" 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\n 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 removeNodesFromPool(String poolId, List<String> computeNodeIds, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Removes the specified compute nodes from the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.resizePool(java.lang.String,java.lang.Integer,java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes)"
|
|
name: "resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes)"
|
|
nameWithType: "PoolOperations.resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes)"
|
|
summary: "Resizes 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: "The desired number of dedicated compute nodes in the pool."
|
|
name: "targetDedicatedNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "The desired number of low-priority compute nodes in the pool."
|
|
name: "targetLowPriorityNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public void resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Resizes the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.resizePool(java.lang.String,java.lang.Integer,java.lang.Integer,org.joda.time.Period)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout)"
|
|
name: "resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout)"
|
|
nameWithType: "PoolOperations.resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout)"
|
|
summary: "Resizes 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: "The desired number of dedicated compute nodes in the pool."
|
|
name: "targetDedicatedNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "The desired number of low-priority compute nodes in the pool."
|
|
name: "targetLowPriorityNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "The timeout for allocation of compute nodes to the pool or removal\n of compute nodes from the pool. If the pool has not reached the\n target size after this time, the resize is stopped."
|
|
name: "resizeTimeout"
|
|
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Resizes the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.resizePool(java.lang.String,java.lang.Integer,java.lang.Integer,org.joda.time.Period,com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout, ComputeNodeDeallocationOption deallocationOption)"
|
|
name: "resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout, ComputeNodeDeallocationOption deallocationOption)"
|
|
nameWithType: "PoolOperations.resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout, ComputeNodeDeallocationOption deallocationOption)"
|
|
summary: "Resizes 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: "The desired number of dedicated compute nodes in the pool."
|
|
name: "targetDedicatedNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "The desired number of low-priority compute nodes in the pool."
|
|
name: "targetLowPriorityNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "The timeout for allocation of compute nodes to the pool or removal\n of compute nodes from the pool. If the pool has not reached the\n target size after this time, the resize is stopped."
|
|
name: "resizeTimeout"
|
|
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Specifies when nodes may be removed from the pool, if the pool\n size is decreasing."
|
|
name: "deallocationOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption&text=ComputeNodeDeallocationOption\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout, ComputeNodeDeallocationOption deallocationOption)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Resizes the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.resizePool(java.lang.String,java.lang.Integer,java.lang.Integer,org.joda.time.Period,com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout, ComputeNodeDeallocationOption deallocationOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout, ComputeNodeDeallocationOption deallocationOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout, ComputeNodeDeallocationOption deallocationOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Resizes 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: "The desired number of dedicated compute nodes in the pool."
|
|
name: "targetDedicatedNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "The desired number of low-priority compute nodes in the pool."
|
|
name: "targetLowPriorityNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "The timeout for allocation of compute nodes to the pool or removal\n of compute nodes from the pool. If the pool has not reached the\n target size after this time, the resize is stopped."
|
|
name: "resizeTimeout"
|
|
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Specifies when nodes may be removed from the pool, if the pool\n size is decreasing."
|
|
name: "deallocationOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption&text=ComputeNodeDeallocationOption\" 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\n 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 resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout, ComputeNodeDeallocationOption deallocationOption, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Resizes the specified pool."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.stopResizePool(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.stopResizePool(String poolId)"
|
|
name: "stopResizePool(String poolId)"
|
|
nameWithType: "PoolOperations.stopResizePool(String poolId)"
|
|
summary: "Stops a pool resize operation."
|
|
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 void stopResizePool(String poolId)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Stops a pool resize operation."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.stopResizePool(java.lang.String,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.stopResizePool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "stopResizePool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.stopResizePool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Stops a pool resize operation."
|
|
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 collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances that are\n 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 stopResizePool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Stops a pool resize operation."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.updatePoolProperties(java.lang.String,com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesParameter)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.updatePoolProperties(String poolId, PoolUpdatePropertiesParameter param)"
|
|
name: "updatePoolProperties(String poolId, PoolUpdatePropertiesParameter param)"
|
|
nameWithType: "PoolOperations.updatePoolProperties(String poolId, PoolUpdatePropertiesParameter param)"
|
|
summary: "Updates 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: "The Pool update properties"
|
|
name: "param"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesParameter?alt=com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesParameter&text=PoolUpdatePropertiesParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void updatePoolProperties(String poolId, PoolUpdatePropertiesParameter param)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Updates the specified pool. This method fully replaces all the updatable properties of the pool. For example, if the startTask parameter is null and the pool has a start task associated with it, then the Batch service will remove the existing start task."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.updatePoolProperties(java.lang.String,com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesParameter,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.updatePoolProperties(String poolId, PoolUpdatePropertiesParameter param, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "updatePoolProperties(String poolId, PoolUpdatePropertiesParameter param, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.updatePoolProperties(String poolId, PoolUpdatePropertiesParameter param, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Updates 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: "The Pool update properties"
|
|
name: "param"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesParameter?alt=com.microsoft.azure.batch.protocol.models.PoolUpdatePropertiesParameter&text=PoolUpdatePropertiesParameter\" 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 updatePoolProperties(String poolId, PoolUpdatePropertiesParameter param, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Updates the specified pool. This method fully replaces all the updatable properties of the pool. For example, if the startTask parameter is null and the pool has a start task associated with it, then the Batch service will remove the existing start task."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.updatePoolProperties(java.lang.String,com.microsoft.azure.batch.protocol.models.StartTask,java.util.Collection<com.microsoft.azure.batch.protocol.models.CertificateReference>,java.util.Collection<com.microsoft.azure.batch.protocol.models.ApplicationPackageReference>,java.util.Collection<com.microsoft.azure.batch.protocol.models.MetadataItem>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.updatePoolProperties(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata)"
|
|
name: "updatePoolProperties(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata)"
|
|
nameWithType: "PoolOperations.updatePoolProperties(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata)"
|
|
summary: "Updates 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 task to run on each compute node as it joins the pool. If null,\n any existing start task is removed from the pool."
|
|
name: "startTask"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.StartTask?alt=com.microsoft.azure.batch.protocol.models.StartTask&text=StartTask\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A collection of certificates to be installed on each compute node\n in the pool. If null, any existing certificate references are\n removed from the pool."
|
|
name: "certificateReferences"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.protocol.models.CertificateReference?alt=com.microsoft.azure.batch.protocol.models.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "A collection of application packages to be installed on each\n compute node in the pool. If null, any existing application\n packages references are removed from the pool."
|
|
name: "applicationPackageReferences"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.protocol.models.ApplicationPackageReference?alt=com.microsoft.azure.batch.protocol.models.ApplicationPackageReference&text=ApplicationPackageReference\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "A collection of name-value pairs associated with the pool as\n metadata. If null, any existing metadata is removed from the pool."
|
|
name: "metadata"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.protocol.models.MetadataItem?alt=com.microsoft.azure.batch.protocol.models.MetadataItem&text=MetadataItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public void updatePoolProperties(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Updates the specified pool. This method fully replaces all the updatable properties of the pool. For example, if the startTask parameter is null and the pool has a start task associated with it, then the Batch service will remove the existing start task."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.updatePoolProperties(java.lang.String,com.microsoft.azure.batch.protocol.models.StartTask,java.util.Collection<com.microsoft.azure.batch.protocol.models.CertificateReference>,java.util.Collection<com.microsoft.azure.batch.protocol.models.ApplicationPackageReference>,java.util.Collection<com.microsoft.azure.batch.protocol.models.MetadataItem>,java.lang.Iterable<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.updatePoolProperties(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
name: "updatePoolProperties(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
nameWithType: "PoolOperations.updatePoolProperties(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
summary: "Updates 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 task to run on each compute node as it joins the pool. If null,\n any existing start task is removed from the pool."
|
|
name: "startTask"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.StartTask?alt=com.microsoft.azure.batch.protocol.models.StartTask&text=StartTask\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A collection of certificates to be installed on each compute node\n in the pool. If null, any existing certificate references are\n removed from the pool."
|
|
name: "certificateReferences"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.protocol.models.CertificateReference?alt=com.microsoft.azure.batch.protocol.models.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "A collection of application packages to be installed on each\n compute node in the pool. If null, any existing application\n packages references are removed from the pool."
|
|
name: "applicationPackageReferences"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.protocol.models.ApplicationPackageReference?alt=com.microsoft.azure.batch.protocol.models.ApplicationPackageReference&text=ApplicationPackageReference\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "A collection of name-value pairs associated with the pool as\n metadata. If null, any existing metadata is removed from the pool."
|
|
name: "metadata"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.protocol.models.MetadataItem?alt=com.microsoft.azure.batch.protocol.models.MetadataItem&text=MetadataItem\" 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\n 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 updatePoolProperties(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata, Iterable<BatchClientBehavior> additionalBehaviors)"
|
|
exceptions:
|
|
- description: "Exception thrown when an error response is received from the\n 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\n Batch service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Updates the specified pool. This method fully replaces all the updatable properties of the pool. For example, if the startTask parameter is null and the pool has a start task associated with it, then the Batch service will remove the existing start task."
|
|
- uid: "com.microsoft.azure.batch.PoolOperations.withCustomBehaviors(java.util.Collection<com.microsoft.azure.batch.BatchClientBehavior>)"
|
|
fullName: "com.microsoft.azure.batch.PoolOperations.withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
|
|
name: "withCustomBehaviors(Collection<BatchClientBehavior> behaviors)"
|
|
nameWithType: "PoolOperations.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 pool-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:11.2.0
|