JobNetworkConfiguration.SubnetId Property

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

JobNetworkConfiguration.cs

Gets the ARM resource identifier of the virtual network subnet which nodes running tasks from the job will join for the duration of the task.

public string SubnetId { get; }

member this.SubnetId : string

Public ReadOnly Property SubnetId As String

Property Value

String

Remarks

The specified subnet should have enough free IP addresses to accommodate the number of nodes which will run tasks from the job. This can be up to the number of nodes in the pool.

This will only work on pools with the VirtualMachineConfiguration property.

This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.

The virtual network must be in the same region and subscription as the Azure Batch account. 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. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication - ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. 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