EnvironmentsClient Interface

public interface EnvironmentsClient

An instance of this class provides access to all the operations defined in EnvironmentsClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<DtlEnvironmentInner>,DtlEnvironmentInner> beginCreateOrUpdate(String resourceGroupName, String labName, String userName, String name, DtlEnvironmentInner dtlEnvironment)

Create or replace an existing environment.

abstract SyncPoller<PollResult<DtlEnvironmentInner>,DtlEnvironmentInner> beginCreateOrUpdate(String resourceGroupName, String labName, String userName, String name, DtlEnvironmentInner dtlEnvironment, Context context)

Create or replace an existing environment.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String userName, String name)

Delete environment.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String userName, String name, Context context)

Delete environment.

abstract DtlEnvironmentInner createOrUpdate(String resourceGroupName, String labName, String userName, String name, DtlEnvironmentInner dtlEnvironment)

Create or replace an existing environment.

abstract DtlEnvironmentInner createOrUpdate(String resourceGroupName, String labName, String userName, String name, DtlEnvironmentInner dtlEnvironment, Context context)

Create or replace an existing environment.

abstract void delete(String resourceGroupName, String labName, String userName, String name)

Delete environment.

abstract void delete(String resourceGroupName, String labName, String userName, String name, Context context)

Delete environment.

abstract DtlEnvironmentInner get(String resourceGroupName, String labName, String userName, String name)

Get environment.

abstract Response<DtlEnvironmentInner> getWithResponse(String resourceGroupName, String labName, String userName, String name, String expand, Context context)

Get environment.

abstract PagedIterable<DtlEnvironmentInner> list(String resourceGroupName, String labName, String userName)

List environments in a given user profile.

abstract PagedIterable<DtlEnvironmentInner> list(String resourceGroupName, String labName, String userName, String expand, String filter, Integer top, String orderby, Context context)

List environments in a given user profile.

abstract DtlEnvironmentInner update(String resourceGroupName, String labName, String userName, String name, DtlEnvironmentFragment dtlEnvironment)

Allows modifying tags of environments.

abstract Response<DtlEnvironmentInner> updateWithResponse(String resourceGroupName, String labName, String userName, String name, DtlEnvironmentFragment dtlEnvironment, Context context)

Allows modifying tags of environments.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<PollResult<DtlEnvironmentInner>,DtlEnvironmentInner> beginCreateOrUpdate(String resourceGroupName, String labName, String userName, String name, DtlEnvironmentInner dtlEnvironment)

Create or replace an existing environment. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
name - The name of the environment.
dtlEnvironment - An environment, which is essentially an ARM template deployment.

Returns:

the SyncPoller<T,U> for polling of an environment, which is essentially an ARM template deployment.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<DtlEnvironmentInner>,DtlEnvironmentInner> beginCreateOrUpdate(String resourceGroupName, String labName, String userName, String name, DtlEnvironmentInner dtlEnvironment, Context context)

Create or replace an existing environment. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
name - The name of the environment.
dtlEnvironment - An environment, which is essentially an ARM template deployment.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of an environment, which is essentially an ARM template deployment.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String userName, String name)

Delete environment. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
name - The name of the environment.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String userName, String name, Context context)

Delete environment. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
name - The name of the environment.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

createOrUpdate

public abstract DtlEnvironmentInner createOrUpdate(String resourceGroupName, String labName, String userName, String name, DtlEnvironmentInner dtlEnvironment)

Create or replace an existing environment. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
name - The name of the environment.
dtlEnvironment - An environment, which is essentially an ARM template deployment.

Returns:

an environment, which is essentially an ARM template deployment.

createOrUpdate

public abstract DtlEnvironmentInner createOrUpdate(String resourceGroupName, String labName, String userName, String name, DtlEnvironmentInner dtlEnvironment, Context context)

Create or replace an existing environment. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
name - The name of the environment.
dtlEnvironment - An environment, which is essentially an ARM template deployment.
context - The context to associate with this operation.

Returns:

an environment, which is essentially an ARM template deployment.

delete

public abstract void delete(String resourceGroupName, String labName, String userName, String name)

Delete environment. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
name - The name of the environment.

delete

public abstract void delete(String resourceGroupName, String labName, String userName, String name, Context context)

Delete environment. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
name - The name of the environment.
context - The context to associate with this operation.

get

public abstract DtlEnvironmentInner get(String resourceGroupName, String labName, String userName, String name)

Get environment.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
name - The name of the environment.

Returns:

environment.

getWithResponse

public abstract Response<DtlEnvironmentInner> getWithResponse(String resourceGroupName, String labName, String userName, String name, String expand, Context context)

Get environment.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
name - The name of the environment.
expand - Specify the $expand query. Example: 'properties($select=deploymentProperties)'.
context - The context to associate with this operation.

Returns:

environment along with Response<T>.

list

public abstract PagedIterable<DtlEnvironmentInner> list(String resourceGroupName, String labName, String userName)

List environments in a given user profile.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<DtlEnvironmentInner> list(String resourceGroupName, String labName, String userName, String expand, String filter, Integer top, String orderby, Context context)

List environments in a given user profile.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
expand - Specify the $expand query. Example: 'properties($select=deploymentProperties)'.
filter - The filter to apply to the operation. Example: '$filter=contains(name,'myName').
top - The maximum number of resources to return from the operation. Example: '$top=10'.
orderby - The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
context - The context to associate with this operation.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

update

public abstract DtlEnvironmentInner update(String resourceGroupName, String labName, String userName, String name, DtlEnvironmentFragment dtlEnvironment)

Allows modifying tags of environments. All other properties will be ignored.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
name - The name of the environment.
dtlEnvironment - An environment, which is essentially an ARM template deployment.

Returns:

an environment, which is essentially an ARM template deployment.

updateWithResponse

public abstract Response<DtlEnvironmentInner> updateWithResponse(String resourceGroupName, String labName, String userName, String name, DtlEnvironmentFragment dtlEnvironment, Context context)

Allows modifying tags of environments. All other properties will be ignored.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
labName - The name of the lab.
userName - The name of the user profile.
name - The name of the environment.
dtlEnvironment - An environment, which is essentially an ARM template deployment.
context - The context to associate with this operation.

Returns:

an environment, which is essentially an ARM template deployment along with Response<T>.

Applies to