588 строки
54 KiB
YAML
588 строки
54 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter"
|
|
name: "PoolAddParameter"
|
|
nameWithType: "PoolAddParameter"
|
|
summary: "A Pool in the Azure Batch service to add."
|
|
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 **PoolAddParameter**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.PoolAddParameter()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.PoolAddParameter()"
|
|
name: "PoolAddParameter()"
|
|
nameWithType: "PoolAddParameter.PoolAddParameter()"
|
|
syntax: "public PoolAddParameter()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.applicationPackageReferences()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.applicationPackageReferences()"
|
|
name: "applicationPackageReferences()"
|
|
nameWithType: "PoolAddParameter.applicationPackageReferences()"
|
|
summary: "Get when creating a pool, the package's application ID must be fully qualified (/subscriptions/\\{subscription<wbr>Id\\}/resource<wbr>Groups/\\{resource<wbr>Group<wbr>Name\\}/providers/Microsoft.<wbr>Batch/batch<wbr>Accounts/\\{account<wbr>Name\\}/applications/\\{application<wbr>Name\\})."
|
|
syntax: "public List<ApplicationPackageReference> applicationPackageReferences()"
|
|
desc: "Get when creating a pool, the package's application ID must be fully qualified (/subscriptions/\\{subscriptionId\\}/resourceGroups/\\{resourceGroupName\\}/providers/Microsoft.Batch/batchAccounts/\\{accountName\\}/applications/\\{applicationName\\}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool."
|
|
returns:
|
|
description: "the applicationPackageReferences value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</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\" />>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.autoScaleEvaluationInterval()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.autoScaleEvaluationInterval()"
|
|
name: "autoScaleEvaluationInterval()"
|
|
nameWithType: "PoolAddParameter.autoScaleEvaluationInterval()"
|
|
summary: "Get the default value is 15 minutes."
|
|
syntax: "public Period autoScaleEvaluationInterval()"
|
|
desc: "Get the default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)."
|
|
returns:
|
|
description: "the autoScaleEvaluationInterval value"
|
|
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.autoScaleFormula()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.autoScaleFormula()"
|
|
name: "autoScaleFormula()"
|
|
nameWithType: "PoolAddParameter.autoScaleFormula()"
|
|
summary: "Get this property must not be specified if enable<wbr>Auto<wbr>Scale is set to false."
|
|
syntax: "public String autoScaleFormula()"
|
|
desc: "Get this property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/)."
|
|
returns:
|
|
description: "the autoScaleFormula value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.certificateReferences()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.certificateReferences()"
|
|
name: "certificateReferences()"
|
|
nameWithType: "PoolAddParameter.certificateReferences()"
|
|
summary: "Get for Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location."
|
|
syntax: "public List<CertificateReference> certificateReferences()"
|
|
desc: "Get for Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ\\_BATCH\\_CERTIFICATES\\_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/\\{user-name\\}/certs) and Certificates are placed in that directory. Warning: This property is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
|
|
returns:
|
|
description: "the certificateReferences value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</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\" />>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.displayName()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.displayName()"
|
|
name: "displayName()"
|
|
nameWithType: "PoolAddParameter.displayName()"
|
|
summary: "Get the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024."
|
|
syntax: "public String displayName()"
|
|
desc: "Get the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024."
|
|
returns:
|
|
description: "the displayName value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.enableAutoScale()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.enableAutoScale()"
|
|
name: "enableAutoScale()"
|
|
nameWithType: "PoolAddParameter.enableAutoScale()"
|
|
summary: "Get if false, at least one of target<wbr>Dedicated<wbr>Nodes and target<wbr>Low<wbr>Priority<wbr>Nodes must be specified."
|
|
syntax: "public Boolean enableAutoScale()"
|
|
desc: "Get if false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false."
|
|
returns:
|
|
description: "the enableAutoScale value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.enableInterNodeCommunication()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.enableInterNodeCommunication()"
|
|
name: "enableInterNodeCommunication()"
|
|
nameWithType: "PoolAddParameter.enableInterNodeCommunication()"
|
|
summary: "Get enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool."
|
|
syntax: "public Boolean enableInterNodeCommunication()"
|
|
desc: "Get enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false."
|
|
returns:
|
|
description: "the enableInterNodeCommunication value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.id()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.id()"
|
|
name: "id()"
|
|
nameWithType: "PoolAddParameter.id()"
|
|
summary: "Get the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters."
|
|
syntax: "public String id()"
|
|
desc: "Get the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two Pool IDs within an Account that differ only by case)."
|
|
returns:
|
|
description: "the id value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.metadata()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.metadata()"
|
|
name: "metadata()"
|
|
nameWithType: "PoolAddParameter.metadata()"
|
|
summary: "Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code."
|
|
syntax: "public List<MetadataItem> metadata()"
|
|
desc: "Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code."
|
|
returns:
|
|
description: "the metadata value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</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\" />>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.mountConfiguration()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.mountConfiguration()"
|
|
name: "mountConfiguration()"
|
|
nameWithType: "PoolAddParameter.mountConfiguration()"
|
|
summary: "Get mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system."
|
|
syntax: "public List<MountConfiguration> mountConfiguration()"
|
|
desc: "Get mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system."
|
|
returns:
|
|
description: "the mountConfiguration value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.MountConfiguration?alt=com.microsoft.azure.batch.protocol.models.MountConfiguration&text=MountConfiguration\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.networkConfiguration()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.networkConfiguration()"
|
|
name: "networkConfiguration()"
|
|
nameWithType: "PoolAddParameter.networkConfiguration()"
|
|
summary: "Get the network<wbr>Configuration value."
|
|
syntax: "public NetworkConfiguration networkConfiguration()"
|
|
desc: "Get the networkConfiguration value."
|
|
returns:
|
|
description: "the networkConfiguration value"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.NetworkConfiguration?alt=com.microsoft.azure.batch.protocol.models.NetworkConfiguration&text=NetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.resizeTimeout()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.resizeTimeout()"
|
|
name: "resizeTimeout()"
|
|
nameWithType: "PoolAddParameter.resizeTimeout()"
|
|
summary: "Get this timeout applies only to manual scaling; it has no effect when enable<wbr>Auto<wbr>Scale is set to true."
|
|
syntax: "public Period resizeTimeout()"
|
|
desc: "Get this timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)."
|
|
returns:
|
|
description: "the resizeTimeout value"
|
|
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.resourceTags()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.resourceTags()"
|
|
name: "resourceTags()"
|
|
nameWithType: "PoolAddParameter.resourceTags()"
|
|
summary: "Get the user-defined tags to be associated with the Azure Batch Pool."
|
|
syntax: "public Map<String,String> resourceTags()"
|
|
desc: "Get the user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'."
|
|
returns:
|
|
description: "the resourceTags value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.startTask()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.startTask()"
|
|
name: "startTask()"
|
|
nameWithType: "PoolAddParameter.startTask()"
|
|
summary: "Get the Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted."
|
|
syntax: "public StartTask startTask()"
|
|
desc: "Get the Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted."
|
|
returns:
|
|
description: "the startTask value"
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.targetDedicatedNodes()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.targetDedicatedNodes()"
|
|
name: "targetDedicatedNodes()"
|
|
nameWithType: "PoolAddParameter.targetDedicatedNodes()"
|
|
summary: "Get this property must not be specified if enable<wbr>Auto<wbr>Scale is set to true."
|
|
syntax: "public Integer targetDedicatedNodes()"
|
|
desc: "Get this property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both."
|
|
returns:
|
|
description: "the targetDedicatedNodes value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.targetLowPriorityNodes()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.targetLowPriorityNodes()"
|
|
name: "targetLowPriorityNodes()"
|
|
nameWithType: "PoolAddParameter.targetLowPriorityNodes()"
|
|
summary: "Get this property must not be specified if enable<wbr>Auto<wbr>Scale is set to true."
|
|
syntax: "public Integer targetLowPriorityNodes()"
|
|
desc: "Get this property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both."
|
|
returns:
|
|
description: "the targetLowPriorityNodes value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.targetNodeCommunicationMode()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.targetNodeCommunicationMode()"
|
|
name: "targetNodeCommunicationMode()"
|
|
nameWithType: "PoolAddParameter.targetNodeCommunicationMode()"
|
|
summary: "Get if omitted, the default value is Default."
|
|
syntax: "public NodeCommunicationMode targetNodeCommunicationMode()"
|
|
desc: "Get if omitted, the default value is Default. Possible values include: 'default', 'classic', 'simplified'."
|
|
returns:
|
|
description: "the targetNodeCommunicationMode value"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.NodeCommunicationMode?alt=com.microsoft.azure.batch.protocol.models.NodeCommunicationMode&text=NodeCommunicationMode\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.taskSchedulingPolicy()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.taskSchedulingPolicy()"
|
|
name: "taskSchedulingPolicy()"
|
|
nameWithType: "PoolAddParameter.taskSchedulingPolicy()"
|
|
summary: "Get if not specified, the default is spread."
|
|
syntax: "public TaskSchedulingPolicy taskSchedulingPolicy()"
|
|
desc: "Get if not specified, the default is spread."
|
|
returns:
|
|
description: "the taskSchedulingPolicy value"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskSchedulingPolicy?alt=com.microsoft.azure.batch.protocol.models.TaskSchedulingPolicy&text=TaskSchedulingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.taskSlotsPerNode()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.taskSlotsPerNode()"
|
|
name: "taskSlotsPerNode()"
|
|
nameWithType: "PoolAddParameter.taskSlotsPerNode()"
|
|
summary: "Get the default value is 1."
|
|
syntax: "public Integer taskSlotsPerNode()"
|
|
desc: "Get the default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256."
|
|
returns:
|
|
description: "the taskSlotsPerNode value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.upgradePolicy()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.upgradePolicy()"
|
|
name: "upgradePolicy()"
|
|
nameWithType: "PoolAddParameter.upgradePolicy()"
|
|
summary: "Get describes an upgrade policy - automatic, manual, or rolling."
|
|
syntax: "public UpgradePolicy upgradePolicy()"
|
|
desc: "Get describes an upgrade policy - automatic, manual, or rolling."
|
|
returns:
|
|
description: "the upgradePolicy value"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.UpgradePolicy?alt=com.microsoft.azure.batch.protocol.models.UpgradePolicy&text=UpgradePolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.userAccounts()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.userAccounts()"
|
|
name: "userAccounts()"
|
|
nameWithType: "PoolAddParameter.userAccounts()"
|
|
summary: "Get the user<wbr>Accounts value."
|
|
syntax: "public List<UserAccount> userAccounts()"
|
|
desc: "Get the userAccounts value."
|
|
returns:
|
|
description: "the userAccounts value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.UserAccount?alt=com.microsoft.azure.batch.protocol.models.UserAccount&text=UserAccount\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.virtualMachineConfiguration()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.virtualMachineConfiguration()"
|
|
name: "virtualMachineConfiguration()"
|
|
nameWithType: "PoolAddParameter.virtualMachineConfiguration()"
|
|
summary: "Get this property must be specified."
|
|
syntax: "public VirtualMachineConfiguration virtualMachineConfiguration()"
|
|
desc: "Get this property must be specified."
|
|
returns:
|
|
description: "the virtualMachineConfiguration value"
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.vmSize()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.vmSize()"
|
|
name: "vmSize()"
|
|
nameWithType: "PoolAddParameter.vmSize()"
|
|
summary: "Get for information about available VM sizes, see Sizes for Virtual Machines (Linux) (https://azure.<wbr>microsoft.<wbr>com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.<wbr>microsoft.<wbr>com/documentation/articles/virtual-machines-windows-sizes/)."
|
|
syntax: "public String vmSize()"
|
|
desc: "Get for information about available VM sizes, see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD\\_A0 and those with premium storage (STANDARD\\_GS, STANDARD\\_DS, and STANDARD\\_DSV2 series)."
|
|
returns:
|
|
description: "the vmSize value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withApplicationPackageReferences(java.util.List<com.microsoft.azure.batch.protocol.models.ApplicationPackageReference>)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences)"
|
|
name: "withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences)"
|
|
nameWithType: "PoolAddParameter.withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences)"
|
|
summary: "Set when creating a pool, the package's application ID must be fully qualified (/subscriptions/\\{subscription<wbr>Id\\}/resource<wbr>Groups/\\{resource<wbr>Group<wbr>Name\\}/providers/Microsoft.<wbr>Batch/batch<wbr>Accounts/\\{account<wbr>Name\\}/applications/\\{application<wbr>Name\\})."
|
|
parameters:
|
|
- description: "the applicationPackageReferences value to set"
|
|
name: "applicationPackageReferences"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</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\" />>"
|
|
syntax: "public PoolAddParameter withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences)"
|
|
desc: "Set when creating a pool, the package's application ID must be fully qualified (/subscriptions/\\{subscriptionId\\}/resourceGroups/\\{resourceGroupName\\}/providers/Microsoft.Batch/batchAccounts/\\{accountName\\}/applications/\\{applicationName\\}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withAutoScaleEvaluationInterval(org.joda.time.Period)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withAutoScaleEvaluationInterval(Period autoScaleEvaluationInterval)"
|
|
name: "withAutoScaleEvaluationInterval(Period autoScaleEvaluationInterval)"
|
|
nameWithType: "PoolAddParameter.withAutoScaleEvaluationInterval(Period autoScaleEvaluationInterval)"
|
|
summary: "Set the default value is 15 minutes."
|
|
parameters:
|
|
- description: "the autoScaleEvaluationInterval value to set"
|
|
name: "autoScaleEvaluationInterval"
|
|
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PoolAddParameter withAutoScaleEvaluationInterval(Period autoScaleEvaluationInterval)"
|
|
desc: "Set the default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withAutoScaleFormula(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withAutoScaleFormula(String autoScaleFormula)"
|
|
name: "withAutoScaleFormula(String autoScaleFormula)"
|
|
nameWithType: "PoolAddParameter.withAutoScaleFormula(String autoScaleFormula)"
|
|
summary: "Set this property must not be specified if enable<wbr>Auto<wbr>Scale is set to false."
|
|
parameters:
|
|
- description: "the autoScaleFormula value to set"
|
|
name: "autoScaleFormula"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PoolAddParameter withAutoScaleFormula(String autoScaleFormula)"
|
|
desc: "Set this property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/)."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withCertificateReferences(java.util.List<com.microsoft.azure.batch.protocol.models.CertificateReference>)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withCertificateReferences(List<CertificateReference> certificateReferences)"
|
|
name: "withCertificateReferences(List<CertificateReference> certificateReferences)"
|
|
nameWithType: "PoolAddParameter.withCertificateReferences(List<CertificateReference> certificateReferences)"
|
|
summary: "Set for Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location."
|
|
parameters:
|
|
- description: "the certificateReferences value to set"
|
|
name: "certificateReferences"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</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\" />>"
|
|
syntax: "public PoolAddParameter withCertificateReferences(List<CertificateReference> certificateReferences)"
|
|
desc: "Set for Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ\\_BATCH\\_CERTIFICATES\\_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/\\{user-name\\}/certs) and Certificates are placed in that directory. Warning: This property is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withDisplayName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withDisplayName(String displayName)"
|
|
name: "withDisplayName(String displayName)"
|
|
nameWithType: "PoolAddParameter.withDisplayName(String displayName)"
|
|
summary: "Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024."
|
|
parameters:
|
|
- description: "the displayName value to set"
|
|
name: "displayName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PoolAddParameter withDisplayName(String displayName)"
|
|
desc: "Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withEnableAutoScale(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withEnableAutoScale(Boolean enableAutoScale)"
|
|
name: "withEnableAutoScale(Boolean enableAutoScale)"
|
|
nameWithType: "PoolAddParameter.withEnableAutoScale(Boolean enableAutoScale)"
|
|
summary: "Set if false, at least one of target<wbr>Dedicated<wbr>Nodes and target<wbr>Low<wbr>Priority<wbr>Nodes must be specified."
|
|
parameters:
|
|
- description: "the enableAutoScale value to set"
|
|
name: "enableAutoScale"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public PoolAddParameter withEnableAutoScale(Boolean enableAutoScale)"
|
|
desc: "Set if false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withEnableInterNodeCommunication(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withEnableInterNodeCommunication(Boolean enableInterNodeCommunication)"
|
|
name: "withEnableInterNodeCommunication(Boolean enableInterNodeCommunication)"
|
|
nameWithType: "PoolAddParameter.withEnableInterNodeCommunication(Boolean enableInterNodeCommunication)"
|
|
summary: "Set enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool."
|
|
parameters:
|
|
- description: "the enableInterNodeCommunication value to set"
|
|
name: "enableInterNodeCommunication"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public PoolAddParameter withEnableInterNodeCommunication(Boolean enableInterNodeCommunication)"
|
|
desc: "Set enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withId(String id)"
|
|
name: "withId(String id)"
|
|
nameWithType: "PoolAddParameter.withId(String id)"
|
|
summary: "Set the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters."
|
|
parameters:
|
|
- description: "the id value to set"
|
|
name: "id"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PoolAddParameter withId(String id)"
|
|
desc: "Set the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two Pool IDs within an Account that differ only by case)."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withMetadata(java.util.List<com.microsoft.azure.batch.protocol.models.MetadataItem>)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withMetadata(List<MetadataItem> metadata)"
|
|
name: "withMetadata(List<MetadataItem> metadata)"
|
|
nameWithType: "PoolAddParameter.withMetadata(List<MetadataItem> metadata)"
|
|
summary: "Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code."
|
|
parameters:
|
|
- description: "the metadata value to set"
|
|
name: "metadata"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</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 PoolAddParameter withMetadata(List<MetadataItem> metadata)"
|
|
desc: "Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withMountConfiguration(java.util.List<com.microsoft.azure.batch.protocol.models.MountConfiguration>)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withMountConfiguration(List<MountConfiguration> mountConfiguration)"
|
|
name: "withMountConfiguration(List<MountConfiguration> mountConfiguration)"
|
|
nameWithType: "PoolAddParameter.withMountConfiguration(List<MountConfiguration> mountConfiguration)"
|
|
summary: "Set mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system."
|
|
parameters:
|
|
- description: "the mountConfiguration value to set"
|
|
name: "mountConfiguration"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.MountConfiguration?alt=com.microsoft.azure.batch.protocol.models.MountConfiguration&text=MountConfiguration\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public PoolAddParameter withMountConfiguration(List<MountConfiguration> mountConfiguration)"
|
|
desc: "Set mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withNetworkConfiguration(com.microsoft.azure.batch.protocol.models.NetworkConfiguration)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withNetworkConfiguration(NetworkConfiguration networkConfiguration)"
|
|
name: "withNetworkConfiguration(NetworkConfiguration networkConfiguration)"
|
|
nameWithType: "PoolAddParameter.withNetworkConfiguration(NetworkConfiguration networkConfiguration)"
|
|
summary: "Set the network<wbr>Configuration value."
|
|
parameters:
|
|
- description: "the networkConfiguration value to set"
|
|
name: "networkConfiguration"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.NetworkConfiguration?alt=com.microsoft.azure.batch.protocol.models.NetworkConfiguration&text=NetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PoolAddParameter withNetworkConfiguration(NetworkConfiguration networkConfiguration)"
|
|
desc: "Set the networkConfiguration value."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withResizeTimeout(org.joda.time.Period)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withResizeTimeout(Period resizeTimeout)"
|
|
name: "withResizeTimeout(Period resizeTimeout)"
|
|
nameWithType: "PoolAddParameter.withResizeTimeout(Period resizeTimeout)"
|
|
summary: "Set this timeout applies only to manual scaling; it has no effect when enable<wbr>Auto<wbr>Scale is set to true."
|
|
parameters:
|
|
- description: "the resizeTimeout value to set"
|
|
name: "resizeTimeout"
|
|
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PoolAddParameter withResizeTimeout(Period resizeTimeout)"
|
|
desc: "Set this timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withResourceTags(java.util.Map<java.lang.String,java.lang.String>)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withResourceTags(Map<String,String> resourceTags)"
|
|
name: "withResourceTags(Map<String,String> resourceTags)"
|
|
nameWithType: "PoolAddParameter.withResourceTags(Map<String,String> resourceTags)"
|
|
summary: "Set the user-defined tags to be associated with the Azure Batch Pool."
|
|
parameters:
|
|
- description: "the resourceTags value to set"
|
|
name: "resourceTags"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public PoolAddParameter withResourceTags(Map<String,String> resourceTags)"
|
|
desc: "Set the user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withStartTask(com.microsoft.azure.batch.protocol.models.StartTask)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withStartTask(StartTask startTask)"
|
|
name: "withStartTask(StartTask startTask)"
|
|
nameWithType: "PoolAddParameter.withStartTask(StartTask startTask)"
|
|
summary: "Set the Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted."
|
|
parameters:
|
|
- description: "the startTask value to set"
|
|
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\" />"
|
|
syntax: "public PoolAddParameter withStartTask(StartTask startTask)"
|
|
desc: "Set the Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withTargetDedicatedNodes(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withTargetDedicatedNodes(Integer targetDedicatedNodes)"
|
|
name: "withTargetDedicatedNodes(Integer targetDedicatedNodes)"
|
|
nameWithType: "PoolAddParameter.withTargetDedicatedNodes(Integer targetDedicatedNodes)"
|
|
summary: "Set this property must not be specified if enable<wbr>Auto<wbr>Scale is set to true."
|
|
parameters:
|
|
- description: "the targetDedicatedNodes value to set"
|
|
name: "targetDedicatedNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public PoolAddParameter withTargetDedicatedNodes(Integer targetDedicatedNodes)"
|
|
desc: "Set this property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withTargetLowPriorityNodes(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withTargetLowPriorityNodes(Integer targetLowPriorityNodes)"
|
|
name: "withTargetLowPriorityNodes(Integer targetLowPriorityNodes)"
|
|
nameWithType: "PoolAddParameter.withTargetLowPriorityNodes(Integer targetLowPriorityNodes)"
|
|
summary: "Set this property must not be specified if enable<wbr>Auto<wbr>Scale is set to true."
|
|
parameters:
|
|
- description: "the targetLowPriorityNodes value to set"
|
|
name: "targetLowPriorityNodes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public PoolAddParameter withTargetLowPriorityNodes(Integer targetLowPriorityNodes)"
|
|
desc: "Set this property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withTargetNodeCommunicationMode(com.microsoft.azure.batch.protocol.models.NodeCommunicationMode)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)"
|
|
name: "withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)"
|
|
nameWithType: "PoolAddParameter.withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)"
|
|
summary: "Set if omitted, the default value is Default."
|
|
parameters:
|
|
- description: "the targetNodeCommunicationMode value to set"
|
|
name: "targetNodeCommunicationMode"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.NodeCommunicationMode?alt=com.microsoft.azure.batch.protocol.models.NodeCommunicationMode&text=NodeCommunicationMode\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PoolAddParameter withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)"
|
|
desc: "Set if omitted, the default value is Default. Possible values include: 'default', 'classic', 'simplified'."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withTaskSchedulingPolicy(com.microsoft.azure.batch.protocol.models.TaskSchedulingPolicy)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)"
|
|
name: "withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)"
|
|
nameWithType: "PoolAddParameter.withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)"
|
|
summary: "Set if not specified, the default is spread."
|
|
parameters:
|
|
- description: "the taskSchedulingPolicy value to set"
|
|
name: "taskSchedulingPolicy"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskSchedulingPolicy?alt=com.microsoft.azure.batch.protocol.models.TaskSchedulingPolicy&text=TaskSchedulingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PoolAddParameter withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)"
|
|
desc: "Set if not specified, the default is spread."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withTaskSlotsPerNode(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withTaskSlotsPerNode(Integer taskSlotsPerNode)"
|
|
name: "withTaskSlotsPerNode(Integer taskSlotsPerNode)"
|
|
nameWithType: "PoolAddParameter.withTaskSlotsPerNode(Integer taskSlotsPerNode)"
|
|
summary: "Set the default value is 1."
|
|
parameters:
|
|
- description: "the taskSlotsPerNode value to set"
|
|
name: "taskSlotsPerNode"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public PoolAddParameter withTaskSlotsPerNode(Integer taskSlotsPerNode)"
|
|
desc: "Set the default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withUpgradePolicy(com.microsoft.azure.batch.protocol.models.UpgradePolicy)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withUpgradePolicy(UpgradePolicy upgradePolicy)"
|
|
name: "withUpgradePolicy(UpgradePolicy upgradePolicy)"
|
|
nameWithType: "PoolAddParameter.withUpgradePolicy(UpgradePolicy upgradePolicy)"
|
|
summary: "Set describes an upgrade policy - automatic, manual, or rolling."
|
|
parameters:
|
|
- description: "the upgradePolicy value to set"
|
|
name: "upgradePolicy"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.UpgradePolicy?alt=com.microsoft.azure.batch.protocol.models.UpgradePolicy&text=UpgradePolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PoolAddParameter withUpgradePolicy(UpgradePolicy upgradePolicy)"
|
|
desc: "Set describes an upgrade policy - automatic, manual, or rolling."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withUserAccounts(java.util.List<com.microsoft.azure.batch.protocol.models.UserAccount>)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withUserAccounts(List<UserAccount> userAccounts)"
|
|
name: "withUserAccounts(List<UserAccount> userAccounts)"
|
|
nameWithType: "PoolAddParameter.withUserAccounts(List<UserAccount> userAccounts)"
|
|
summary: "Set the user<wbr>Accounts value."
|
|
parameters:
|
|
- description: "the userAccounts value to set"
|
|
name: "userAccounts"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.UserAccount?alt=com.microsoft.azure.batch.protocol.models.UserAccount&text=UserAccount\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public PoolAddParameter withUserAccounts(List<UserAccount> userAccounts)"
|
|
desc: "Set the userAccounts value."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withVirtualMachineConfiguration(com.microsoft.azure.batch.protocol.models.VirtualMachineConfiguration)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)"
|
|
name: "withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)"
|
|
nameWithType: "PoolAddParameter.withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)"
|
|
summary: "Set this property must be specified."
|
|
parameters:
|
|
- description: "the virtualMachineConfiguration value to set"
|
|
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\" />"
|
|
syntax: "public PoolAddParameter withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)"
|
|
desc: "Set this property must be specified."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withVmSize(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolAddParameter.withVmSize(String vmSize)"
|
|
name: "withVmSize(String vmSize)"
|
|
nameWithType: "PoolAddParameter.withVmSize(String vmSize)"
|
|
summary: "Set for information about available VM sizes, see Sizes for Virtual Machines (Linux) (https://azure.<wbr>microsoft.<wbr>com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.<wbr>microsoft.<wbr>com/documentation/articles/virtual-machines-windows-sizes/)."
|
|
parameters:
|
|
- description: "the vmSize value to set"
|
|
name: "vmSize"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PoolAddParameter withVmSize(String vmSize)"
|
|
desc: "Set for information about available VM sizes, see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD\\_A0 and those with premium storage (STANDARD\\_GS, STANDARD\\_DS, and STANDARD\\_DSV2 series)."
|
|
returns:
|
|
description: "the PoolAddParameter object itself."
|
|
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\" />"
|
|
type: "class"
|
|
desc: "A Pool in the Azure Batch service to add."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.protocol.models"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|