Interface EnvironmentsClient


public interface EnvironmentsClient
An instance of this class provides access to all the operations defined in EnvironmentsClient.
  • Method Details

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<EnvironmentResourceInner>,EnvironmentResourceInner> beginCreateOrUpdate(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:
      the SyncPoller for polling of 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.
    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<EnvironmentResourceInner>,EnvironmentResourceInner> beginCreateOrUpdate(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:
      the SyncPoller for polling of 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

      EnvironmentResourceInner 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

      EnvironmentResourceInner 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<EnvironmentResourceInner> 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

      EnvironmentResourceInner getByResourceGroup(String resourceGroupName, String environmentName)
      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.
    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<EnvironmentResourceInner>,EnvironmentResourceInner> beginUpdate(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:
      the SyncPoller for polling of 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.
    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<EnvironmentResourceInner>,EnvironmentResourceInner> beginUpdate(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:
      the SyncPoller for polling of 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

      EnvironmentResourceInner 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

      EnvironmentResourceInner 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.
    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(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.
    • delete

      void delete(String resourceGroupName, String environmentName)
      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<EnvironmentListResponseInner> 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

      EnvironmentListResponseInner listByResourceGroup(String resourceGroupName)
      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<EnvironmentListResponseInner> 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

      EnvironmentListResponseInner 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.