Interface Environments
public interface Environments
Resource collection API of Environments.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new DtlEnvironment resource.void
Delete environment.void
delete
(String resourceGroupName, String labName, String username, String name, com.azure.core.util.Context context) Delete environment.void
deleteById
(String id) Delete environment.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Delete environment.Get environment.Get environment.com.azure.core.http.rest.Response<DtlEnvironment>
getByIdWithResponse
(String id, String expand, com.azure.core.util.Context context) Get environment.com.azure.core.http.rest.Response<DtlEnvironment>
getWithResponse
(String resourceGroupName, String labName, String username, String name, String expand, com.azure.core.util.Context context) Get environment.com.azure.core.http.rest.PagedIterable<DtlEnvironment>
List environments in a given user profile.com.azure.core.http.rest.PagedIterable<DtlEnvironment>
list
(String resourceGroupName, String labName, String username, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context) List environments in a given user profile.
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<DtlEnvironment> list(String resourceGroupName, String labName, String username) List environments in a given user profile.- Parameters:
resourceGroupName
- The name of the resource group.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
. - 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.
-
list
com.azure.core.http.rest.PagedIterable<DtlEnvironment> list(String resourceGroupName, String labName, String username, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context) List environments in a given user profile.- Parameters:
resourceGroupName
- The name of the resource group.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
. - 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.
-
getWithResponse
com.azure.core.http.rest.Response<DtlEnvironment> getWithResponse(String resourceGroupName, String labName, String username, String name, String expand, com.azure.core.util.Context context) Get environment.- Parameters:
resourceGroupName
- The name of the resource group.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
. - 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.
-
get
Get environment.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.name
- The name of the environment.- Returns:
- environment.
- 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.
-
delete
Delete environment. This operation can take a while to complete.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.name
- The name of the environment.- 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.
-
delete
void delete(String resourceGroupName, String labName, String username, String name, com.azure.core.util.Context context) Delete environment. This operation can take a while to complete.- Parameters:
resourceGroupName
- The name of the resource group.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.- 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.
-
getById
Get environment.- Parameters:
id
- the resource ID.- Returns:
- environment along with
Response
. - 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<DtlEnvironment> getByIdWithResponse(String id, String expand, com.azure.core.util.Context context) Get environment.- Parameters:
id
- the resource ID.expand
- Specify the $expand query. Example: 'properties($select=deploymentProperties)'.context
- The context to associate with this operation.- Returns:
- environment along with
Response
. - 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.
-
deleteById
Delete environment. This operation can take a while to complete.- Parameters:
id
- the resource ID.- 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.
-
deleteByIdWithResponse
Delete environment. This operation can take a while to complete.- Parameters:
id
- the resource ID.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.
-
define
Begins definition for a new DtlEnvironment resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new DtlEnvironment definition.
-