Share via


LabPlanInner Class

public final class LabPlanInner
extends Resource

Lab Plans act as a permission container for creating labs via labs.azure.com. Additionally, they can provide a set of default configurations that will apply at the time of creating a lab, but these defaults can still be overwritten.

Constructor Summary

Constructor Description
LabPlanInner()

Creates an instance of LabPlanInner class.

Method Summary

Modifier and Type Method and Description
List<String> allowedRegions()

Get the allowedRegions property: The allowed regions for the lab creator to use when creating labs using this lab plan.

AutoShutdownProfile defaultAutoShutdownProfile()

Get the defaultAutoShutdownProfile property: The default lab shutdown profile.

ConnectionProfile defaultConnectionProfile()

Get the defaultConnectionProfile property: The default lab connection profile.

LabPlanNetworkProfile defaultNetworkProfile()

Get the defaultNetworkProfile property: The lab plan network profile.

static LabPlanInner fromJson(JsonReader jsonReader)

Reads an instance of LabPlanInner from the JsonReader.

String id()

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

Identity identity()

Get the identity property: Managed Identity Information.

String linkedLmsInstance()

Get the linkedLmsInstance property: Base Url of the lms instance this lab plan can link lab rosters against.

String name()

Get the name property: The name of the resource.

ProvisioningState provisioningState()

Get the provisioningState property: Current provisioning state of the lab plan.

String sharedGalleryId()

Get the sharedGalleryId property: Resource ID of the Shared Image Gallery attached to this lab plan.

SupportInfo supportInfo()

Get the supportInfo property: Support contact information and instructions for users of the lab plan.

SystemData systemData()

Get the systemData property: Metadata pertaining to creation and last modification of the lab plan.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

void validate()

Validates the instance.

LabPlanInner withAllowedRegions(List<String> allowedRegions)

Set the allowedRegions property: The allowed regions for the lab creator to use when creating labs using this lab plan.

LabPlanInner withDefaultAutoShutdownProfile(AutoShutdownProfile defaultAutoShutdownProfile)

Set the defaultAutoShutdownProfile property: The default lab shutdown profile.

LabPlanInner withDefaultConnectionProfile(ConnectionProfile defaultConnectionProfile)

Set the defaultConnectionProfile property: The default lab connection profile.

LabPlanInner withDefaultNetworkProfile(LabPlanNetworkProfile defaultNetworkProfile)

Set the defaultNetworkProfile property: The lab plan network profile.

LabPlanInner withIdentity(Identity identity)

Set the identity property: Managed Identity Information.

LabPlanInner withLinkedLmsInstance(String linkedLmsInstance)

Set the linkedLmsInstance property: Base Url of the lms instance this lab plan can link lab rosters against.

LabPlanInner withLocation(String location)
LabPlanInner withSharedGalleryId(String sharedGalleryId)

Set the sharedGalleryId property: Resource ID of the Shared Image Gallery attached to this lab plan.

LabPlanInner withSupportInfo(SupportInfo supportInfo)

Set the supportInfo property: Support contact information and instructions for users of the lab plan.

LabPlanInner withTags(Map<String,String> tags)

Methods inherited from ProxyResource

Methods inherited from Resource

Methods inherited from java.lang.Object

Constructor Details

LabPlanInner

public LabPlanInner()

Creates an instance of LabPlanInner class.

Method Details

allowedRegions

public List<String> allowedRegions()

Get the allowedRegions property: The allowed regions for the lab creator to use when creating labs using this lab plan.

Returns:

the allowedRegions value.

defaultAutoShutdownProfile

public AutoShutdownProfile defaultAutoShutdownProfile()

Get the defaultAutoShutdownProfile property: The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.

Returns:

the defaultAutoShutdownProfile value.

defaultConnectionProfile

public ConnectionProfile defaultConnectionProfile()

Get the defaultConnectionProfile property: The default lab connection profile. This can be changed on a lab resource and only provides a default profile.

Returns:

the defaultConnectionProfile value.

defaultNetworkProfile

public LabPlanNetworkProfile defaultNetworkProfile()

Get the defaultNetworkProfile property: The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan.

Returns:

the defaultNetworkProfile value.

fromJson

public static LabPlanInner fromJson(JsonReader jsonReader)

Reads an instance of LabPlanInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

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

Overrides:

LabPlanInner.id()

Returns:

the id value.

identity

public Identity identity()

Get the identity property: Managed Identity Information.

Returns:

the identity value.

linkedLmsInstance

public String linkedLmsInstance()

Get the linkedLmsInstance property: Base Url of the lms instance this lab plan can link lab rosters against.

Returns:

the linkedLmsInstance value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

LabPlanInner.name()

Returns:

the name value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: Current provisioning state of the lab plan.

Returns:

the provisioningState value.

sharedGalleryId

public String sharedGalleryId()

Get the sharedGalleryId property: Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs.

Returns:

the sharedGalleryId value.

supportInfo

public SupportInfo supportInfo()

Get the supportInfo property: Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan.

Returns:

the supportInfo value.

systemData

public SystemData systemData()

Get the systemData property: Metadata pertaining to creation and last modification of the lab plan.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

LabPlanInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

LabPlanInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withAllowedRegions

public LabPlanInner withAllowedRegions(List<String> allowedRegions)

Set the allowedRegions property: The allowed regions for the lab creator to use when creating labs using this lab plan.

Parameters:

allowedRegions - the allowedRegions value to set.

Returns:

the LabPlanInner object itself.

withDefaultAutoShutdownProfile

public LabPlanInner withDefaultAutoShutdownProfile(AutoShutdownProfile defaultAutoShutdownProfile)

Set the defaultAutoShutdownProfile property: The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.

Parameters:

defaultAutoShutdownProfile - the defaultAutoShutdownProfile value to set.

Returns:

the LabPlanInner object itself.

withDefaultConnectionProfile

public LabPlanInner withDefaultConnectionProfile(ConnectionProfile defaultConnectionProfile)

Set the defaultConnectionProfile property: The default lab connection profile. This can be changed on a lab resource and only provides a default profile.

Parameters:

defaultConnectionProfile - the defaultConnectionProfile value to set.

Returns:

the LabPlanInner object itself.

withDefaultNetworkProfile

public LabPlanInner withDefaultNetworkProfile(LabPlanNetworkProfile defaultNetworkProfile)

Set the defaultNetworkProfile property: The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan.

Parameters:

defaultNetworkProfile - the defaultNetworkProfile value to set.

Returns:

the LabPlanInner object itself.

withIdentity

public LabPlanInner withIdentity(Identity identity)

Set the identity property: Managed Identity Information.

Parameters:

identity - the identity value to set.

Returns:

the LabPlanInner object itself.

withLinkedLmsInstance

public LabPlanInner withLinkedLmsInstance(String linkedLmsInstance)

Set the linkedLmsInstance property: Base Url of the lms instance this lab plan can link lab rosters against.

Parameters:

linkedLmsInstance - the linkedLmsInstance value to set.

Returns:

the LabPlanInner object itself.

withLocation

public LabPlanInner withLocation(String location)

Overrides:

LabPlanInner.withLocation(String location)

Parameters:

location

withSharedGalleryId

public LabPlanInner withSharedGalleryId(String sharedGalleryId)

Set the sharedGalleryId property: Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs.

Parameters:

sharedGalleryId - the sharedGalleryId value to set.

Returns:

the LabPlanInner object itself.

withSupportInfo

public LabPlanInner withSupportInfo(SupportInfo supportInfo)

Set the supportInfo property: Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan.

Parameters:

supportInfo - the supportInfo value to set.

Returns:

the LabPlanInner object itself.

withTags

public LabPlanInner withTags(Map<String,String> tags)

Overrides:

LabPlanInner.withTags(Map<String,String> tags)

Parameters:

tags

Applies to