Interface Environments
public interface Environments
Resource collection API of Environments.
-
Method Summary
Modifier and TypeMethodDescriptioncreateOrUpdate
(String resourceGroupName, String environmentName, EnvironmentCreateOrUpdateParameters parameters) Create or update an environment in the specified subscription and resource group.createOrUpdate
(String resourceGroupName, String environmentName, EnvironmentCreateOrUpdateParameters parameters, com.azure.core.util.Context context) Create or update an environment in the specified subscription and resource group.void
deleteByResourceGroup
(String resourceGroupName, String environmentName) Deletes the environment with the specified name in the specified subscription and resource group.com.azure.core.http.rest.Response<Void>
deleteByResourceGroupWithResponse
(String resourceGroupName, String environmentName, com.azure.core.util.Context context) Deletes the environment with the specified name in the specified subscription and resource group.getByResourceGroup
(String resourceGroupName, String environmentName) Gets the environment with the specified name in the specified subscription and resource group.com.azure.core.http.rest.Response<EnvironmentResource>
getByResourceGroupWithResponse
(String resourceGroupName, String environmentName, String expand, com.azure.core.util.Context context) Gets the environment with the specified name in the specified subscription and resource group.listByResourceGroup
(String resourceGroupName) Lists all the available environments associated with the subscription and within the specified resource group.com.azure.core.http.rest.Response<EnvironmentListResponse>
listByResourceGroupWithResponse
(String resourceGroupName, com.azure.core.util.Context context) Lists all the available environments associated with the subscription and within the specified resource group.Lists all the available environments within a subscription, irrespective of the resource groups.com.azure.core.http.rest.Response<EnvironmentListResponse>
listBySubscriptionWithResponse
(com.azure.core.util.Context context) Lists all the available environments within a subscription, irrespective of the resource groups.update
(String resourceGroupName, String environmentName, EnvironmentUpdateParameters environmentUpdateParameters) Updates the environment with the specified name in the specified subscription and resource group.update
(String resourceGroupName, String environmentName, EnvironmentUpdateParameters environmentUpdateParameters, com.azure.core.util.Context context) Updates the environment with the specified name in the specified subscription and resource group.
-
Method Details
-
createOrUpdate
EnvironmentResource createOrUpdate(String resourceGroupName, String environmentName, EnvironmentCreateOrUpdateParameters parameters) Create or update an environment in the specified subscription and resource group.- Parameters:
resourceGroupName
- Name of an Azure Resource group.environmentName
- Name of the environment.parameters
- Parameters for creating an environment resource.- Returns:
- an environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource.
- 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.
-
createOrUpdate
EnvironmentResource createOrUpdate(String resourceGroupName, String environmentName, EnvironmentCreateOrUpdateParameters parameters, com.azure.core.util.Context context) Create or update an environment in the specified subscription and resource group.- Parameters:
resourceGroupName
- Name of an Azure Resource group.environmentName
- Name of the environment.parameters
- Parameters for creating an environment resource.context
- The context to associate with this operation.- Returns:
- an environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource.
- 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.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<EnvironmentResource> getByResourceGroupWithResponse(String resourceGroupName, String environmentName, String expand, com.azure.core.util.Context context) Gets the environment with the specified name in the specified subscription and resource group.- Parameters:
resourceGroupName
- Name of an Azure Resource group.environmentName
- The name of the Time Series Insights environment associated with the specified resource group.expand
- Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service.context
- The context to associate with this operation.- Returns:
- the environment with the specified name in the specified subscription and resource group 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.
-
getByResourceGroup
Gets the environment with the specified name in the specified subscription and resource group.- Parameters:
resourceGroupName
- Name of an Azure Resource group.environmentName
- The name of the Time Series Insights environment associated with the specified resource group.- Returns:
- the environment with the specified name in the specified subscription and resource group.
- 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.
-
update
EnvironmentResource update(String resourceGroupName, String environmentName, EnvironmentUpdateParameters environmentUpdateParameters) Updates the environment with the specified name in the specified subscription and resource group.- Parameters:
resourceGroupName
- Name of an Azure Resource group.environmentName
- The name of the Time Series Insights environment associated with the specified resource group.environmentUpdateParameters
- Request object that contains the updated information for the environment.- Returns:
- an environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource.
- 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.
-
update
EnvironmentResource update(String resourceGroupName, String environmentName, EnvironmentUpdateParameters environmentUpdateParameters, com.azure.core.util.Context context) Updates the environment with the specified name in the specified subscription and resource group.- Parameters:
resourceGroupName
- Name of an Azure Resource group.environmentName
- The name of the Time Series Insights environment associated with the specified resource group.environmentUpdateParameters
- Request object that contains the updated information for the environment.context
- The context to associate with this operation.- Returns:
- an environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource.
- 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.
-
deleteByResourceGroupWithResponse
com.azure.core.http.rest.Response<Void> deleteByResourceGroupWithResponse(String resourceGroupName, String environmentName, com.azure.core.util.Context context) Deletes the environment with the specified name in the specified subscription and resource group.- Parameters:
resourceGroupName
- Name of an Azure Resource group.environmentName
- The name of the Time Series Insights environment associated with the specified resource group.context
- The context to associate with this operation.- Returns:
- the
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.
-
deleteByResourceGroup
Deletes the environment with the specified name in the specified subscription and resource group.- Parameters:
resourceGroupName
- Name of an Azure Resource group.environmentName
- The name of the Time Series Insights environment associated with the specified resource group.- 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.
-
listByResourceGroupWithResponse
com.azure.core.http.rest.Response<EnvironmentListResponse> listByResourceGroupWithResponse(String resourceGroupName, com.azure.core.util.Context context) Lists all the available environments associated with the subscription and within the specified resource group.- Parameters:
resourceGroupName
- Name of an Azure Resource group.context
- The context to associate with this operation.- Returns:
- the response of the List Environments operation 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.
-
listByResourceGroup
Lists all the available environments associated with the subscription and within the specified resource group.- Parameters:
resourceGroupName
- Name of an Azure Resource group.- Returns:
- the response of the List Environments 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.
-
listBySubscriptionWithResponse
com.azure.core.http.rest.Response<EnvironmentListResponse> listBySubscriptionWithResponse(com.azure.core.util.Context context) Lists all the available environments within a subscription, irrespective of the resource groups.- Parameters:
context
- The context to associate with this operation.- Returns:
- the response of the List Environments operation 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.
-
listBySubscription
EnvironmentListResponse listBySubscription()Lists all the available environments within a subscription, irrespective of the resource groups.- Returns:
- the response of the List Environments operation.
- 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.
-