/
com.azure.resourcemanager.batch.models.NetworkConfiguration.yml
164 lines (164 loc) · 17.7 KB
/
com.azure.resourcemanager.batch.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
156
157
158
159
160
161
162
163
164
### YamlMime:JavaType
uid: "com.azure.resourcemanager.batch.models.NetworkConfiguration"
fullName: "com.azure.resourcemanager.batch.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 final class **NetworkConfiguration**"
constructors:
- uid: "com.azure.resourcemanager.batch.models.NetworkConfiguration.NetworkConfiguration()"
fullName: "com.azure.resourcemanager.batch.models.NetworkConfiguration.NetworkConfiguration()"
name: "NetworkConfiguration()"
nameWithType: "NetworkConfiguration.NetworkConfiguration()"
summary: "Creates an instance of Network<wbr>Configuration class."
syntax: "public NetworkConfiguration()"
desc: "Creates an instance of NetworkConfiguration class."
methods:
- uid: "com.azure.resourcemanager.batch.models.NetworkConfiguration.dynamicVnetAssignmentScope()"
fullName: "com.azure.resourcemanager.batch.models.NetworkConfiguration.dynamicVnetAssignmentScope()"
name: "dynamicVnetAssignmentScope()"
nameWithType: "NetworkConfiguration.dynamicVnetAssignmentScope()"
summary: "Get the dynamic<wbr>Vnet<wbr>Assignment<wbr>Scope property: The scope of dynamic vnet assignment."
syntax: "public DynamicVNetAssignmentScope dynamicVnetAssignmentScope()"
desc: "Get the dynamicVnetAssignmentScope property: The scope of dynamic vnet assignment."
returns:
description: "the dynamicVnetAssignmentScope value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.DynamicVNetAssignmentScope?alt=com.azure.resourcemanager.batch.models.DynamicVNetAssignmentScope&text=DynamicVNetAssignmentScope\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.NetworkConfiguration.enableAcceleratedNetworking()"
fullName: "com.azure.resourcemanager.batch.models.NetworkConfiguration.enableAcceleratedNetworking()"
name: "enableAcceleratedNetworking()"
nameWithType: "NetworkConfiguration.enableAcceleratedNetworking()"
summary: "Get the enable<wbr>Accelerated<wbr>Networking property: Whether this pool should enable accelerated networking."
syntax: "public Boolean enableAcceleratedNetworking()"
desc: "Get the enableAcceleratedNetworking property: Whether this pool should enable accelerated networking. 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.azure.resourcemanager.batch.models.NetworkConfiguration.endpointConfiguration()"
fullName: "com.azure.resourcemanager.batch.models.NetworkConfiguration.endpointConfiguration()"
name: "endpointConfiguration()"
nameWithType: "NetworkConfiguration.endpointConfiguration()"
summary: "Get the endpoint<wbr>Configuration property: The endpoint configuration for a pool."
syntax: "public PoolEndpointConfiguration endpointConfiguration()"
desc: "Get the endpointConfiguration property: The endpoint configuration for a pool. Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property."
returns:
description: "the endpointConfiguration value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.PoolEndpointConfiguration?alt=com.azure.resourcemanager.batch.models.PoolEndpointConfiguration&text=PoolEndpointConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.NetworkConfiguration.publicIpAddressConfiguration()"
fullName: "com.azure.resourcemanager.batch.models.NetworkConfiguration.publicIpAddressConfiguration()"
name: "publicIpAddressConfiguration()"
nameWithType: "NetworkConfiguration.publicIpAddressConfiguration()"
summary: "Get the public<wbr>IpAddress<wbr>Configuration property: This property is only supported on Pools with the virtual<wbr>Machine<wbr>Configuration property."
syntax: "public PublicIpAddressConfiguration publicIpAddressConfiguration()"
desc: "Get the publicIpAddressConfiguration property: This property is only supported on Pools with the virtualMachineConfiguration property."
returns:
description: "the publicIpAddressConfiguration value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.PublicIpAddressConfiguration?alt=com.azure.resourcemanager.batch.models.PublicIpAddressConfiguration&text=PublicIpAddressConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.NetworkConfiguration.subnetId()"
fullName: "com.azure.resourcemanager.batch.models.NetworkConfiguration.subnetId()"
name: "subnetId()"
nameWithType: "NetworkConfiguration.subnetId()"
summary: "Get the subnet<wbr>Id property: The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join."
syntax: "public String subnetId()"
desc: "Get the subnetId property: The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. 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 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. 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.azure.resourcemanager.batch.models.NetworkConfiguration.validate()"
fullName: "com.azure.resourcemanager.batch.models.NetworkConfiguration.validate()"
name: "validate()"
nameWithType: "NetworkConfiguration.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.batch.models.NetworkConfiguration.withDynamicVnetAssignmentScope(com.azure.resourcemanager.batch.models.DynamicVNetAssignmentScope)"
fullName: "com.azure.resourcemanager.batch.models.NetworkConfiguration.withDynamicVnetAssignmentScope(DynamicVNetAssignmentScope dynamicVnetAssignmentScope)"
name: "withDynamicVnetAssignmentScope(DynamicVNetAssignmentScope dynamicVnetAssignmentScope)"
nameWithType: "NetworkConfiguration.withDynamicVnetAssignmentScope(DynamicVNetAssignmentScope dynamicVnetAssignmentScope)"
summary: "Set the dynamic<wbr>Vnet<wbr>Assignment<wbr>Scope property: The scope of dynamic vnet assignment."
parameters:
- description: "the dynamicVnetAssignmentScope value to set."
name: "dynamicVnetAssignmentScope"
type: "<xref href=\"com.azure.resourcemanager.batch.models.DynamicVNetAssignmentScope?alt=com.azure.resourcemanager.batch.models.DynamicVNetAssignmentScope&text=DynamicVNetAssignmentScope\" data-throw-if-not-resolved=\"False\" />"
syntax: "public NetworkConfiguration withDynamicVnetAssignmentScope(DynamicVNetAssignmentScope dynamicVnetAssignmentScope)"
desc: "Set the dynamicVnetAssignmentScope property: The scope of dynamic vnet assignment."
returns:
description: "the NetworkConfiguration object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.NetworkConfiguration?alt=com.azure.resourcemanager.batch.models.NetworkConfiguration&text=NetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.NetworkConfiguration.withEnableAcceleratedNetworking(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.batch.models.NetworkConfiguration.withEnableAcceleratedNetworking(Boolean enableAcceleratedNetworking)"
name: "withEnableAcceleratedNetworking(Boolean enableAcceleratedNetworking)"
nameWithType: "NetworkConfiguration.withEnableAcceleratedNetworking(Boolean enableAcceleratedNetworking)"
summary: "Set the enable<wbr>Accelerated<wbr>Networking property: Whether this pool should enable accelerated networking."
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 the enableAcceleratedNetworking property: Whether this pool should enable accelerated networking. 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.azure.resourcemanager.batch.models.NetworkConfiguration?alt=com.azure.resourcemanager.batch.models.NetworkConfiguration&text=NetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.NetworkConfiguration.withEndpointConfiguration(com.azure.resourcemanager.batch.models.PoolEndpointConfiguration)"
fullName: "com.azure.resourcemanager.batch.models.NetworkConfiguration.withEndpointConfiguration(PoolEndpointConfiguration endpointConfiguration)"
name: "withEndpointConfiguration(PoolEndpointConfiguration endpointConfiguration)"
nameWithType: "NetworkConfiguration.withEndpointConfiguration(PoolEndpointConfiguration endpointConfiguration)"
summary: "Set the endpoint<wbr>Configuration property: The endpoint configuration for a pool."
parameters:
- description: "the endpointConfiguration value to set."
name: "endpointConfiguration"
type: "<xref href=\"com.azure.resourcemanager.batch.models.PoolEndpointConfiguration?alt=com.azure.resourcemanager.batch.models.PoolEndpointConfiguration&text=PoolEndpointConfiguration\" data-throw-if-not-resolved=\"False\" />"
syntax: "public NetworkConfiguration withEndpointConfiguration(PoolEndpointConfiguration endpointConfiguration)"
desc: "Set the endpointConfiguration property: The endpoint configuration for a pool. Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property."
returns:
description: "the NetworkConfiguration object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.NetworkConfiguration?alt=com.azure.resourcemanager.batch.models.NetworkConfiguration&text=NetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.NetworkConfiguration.withPublicIpAddressConfiguration(com.azure.resourcemanager.batch.models.PublicIpAddressConfiguration)"
fullName: "com.azure.resourcemanager.batch.models.NetworkConfiguration.withPublicIpAddressConfiguration(PublicIpAddressConfiguration publicIpAddressConfiguration)"
name: "withPublicIpAddressConfiguration(PublicIpAddressConfiguration publicIpAddressConfiguration)"
nameWithType: "NetworkConfiguration.withPublicIpAddressConfiguration(PublicIpAddressConfiguration publicIpAddressConfiguration)"
summary: "Set the public<wbr>IpAddress<wbr>Configuration property: This 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.azure.resourcemanager.batch.models.PublicIpAddressConfiguration?alt=com.azure.resourcemanager.batch.models.PublicIpAddressConfiguration&text=PublicIpAddressConfiguration\" data-throw-if-not-resolved=\"False\" />"
syntax: "public NetworkConfiguration withPublicIpAddressConfiguration(PublicIpAddressConfiguration publicIpAddressConfiguration)"
desc: "Set the publicIpAddressConfiguration property: This property is only supported on Pools with the virtualMachineConfiguration property."
returns:
description: "the NetworkConfiguration object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.NetworkConfiguration?alt=com.azure.resourcemanager.batch.models.NetworkConfiguration&text=NetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.NetworkConfiguration.withSubnetId(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.NetworkConfiguration.withSubnetId(String subnetId)"
name: "withSubnetId(String subnetId)"
nameWithType: "NetworkConfiguration.withSubnetId(String subnetId)"
summary: "Set the subnet<wbr>Id property: The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join."
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 subnetId property: The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. 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 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. 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.azure.resourcemanager.batch.models.NetworkConfiguration?alt=com.azure.resourcemanager.batch.models.NetworkConfiguration&text=NetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The network configuration for a pool."
metadata: {}
package: "com.azure.resourcemanager.batch.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-batch:1.1.0-beta.4