-
Notifications
You must be signed in to change notification settings - Fork 256
/
JobNetworkConfiguration.xml
94 lines (94 loc) · 5.62 KB
/
JobNetworkConfiguration.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<Type Name="JobNetworkConfiguration" FullName="Microsoft.Azure.Batch.JobNetworkConfiguration">
<TypeSignature Language="C#" Value="public class JobNetworkConfiguration" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JobNetworkConfiguration extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.JobNetworkConfiguration" />
<TypeSignature Language="VB.NET" Value="Public Class JobNetworkConfiguration" />
<TypeSignature Language="F#" Value="type JobNetworkConfiguration = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>14.0.0.0</AssemblyVersion>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
<AssemblyVersion>15.3.0.0</AssemblyVersion>
<AssemblyVersion>15.4.0.0</AssemblyVersion>
<AssemblyVersion>16.0.0.0</AssemblyVersion>
<AssemblyVersion>16.1.0.0</AssemblyVersion>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The network configuration for a job.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JobNetworkConfiguration (string subnetId = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string subnetId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.JobNetworkConfiguration.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional subnetId As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.JobNetworkConfiguration : string -> Microsoft.Azure.Batch.JobNetworkConfiguration" Usage="new Microsoft.Azure.Batch.JobNetworkConfiguration subnetId" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="subnetId" Type="System.String" />
</Parameters>
<Docs>
<param name="subnetId">The ARM resource identifier of the virtual network subnet which nodes running tasks from the job will join for
the duration of the task.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Batch.JobNetworkConfiguration" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SubnetId">
<MemberSignature Language="C#" Value="public string SubnetId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SubnetId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.JobNetworkConfiguration.SubnetId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SubnetId As String" />
<MemberSignature Language="F#" Value="member this.SubnetId : string" Usage="Microsoft.Azure.Batch.JobNetworkConfiguration.SubnetId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
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.
</summary>
<value>To be added.</value>
<remarks>
<para>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.</para>
<para>This will only work on
pools with the <see cref="P:Microsoft.Azure.Batch.CloudPool.VirtualMachineConfiguration" /> property.</para>
<para>This is of the form
/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.</para>
<para>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
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>