PublicIpAddressConfiguration Class

Package:

com.azure.resourcemanager.batch.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-batch:3.0.0

• java.lang.Object
• • com.azure.resourcemanager.batch.models.PublicIpAddressConfiguration

Implements

JsonSerializable<PublicIpAddressConfiguration>

public final class PublicIpAddressConfiguration
implements JsonSerializable<PublicIpAddressConfiguration>

The public IP Address configuration of the networking configuration of a Pool.

Constructor Summary

Constructor	Description
PublicIpAddressConfiguration()	Creates an instance of PublicIpAddressConfiguration class.

Method Summary

Modifier and Type	Method and Description
static PublicIpAddressConfiguration	fromJson(JsonReader jsonReader) Reads an instance of PublicIpAddressConfiguration from the JsonReader.
List<String>	ipAddressIds() Get the ipAddressIds property: The list of public IPs which the Batch service will use when provisioning Compute Nodes.
List<IPFamily>	ipFamilies() Get the ipFamilies property: The IP families used to specify IP versions available to the pool.
List<IPTag>	ipTags() Get the ipTags property: IP Tags that will applied to new Public IPs that Batch creates.
IpAddressProvisioningType	provision() Get the provision property: The provisioning type for Public IP Addresses for the Batch Pool.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
PublicIpAddressConfiguration	withIpAddressIds(List<String> ipAddressIds) Set the ipAddressIds property: The list of public IPs which the Batch service will use when provisioning Compute Nodes.
PublicIpAddressConfiguration	withIpFamilies(List<IPFamily> ipFamilies) Set the ipFamilies property: The IP families used to specify IP versions available to the pool.
PublicIpAddressConfiguration	withIpTags(List<IPTag> ipTags) Set the ipTags property: IP Tags that will applied to new Public IPs that Batch creates.
PublicIpAddressConfiguration	withProvision(IpAddressProvisioningType provision) Set the provision property: The provisioning type for Public IP Addresses for the Batch Pool.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PublicIpAddressConfiguration

public PublicIpAddressConfiguration()

Creates an instance of PublicIpAddressConfiguration class.

Method Details

fromJson

public static PublicIpAddressConfiguration fromJson(JsonReader jsonReader)

Reads an instance of PublicIpAddressConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of PublicIpAddressConfiguration if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the PublicIpAddressConfiguration.

ipAddressIds

public List<String> ipAddressIds()

Get the ipAddressIds property: The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 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 ipAddressIds value.

ipFamilies

public List<IPFamily> ipFamilies()

Get the ipFamilies property: The IP families used to specify IP versions available to the pool. IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

Returns:

the ipFamilies value.

ipTags

public List<IPTag> ipTags()

Get the ipTags property: IP Tags that will applied to new Public IPs that Batch creates.

Returns:

the ipTags value.

provision

public IpAddressProvisioningType provision()

Get the provision property: The provisioning type for Public IP Addresses for the Batch Pool. The default value is BatchManaged.

Returns:

the provision value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withIpAddressIds

public PublicIpAddressConfiguration withIpAddressIds(List<String> ipAddressIds)

Set the ipAddressIds property: The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 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:

ipAddressIds - the ipAddressIds value to set.

Returns:

the PublicIpAddressConfiguration object itself.

withIpFamilies

public PublicIpAddressConfiguration withIpFamilies(List<IPFamily> ipFamilies)

Set the ipFamilies property: The IP families used to specify IP versions available to the pool. IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

Parameters:

ipFamilies - the ipFamilies value to set.

Returns:

the PublicIpAddressConfiguration object itself.

withIpTags

public PublicIpAddressConfiguration withIpTags(List<IPTag> ipTags)

Set the ipTags property: IP Tags that will applied to new Public IPs that Batch creates.

Parameters:

ipTags - the ipTags value to set.

Returns:

the PublicIpAddressConfiguration object itself.

withProvision

public PublicIpAddressConfiguration withProvision(IpAddressProvisioningType provision)

Set the provision property: The provisioning type for Public IP Addresses for the Batch Pool. The default value is BatchManaged.

Parameters:

provision - the provision value to set.

Returns:

the PublicIpAddressConfiguration object itself.