-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.microsoft.azure.batch.protocol.models.NetworkConfiguration.yml
155 lines (155 loc) · 16.5 KB
/
com.microsoft.azure.batch.protocol.models.NetworkConfiguration.yml
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
### YamlMime:JavaType
uid: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration"
fullName: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration"
name: "NetworkConfiguration"
nameWithType: "NetworkConfiguration"
summary: "The network configuration for a Pool."
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 **NetworkConfiguration**"
constructors:
- uid: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.NetworkConfiguration()"
fullName: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.NetworkConfiguration()"
name: "NetworkConfiguration()"
nameWithType: "NetworkConfiguration.NetworkConfiguration()"
syntax: "public NetworkConfiguration()"
methods:
- uid: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.dynamicVNetAssignmentScope()"
fullName: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.dynamicVNetAssignmentScope()"
name: "dynamicVNetAssignmentScope()"
nameWithType: "NetworkConfiguration.dynamicVNetAssignmentScope()"
summary: "Get possible values include: 'none', 'job'."
syntax: "public DynamicVNetAssignmentScope dynamicVNetAssignmentScope()"
desc: "Get possible values include: 'none', 'job'."
returns:
description: "the dynamicVNetAssignmentScope value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.DynamicVNetAssignmentScope?alt=com.microsoft.azure.batch.protocol.models.DynamicVNetAssignmentScope&text=DynamicVNetAssignmentScope\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.enableAcceleratedNetworking()"
fullName: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.enableAcceleratedNetworking()"
name: "enableAcceleratedNetworking()"
nameWithType: "NetworkConfiguration.enableAcceleratedNetworking()"
summary: "Get accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance."
syntax: "public Boolean enableAcceleratedNetworking()"
desc: "Get accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview."
returns:
description: "the enableAcceleratedNetworking 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.NetworkConfiguration.endpointConfiguration()"
fullName: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.endpointConfiguration()"
name: "endpointConfiguration()"
nameWithType: "NetworkConfiguration.endpointConfiguration()"
summary: "Get pool endpoint configuration is only supported on Pools with the virtual<wbr>Machine<wbr>Configuration property."
syntax: "public PoolEndpointConfiguration endpointConfiguration()"
desc: "Get pool endpoint configuration is only supported on Pools with the virtualMachineConfiguration property."
returns:
description: "the endpointConfiguration value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolEndpointConfiguration?alt=com.microsoft.azure.batch.protocol.models.PoolEndpointConfiguration&text=PoolEndpointConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.publicIPAddressConfiguration()"
fullName: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.publicIPAddressConfiguration()"
name: "publicIPAddressConfiguration()"
nameWithType: "NetworkConfiguration.publicIPAddressConfiguration()"
summary: "Get public IP configuration property is only supported on Pools with the virtual<wbr>Machine<wbr>Configuration property."
syntax: "public PublicIPAddressConfiguration publicIPAddressConfiguration()"
desc: "Get public IP configuration property is only supported on Pools with the virtualMachineConfiguration property."
returns:
description: "the publicIPAddressConfiguration value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PublicIPAddressConfiguration?alt=com.microsoft.azure.batch.protocol.models.PublicIPAddressConfiguration&text=PublicIPAddressConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.subnetId()"
fullName: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.subnetId()"
name: "subnetId()"
nameWithType: "NetworkConfiguration.subnetId()"
summary: "Get the virtual network must be in the same region and subscription as the Azure Batch Account."
syntax: "public String subnetId()"
desc: "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 Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate 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 Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the 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 with virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported, but for Pools created with cloudServiceConfiguration both ARM and classic virtual networks 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. 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:
description: "the subnetId 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.NetworkConfiguration.withDynamicVNetAssignmentScope(com.microsoft.azure.batch.protocol.models.DynamicVNetAssignmentScope)"
fullName: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.withDynamicVNetAssignmentScope(DynamicVNetAssignmentScope dynamicVNetAssignmentScope)"
name: "withDynamicVNetAssignmentScope(DynamicVNetAssignmentScope dynamicVNetAssignmentScope)"
nameWithType: "NetworkConfiguration.withDynamicVNetAssignmentScope(DynamicVNetAssignmentScope dynamicVNetAssignmentScope)"
summary: "Set possible values include: 'none', 'job'."
parameters:
- description: "the dynamicVNetAssignmentScope value to set"
name: "dynamicVNetAssignmentScope"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.DynamicVNetAssignmentScope?alt=com.microsoft.azure.batch.protocol.models.DynamicVNetAssignmentScope&text=DynamicVNetAssignmentScope\" data-throw-if-not-resolved=\"False\" />"
syntax: "public NetworkConfiguration withDynamicVNetAssignmentScope(DynamicVNetAssignmentScope dynamicVNetAssignmentScope)"
desc: "Set possible values include: 'none', 'job'."
returns:
description: "the NetworkConfiguration object itself."
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.NetworkConfiguration.withEnableAcceleratedNetworking(java.lang.Boolean)"
fullName: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.withEnableAcceleratedNetworking(Boolean enableAcceleratedNetworking)"
name: "withEnableAcceleratedNetworking(Boolean enableAcceleratedNetworking)"
nameWithType: "NetworkConfiguration.withEnableAcceleratedNetworking(Boolean enableAcceleratedNetworking)"
summary: "Set accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance."
parameters:
- description: "the enableAcceleratedNetworking value to set"
name: "enableAcceleratedNetworking"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public NetworkConfiguration withEnableAcceleratedNetworking(Boolean enableAcceleratedNetworking)"
desc: "Set accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview."
returns:
description: "the NetworkConfiguration object itself."
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.NetworkConfiguration.withEndpointConfiguration(com.microsoft.azure.batch.protocol.models.PoolEndpointConfiguration)"
fullName: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.withEndpointConfiguration(PoolEndpointConfiguration endpointConfiguration)"
name: "withEndpointConfiguration(PoolEndpointConfiguration endpointConfiguration)"
nameWithType: "NetworkConfiguration.withEndpointConfiguration(PoolEndpointConfiguration endpointConfiguration)"
summary: "Set pool endpoint configuration is only supported on Pools with the virtual<wbr>Machine<wbr>Configuration property."
parameters:
- description: "the endpointConfiguration value to set"
name: "endpointConfiguration"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolEndpointConfiguration?alt=com.microsoft.azure.batch.protocol.models.PoolEndpointConfiguration&text=PoolEndpointConfiguration\" data-throw-if-not-resolved=\"False\" />"
syntax: "public NetworkConfiguration withEndpointConfiguration(PoolEndpointConfiguration endpointConfiguration)"
desc: "Set pool endpoint configuration is only supported on Pools with the virtualMachineConfiguration property."
returns:
description: "the NetworkConfiguration object itself."
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.NetworkConfiguration.withPublicIPAddressConfiguration(com.microsoft.azure.batch.protocol.models.PublicIPAddressConfiguration)"
fullName: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.withPublicIPAddressConfiguration(PublicIPAddressConfiguration publicIPAddressConfiguration)"
name: "withPublicIPAddressConfiguration(PublicIPAddressConfiguration publicIPAddressConfiguration)"
nameWithType: "NetworkConfiguration.withPublicIPAddressConfiguration(PublicIPAddressConfiguration publicIPAddressConfiguration)"
summary: "Set public IP configuration property is only supported on Pools with the virtual<wbr>Machine<wbr>Configuration property."
parameters:
- description: "the publicIPAddressConfiguration value to set"
name: "publicIPAddressConfiguration"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PublicIPAddressConfiguration?alt=com.microsoft.azure.batch.protocol.models.PublicIPAddressConfiguration&text=PublicIPAddressConfiguration\" data-throw-if-not-resolved=\"False\" />"
syntax: "public NetworkConfiguration withPublicIPAddressConfiguration(PublicIPAddressConfiguration publicIPAddressConfiguration)"
desc: "Set public IP configuration property is only supported on Pools with the virtualMachineConfiguration property."
returns:
description: "the NetworkConfiguration object itself."
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.NetworkConfiguration.withSubnetId(java.lang.String)"
fullName: "com.microsoft.azure.batch.protocol.models.NetworkConfiguration.withSubnetId(String subnetId)"
name: "withSubnetId(String subnetId)"
nameWithType: "NetworkConfiguration.withSubnetId(String subnetId)"
summary: "Set the virtual network must be in the same region and subscription as the Azure Batch Account."
parameters:
- description: "the subnetId value to set"
name: "subnetId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public NetworkConfiguration withSubnetId(String subnetId)"
desc: "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 Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate 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 Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the 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 with virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported, but for Pools created with cloudServiceConfiguration both ARM and classic virtual networks 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. 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:
description: "the NetworkConfiguration object itself."
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\" />"
type: "class"
desc: "The network configuration for a Pool."
metadata: {}
package: "com.microsoft.azure.batch.protocol.models"
artifact: com.microsoft.azure:azure-batch:11.1.1