Interface Lab
-
public interface Lab
An immutable client-side representation of Lab.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Lab.Definition
The entirety of the Lab definition.static interface
Lab.DefinitionStages
The Lab definition stages.static interface
Lab.Update
The template for Lab update.static interface
Lab.UpdateStages
The Lab update stages.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AutoShutdownProfile
autoShutdownProfile()
Gets the autoShutdownProfile property: The resource auto shutdown configuration for the lab.ConnectionProfile
connectionProfile()
Gets the connectionProfile property: The connection profile for the lab.String
description()
Gets the description property: The description of the lab.String
id()
Gets the id property: Fully qualified resource Id for the resource.LabInner
innerModel()
Gets the inner com.azure.resourcemanager.labservices.fluent.models.LabInner object.String
labPlanId()
Gets the labPlanId property: The ID of the lab plan.String
location()
Gets the location property: The geo-location where the resource lives.String
name()
Gets the name property: The name of the resource.LabNetworkProfile
networkProfile()
Gets the networkProfile property: The network profile for the lab, typically applied via a lab plan.ProvisioningState
provisioningState()
Gets the provisioningState property: Current provisioning state of the lab.void
publish()
Publish or re-publish a lab.void
publish(com.azure.core.util.Context context)
Publish or re-publish a lab.Lab
refresh()
Refreshes the resource to sync with Azure.Lab
refresh(com.azure.core.util.Context context)
Refreshes the resource to sync with Azure.com.azure.core.management.Region
region()
Gets the region of the resource.String
regionName()
Gets the name of the resource region.RosterProfile
rosterProfile()
Gets the rosterProfile property: The lab user list management profile.SecurityProfile
securityProfile()
Gets the securityProfile property: The lab security profile.LabState
state()
Gets the state property: The lab state.void
syncGroup()
Action used to manually kick off an AAD group sync job.void
syncGroup(com.azure.core.util.Context context)
Action used to manually kick off an AAD group sync job.com.azure.core.management.SystemData
systemData()
Gets the systemData property: Metadata pertaining to creation and last modification of the lab.Map<String,String>
tags()
Gets the tags property: Resource tags.String
title()
Gets the title property: The title of the lab.String
type()
Gets the type property: The type of the resource.Lab.Update
update()
Begins update for the Lab resource.VirtualMachineProfile
virtualMachineProfile()
Gets the virtualMachineProfile property: The profile used for creating lab virtual machines.
-
-
-
Method Detail
-
id
String id()
Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()
Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()
Gets the type property: The type of the resource.- Returns:
- the type value.
-
location
String location()
Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
systemData
com.azure.core.management.SystemData systemData()
Gets the systemData property: Metadata pertaining to creation and last modification of the lab.- Returns:
- the systemData value.
-
provisioningState
ProvisioningState provisioningState()
Gets the provisioningState property: Current provisioning state of the lab.- Returns:
- the provisioningState value.
-
networkProfile
LabNetworkProfile networkProfile()
Gets the networkProfile property: The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created.- Returns:
- the networkProfile value.
-
state
LabState state()
Gets the state property: The lab state.- Returns:
- the state value.
-
autoShutdownProfile
AutoShutdownProfile autoShutdownProfile()
Gets the autoShutdownProfile property: The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle.- Returns:
- the autoShutdownProfile value.
-
connectionProfile
ConnectionProfile connectionProfile()
Gets the connectionProfile property: The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open.- Returns:
- the connectionProfile value.
-
virtualMachineProfile
VirtualMachineProfile virtualMachineProfile()
Gets the virtualMachineProfile property: The profile used for creating lab virtual machines.- Returns:
- the virtualMachineProfile value.
-
securityProfile
SecurityProfile securityProfile()
Gets the securityProfile property: The lab security profile.- Returns:
- the securityProfile value.
-
rosterProfile
RosterProfile rosterProfile()
Gets the rosterProfile property: The lab user list management profile.- Returns:
- the rosterProfile value.
-
labPlanId
String labPlanId()
Gets the labPlanId property: The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization..- Returns:
- the labPlanId value.
-
title
String title()
Gets the title property: The title of the lab.- Returns:
- the title value.
-
description
String description()
Gets the description property: The description of the lab.- Returns:
- the description value.
-
region
com.azure.core.management.Region region()
Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
String regionName()
Gets the name of the resource region.- Returns:
- the name of the resource region.
-
innerModel
LabInner innerModel()
Gets the inner com.azure.resourcemanager.labservices.fluent.models.LabInner object.- Returns:
- the inner object.
-
update
Lab.Update update()
Begins update for the Lab resource.- Returns:
- the stage of resource update.
-
refresh
Lab refresh()
Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Lab refresh(com.azure.core.util.Context context)
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
publish
void publish()
Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
publish
void publish(com.azure.core.util.Context context)
Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.- Parameters:
context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
syncGroup
void syncGroup()
Action used to manually kick off an AAD group sync job.- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
syncGroup
void syncGroup(com.azure.core.util.Context context)
Action used to manually kick off an AAD group sync job.- Parameters:
context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
-