com.microsoft.azure.management.batch

Class NetworkConfiguration

java.lang.Object

com.microsoft.azure.management.batch.NetworkConfiguration

public class NetworkConfiguration
extends Object

The network configuration for a pool.

Constructor Summary

Constructors

Constructor and Description
NetworkConfiguration()

Method Summary

Modifier and Type	Method and Description
PoolEndpointConfiguration	endpointConfiguration() Get pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.
List<String>	publicIPs() Get the number of IPs specified here limits the maximum size of the Pool - 50 dedicated nodes or 20 low-priority nodes can be allocated for each public IP.
String	subnetId() Get the virtual network must be in the same region and subscription as the Azure Batch account.
NetworkConfiguration	withEndpointConfiguration(PoolEndpointConfiguration endpointConfiguration) Set pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.
NetworkConfiguration	withPublicIPs(List<String> publicIPs) Set the number of IPs specified here limits the maximum size of the Pool - 50 dedicated nodes or 20 low-priority nodes can be allocated for each public IP.
NetworkConfiguration	withSubnetId(String subnetId) Set the virtual network must be in the same region and subscription as the Azure Batch account.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetworkConfiguration

public NetworkConfiguration()

Method Detail

subnetId

public String subnetId()

Get the virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes, and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. For pools created via virtualMachineConfiguration the Batch account must have poolAllocationMode userSubscription in order to use a VNet. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

Returns:

the subnetId value

withSubnetId

public NetworkConfiguration withSubnetId(String subnetId)

Set the virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes, and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. For pools created via virtualMachineConfiguration the Batch account must have poolAllocationMode userSubscription in order to use a VNet. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

Parameters:

subnetId - the subnetId value to set

Returns:

the NetworkConfiguration object itself.

endpointConfiguration

public PoolEndpointConfiguration endpointConfiguration()

Get pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.

Returns:

the endpointConfiguration value

withEndpointConfiguration

public NetworkConfiguration withEndpointConfiguration(PoolEndpointConfiguration endpointConfiguration)

Set pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.

Parameters:

endpointConfiguration - the endpointConfiguration value to set

Returns:

the NetworkConfiguration object itself.

publicIPs

public List<String> publicIPs()

Get the number of IPs specified here limits the maximum size of the Pool - 50 dedicated nodes or 20 low-priority nodes can be allocated for each public IP. For example, a pool needing 150 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

Returns:

the publicIPs value

withPublicIPs

public NetworkConfiguration withPublicIPs(List<String> publicIPs)

Set the number of IPs specified here limits the maximum size of the Pool - 50 dedicated nodes or 20 low-priority nodes can be allocated for each public IP. For example, a pool needing 150 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

Parameters:

publicIPs - the publicIPs value to set

Returns:

the NetworkConfiguration object itself.