Поделиться через


PoolProperties Class

public final class PoolProperties
extends PoolUpdateProperties

Properties of a Pool.

Constructor Summary

Constructor Description
PoolProperties()

Creates an instance of PoolProperties class.

Method Summary

Modifier and Type Method and Description
Integer devBoxCount()

Get the devBoxCount property: Indicates the number of provisioned Dev Boxes in this pool.

static PoolProperties fromJson(JsonReader jsonReader)

Reads an instance of PoolProperties from the JsonReader.

HealthStatus healthStatus()

Get the healthStatus property: Overall health status of the Pool.

List<HealthStatusDetail> healthStatusDetails()

Get the healthStatusDetails property: Details on the Pool health status to help diagnose issues.

ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the resource.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

PoolProperties withDevBoxDefinitionName(String devBoxDefinitionName)

Set the devBoxDefinitionName property: Name of a Dev Box definition in parent Project of this Pool.

PoolProperties withDisplayName(String displayName)

Set the displayName property: The display name of the pool.

PoolProperties withLicenseType(LicenseType licenseType)

Set the licenseType property: Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.

PoolProperties withLocalAdministrator(LocalAdminStatus localAdministrator)

Set the localAdministrator property: Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.

PoolProperties withManagedVirtualNetworkRegions(List<String> managedVirtualNetworkRegions)

Set the managedVirtualNetworkRegions property: The regions of the managed virtual network (required when managedNetworkType is Managed).

PoolProperties withNetworkConnectionName(String networkConnectionName)

Set the networkConnectionName property: Name of a Network Connection in parent Project of this Pool.

PoolProperties withSingleSignOnStatus(SingleSignOnStatus singleSignOnStatus)

Set the singleSignOnStatus property: Indicates whether Dev Boxes in this pool are created with single sign on enabled.

PoolProperties withStopOnDisconnect(StopOnDisconnectConfiguration stopOnDisconnect)

Set the stopOnDisconnect property: Stop on disconnect configuration settings for Dev Boxes created in this pool.

PoolProperties withVirtualNetworkType(VirtualNetworkType virtualNetworkType)

Set the virtualNetworkType property: Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.

Methods inherited from PoolUpdateProperties

Methods inherited from java.lang.Object

Constructor Details

PoolProperties

public PoolProperties()

Creates an instance of PoolProperties class.

Method Details

devBoxCount

public Integer devBoxCount()

Get the devBoxCount property: Indicates the number of provisioned Dev Boxes in this pool.

Returns:

the devBoxCount value.

fromJson

public static PoolProperties fromJson(JsonReader jsonReader)

Reads an instance of PoolProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of PoolProperties 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 PoolProperties.

healthStatus

public HealthStatus healthStatus()

Get the healthStatus property: Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.

Returns:

the healthStatus value.

healthStatusDetails

public List<HealthStatusDetail> healthStatusDetails()

Get the healthStatusDetails property: Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state.

Returns:

the healthStatusDetails value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the resource.

Returns:

the provisioningState value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

PoolProperties.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

PoolProperties.validate()

withDevBoxDefinitionName

public PoolProperties withDevBoxDefinitionName(String devBoxDefinitionName)

Set the devBoxDefinitionName property: Name of a Dev Box definition in parent Project of this Pool.

Overrides:

PoolProperties.withDevBoxDefinitionName(String devBoxDefinitionName)

Parameters:

devBoxDefinitionName

withDisplayName

public PoolProperties withDisplayName(String displayName)

Set the displayName property: The display name of the pool.

Overrides:

PoolProperties.withDisplayName(String displayName)

Parameters:

displayName

withLicenseType

public PoolProperties withLicenseType(LicenseType licenseType)

Set the licenseType property: Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.

Overrides:

PoolProperties.withLicenseType(LicenseType licenseType)

Parameters:

licenseType

withLocalAdministrator

public PoolProperties withLocalAdministrator(LocalAdminStatus localAdministrator)

Set the localAdministrator property: Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.

Overrides:

PoolProperties.withLocalAdministrator(LocalAdminStatus localAdministrator)

Parameters:

localAdministrator

withManagedVirtualNetworkRegions

public PoolProperties withManagedVirtualNetworkRegions(List<String> managedVirtualNetworkRegions)

Set the managedVirtualNetworkRegions property: The regions of the managed virtual network (required when managedNetworkType is Managed).

Overrides:

PoolProperties.withManagedVirtualNetworkRegions(List<String> managedVirtualNetworkRegions)

Parameters:

managedVirtualNetworkRegions

withNetworkConnectionName

public PoolProperties withNetworkConnectionName(String networkConnectionName)

Set the networkConnectionName property: Name of a Network Connection in parent Project of this Pool.

Overrides:

PoolProperties.withNetworkConnectionName(String networkConnectionName)

Parameters:

networkConnectionName

withSingleSignOnStatus

public PoolProperties withSingleSignOnStatus(SingleSignOnStatus singleSignOnStatus)

Set the singleSignOnStatus property: Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.

Overrides:

PoolProperties.withSingleSignOnStatus(SingleSignOnStatus singleSignOnStatus)

Parameters:

singleSignOnStatus

withStopOnDisconnect

public PoolProperties withStopOnDisconnect(StopOnDisconnectConfiguration stopOnDisconnect)

Set the stopOnDisconnect property: Stop on disconnect configuration settings for Dev Boxes created in this pool.

Overrides:

PoolProperties.withStopOnDisconnect(StopOnDisconnectConfiguration stopOnDisconnect)

Parameters:

stopOnDisconnect

withVirtualNetworkType

public PoolProperties withVirtualNetworkType(VirtualNetworkType virtualNetworkType)

Set the virtualNetworkType property: Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.

Overrides:

PoolProperties.withVirtualNetworkType(VirtualNetworkType virtualNetworkType)

Parameters:

virtualNetworkType

Applies to