Pool Interface

Package:
com.azure.resourcemanager.devcenter.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-devcenter:1.0.0

public interface Pool

An immutable client-side representation of Pool.

Method Summary

Modifier and Type Method and Description
abstract Integer devBoxCount()

Gets the devBoxCount property: Indicates the number of provisioned Dev Boxes in this pool.
abstract String devBoxDefinitionName()

Gets the devBoxDefinitionName property: Name of a Dev Box definition in parent Project of this Pool.
abstract String displayName()

Gets the displayName property: The display name of the pool.
abstract HealthStatus healthStatus()

Gets the healthStatus property: Overall health status of the Pool.
abstract List<HealthStatusDetail> healthStatusDetails()

Gets the healthStatusDetails property: Details on the Pool health status to help diagnose issues.
abstract String id()

Gets the id property: Fully qualified resource Id for the resource.
abstract PoolInner innerModel()

Gets the inner com.azure.resourcemanager.devcenter.fluent.models.PoolInner object.
abstract LicenseType licenseType()

Gets the licenseType property: Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.
abstract LocalAdminStatus localAdministrator()

Gets the localAdministrator property: Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.
abstract String location()

Gets the location property: The geo-location where the resource lives.
abstract List<String> managedVirtualNetworkRegions()

Gets the managedVirtualNetworkRegions property: The regions of the managed virtual network (required when managedNetworkType is Managed).
abstract String name()

Gets the name property: The name of the resource.
abstract String networkConnectionName()

Gets the networkConnectionName property: Name of a Network Connection in parent Project of this Pool.
abstract ProvisioningState provisioningState()

Gets the provisioningState property: The provisioning state of the resource.
abstract Pool refresh()

Refreshes the resource to sync with Azure.
abstract Pool refresh(Context context)

Refreshes the resource to sync with Azure.
abstract Region region()

Gets the region of the resource.
abstract String regionName()

Gets the name of the resource region.
abstract String resourceGroupName()

Gets the name of the resource group.
abstract void runHealthChecks()

Triggers a refresh of the pool status.
abstract void runHealthChecks(Context context)

Triggers a refresh of the pool status.
abstract SingleSignOnStatus singleSignOnStatus()

Gets the singleSignOnStatus property: Indicates whether Dev Boxes in this pool are created with single sign on enabled.
abstract StopOnDisconnectConfiguration stopOnDisconnect()

Gets the stopOnDisconnect property: Stop on disconnect configuration settings for Dev Boxes created in this pool.
abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
abstract Map<String,String> tags()

Gets the tags property: Resource tags.
abstract String type()

Gets the type property: The type of the resource.
abstract Update update()

Begins update for the Pool resource.
abstract VirtualNetworkType virtualNetworkType()

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

Method Details

devBoxCount

public abstract Integer devBoxCount()

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

Returns:

the devBoxCount value.

devBoxDefinitionName

public abstract String devBoxDefinitionName()

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

Returns:

the devBoxDefinitionName value.

displayName

public abstract String displayName()

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

Returns:

the displayName value.

healthStatus

public abstract HealthStatus healthStatus()

Gets 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 abstract List<HealthStatusDetail> healthStatusDetails()

Gets 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.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

innerModel

public abstract PoolInner innerModel()

Gets the inner com.azure.resourcemanager.devcenter.fluent.models.PoolInner object.

Returns:

the inner object.

licenseType

public abstract LicenseType licenseType()

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

Returns:

the licenseType value.

localAdministrator

public abstract LocalAdminStatus localAdministrator()

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

Returns:

the localAdministrator value.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

managedVirtualNetworkRegions

public abstract List<String> managedVirtualNetworkRegions()

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

Returns:

the managedVirtualNetworkRegions value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

networkConnectionName

public abstract String networkConnectionName()

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

Returns:

the networkConnectionName value.

provisioningState

public abstract ProvisioningState provisioningState()

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

Returns:

the provisioningState value.

refresh

public abstract Pool refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Pool refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

runHealthChecks

public abstract void runHealthChecks()

Triggers a refresh of the pool status.

runHealthChecks

public abstract void runHealthChecks(Context context)

Triggers a refresh of the pool status.

Parameters:

context - The context to associate with this operation.

singleSignOnStatus

public abstract SingleSignOnStatus singleSignOnStatus()

Gets 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.

Returns:

the singleSignOnStatus value.

stopOnDisconnect

public abstract StopOnDisconnectConfiguration stopOnDisconnect()

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

Returns:

the stopOnDisconnect value.

systemData

public abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract Pool.Update update()

Begins update for the Pool resource.

Returns:

the stage of resource update.

virtualNetworkType

public abstract VirtualNetworkType virtualNetworkType()

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

Returns:

the virtualNetworkType value.

Applies to