EnvironmentSettings | @azure/arm-labservices

Class representing a EnvironmentSettings.

Hierarchy

EnvironmentSettings

Index

Constructors

constructor

Methods

Constructors

constructor

new EnvironmentSettings(client: ManagedLabsClientContext): EnvironmentSettings

- Defined in operations/environmentSettings.ts:20
Create a EnvironmentSettings.

Parameters
- client: ManagedLabsClientContext
  
  Reference to the service client.
Returns EnvironmentSettings

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, environmentSetting: EnvironmentSetting, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/environmentSettings.ts:309
Create or replace an existing Environment Setting. This operation can take a while to complete

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- environmentSetting: EnvironmentSetting
  
  Represents settings of an environment, from which environment instances would be created
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod

beginDeleteMethod(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/environmentSettings.ts:332
Delete environment setting. This operation can take a while to complete

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginStart

beginStart(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/environmentSettings.ts:355
Starts a template by starting all resources inside the template. This operation can take a while to complete

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginStop

beginStop(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/environmentSettings.ts:378
Starts a template by starting all resources inside the template. This operation can take a while to complete

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

claimAny

claimAny(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
claimAny(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, callback: msRest.ServiceCallback<void>): void
claimAny(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

- Defined in operations/environmentSettings.ts:192
Claims a random environment for a user in an environment settings

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>
- Defined in operations/environmentSettings.ts:200
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/environmentSettings.ts:209
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

createOrUpdate

createOrUpdate(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, environmentSetting: EnvironmentSetting, options?: msRest.RequestOptionsBase): Promise<Models.EnvironmentSettingsCreateOrUpdateResponse>

- Defined in operations/environmentSettings.ts:117
Create or replace an existing Environment Setting. This operation can take a while to complete

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- environmentSetting: EnvironmentSetting
  
  Represents settings of an environment, from which environment instances would be created
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.EnvironmentSettingsCreateOrUpdateResponse>

Promise<Models.EnvironmentSettingsCreateOrUpdateResponse>

deleteMethod

deleteMethod(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/environmentSettings.ts:131
Delete environment setting. This operation can take a while to complete

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

get

get(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, options?: Models.EnvironmentSettingsGetOptionalParams): Promise<Models.EnvironmentSettingsGetResponse>
get(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, callback: msRest.ServiceCallback<EnvironmentSetting>): void
get(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, options: EnvironmentSettingsGetOptionalParams, callback: msRest.ServiceCallback<EnvironmentSetting>): void

- Defined in operations/environmentSettings.ts:75
Get environment setting

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- Optional options: Models.EnvironmentSettingsGetOptionalParams
Returns Promise<Models.EnvironmentSettingsGetResponse>

Promise<Models.EnvironmentSettingsGetResponse>
- Defined in operations/environmentSettings.ts:83
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- callback: msRest.ServiceCallback<EnvironmentSetting>
  
  The callback
Returns void
- Defined in operations/environmentSettings.ts:92
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- options: EnvironmentSettingsGetOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<EnvironmentSetting>
  
  The callback
Returns void

list

list(resourceGroupName: string, labAccountName: string, labName: string, options?: Models.EnvironmentSettingsListOptionalParams): Promise<Models.EnvironmentSettingsListResponse>
list(resourceGroupName: string, labAccountName: string, labName: string, callback: msRest.ServiceCallback<ResponseWithContinuationEnvironmentSetting>): void
list(resourceGroupName: string, labAccountName: string, labName: string, options: EnvironmentSettingsListOptionalParams, callback: msRest.ServiceCallback<ResponseWithContinuationEnvironmentSetting>): void

- Defined in operations/environmentSettings.ts:38
List environment setting in a given lab.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- Optional options: Models.EnvironmentSettingsListOptionalParams
Returns Promise<Models.EnvironmentSettingsListResponse>

Promise<Models.EnvironmentSettingsListResponse>
- Defined in operations/environmentSettings.ts:45
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- callback: msRest.ServiceCallback<ResponseWithContinuationEnvironmentSetting>
  
  The callback
Returns void
- Defined in operations/environmentSettings.ts:53
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- options: EnvironmentSettingsListOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<ResponseWithContinuationEnvironmentSetting>
  
  The callback
Returns void

listNext

listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.EnvironmentSettingsListNextResponse>
listNext(nextPageLink: string, callback: msRest.ServiceCallback<ResponseWithContinuationEnvironmentSetting>): void
listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ResponseWithContinuationEnvironmentSetting>): void

- Defined in operations/environmentSettings.ts:397
List environment setting in a given lab.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.EnvironmentSettingsListNextResponse>

Promise<Models.EnvironmentSettingsListNextResponse>
- Defined in operations/environmentSettings.ts:402
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<ResponseWithContinuationEnvironmentSetting>
  
  The callback
Returns void
- Defined in operations/environmentSettings.ts:408
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ResponseWithContinuationEnvironmentSetting>
  
  The callback
Returns void

publish

publish(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, publishPayload: PublishPayload, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
publish(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, publishPayload: PublishPayload, callback: msRest.ServiceCallback<void>): void
publish(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, publishPayload: PublishPayload, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

- Defined in operations/environmentSettings.ts:234
Provisions/deprovisions required resources for an environment setting based on current state of the lab/environment setting.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- publishPayload: PublishPayload
  
  Payload for Publish operation on EnvironmentSetting.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>
- Defined in operations/environmentSettings.ts:243
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- publishPayload: PublishPayload
  
  Payload for Publish operation on EnvironmentSetting.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/environmentSettings.ts:253
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- publishPayload: PublishPayload
  
  Payload for Publish operation on EnvironmentSetting.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

start

start(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/environmentSettings.ts:278
Starts a template by starting all resources inside the template. This operation can take a while to complete

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

stop

stop(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/environmentSettings.ts:293
Starts a template by starting all resources inside the template. This operation can take a while to complete

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

update

update(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, environmentSetting: EnvironmentSettingFragment, options?: msRest.RequestOptionsBase): Promise<Models.EnvironmentSettingsUpdateResponse>
update(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, environmentSetting: EnvironmentSettingFragment, callback: msRest.ServiceCallback<EnvironmentSetting>): void
update(resourceGroupName: string, labAccountName: string, labName: string, environmentSettingName: string, environmentSetting: EnvironmentSettingFragment, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<EnvironmentSetting>): void

- Defined in operations/environmentSettings.ts:147
Modify properties of environment setting.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- environmentSetting: EnvironmentSettingFragment
  
  Represents settings of an environment, from which environment instances would be created
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.EnvironmentSettingsUpdateResponse>

Promise<Models.EnvironmentSettingsUpdateResponse>
- Defined in operations/environmentSettings.ts:157
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- environmentSetting: EnvironmentSettingFragment
  
  Represents settings of an environment, from which environment instances would be created
- callback: msRest.ServiceCallback<EnvironmentSetting>
  
  The callback
Returns void
- Defined in operations/environmentSettings.ts:168
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- labAccountName: string
  
  The name of the lab Account.
- labName: string
  
  The name of the lab.
- environmentSettingName: string
  
  The name of the environment Setting.
- environmentSetting: EnvironmentSettingFragment
  
  Represents settings of an environment, from which environment instances would be created
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<EnvironmentSetting>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ManagedLabsClientContext

Returns EnvironmentSettings

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

labAccountName: string

labName: string

environmentSettingName: string

environmentSetting: EnvironmentSetting

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginDeleteMethod

Parameters

resourceGroupName: string

labAccountName: string

labName: string

environmentSettingName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginStart

Parameters

resourceGroupName: string

labAccountName: string

labName: string

environmentSettingName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginStop

Parameters

resourceGroupName: string

labAccountName: string

labName: string

environmentSettingName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

claimAny

Parameters

resourceGroupName: string

labAccountName: string

labName: string

environmentSettingName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

Parameters

resourceGroupName: string

labAccountName: string

labName: string

environmentSettingName: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

resourceGroupName: string

labAccountName: string

labName: string

environmentSettingName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<void>

Returns void

createOrUpdate

Parameters

resourceGroupName: string

labAccountName: string

labName: string

environmentSettingName: string

environmentSetting: EnvironmentSetting

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.EnvironmentSettingsCreateOrUpdateResponse>

deleteMethod

Parameters

resourceGroupName: string

labAccountName: string

labName: string