Package com.azure.resourcemanager.apicenter.models

Interface Environments

public interface Environments
Resource collection API of Environments.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<Environment> list(String resourceGroupName, String serviceName, String workspaceName)
      Returns a collection of environments.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      Returns:
      the response of a Environment 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<Environment> list(String resourceGroupName, String serviceName, String workspaceName, String filter, com.azure.core.util.Context context)
      Returns a collection of environments.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      filter - OData filter parameter.
      context - The context to associate with this operation.
      Returns:
      the response of a Environment 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<Environment> getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String environmentName, com.azure.core.util.Context context)
      Returns details of the environment.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      environmentName - The name of the environment.
      context - The context to associate with this operation.
      Returns:
      environment entity.
      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

      Environment get(String resourceGroupName, String serviceName, String workspaceName, String environmentName)
      Returns details of the environment.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      environmentName - The name of the environment.
      Returns:
      environment entity.
      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 serviceName, String workspaceName, String environmentName, com.azure.core.util.Context context)
      Deletes the environment.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      environmentName - The name of the environment.
      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 serviceName, String workspaceName, String environmentName)
      Deletes the environment.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      environmentName - 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.

    • headWithResponse

      com.azure.core.http.rest.Response<Void> headWithResponse(String resourceGroupName, String serviceName, String workspaceName, String environmentName, com.azure.core.util.Context context)
      Checks if specified environment exists.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      environmentName - The name of the environment.
      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.

    • head

      void head(String resourceGroupName, String serviceName, String workspaceName, String environmentName)
      Checks if specified environment exists.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      environmentName - 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.

    • getById

      Environment getById(String id)
      Returns details of the environment.
      Parameters:
      id - the resource ID.
      Returns:
      environment entity.
      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<Environment> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Returns details of the environment.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      environment entity.
      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

      void deleteById(String id)
      Deletes the environment.
      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

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes the environment.
      Parameters:
      id - the resource ID.
      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.

    • define

      Environment.DefinitionStages.Blank define(String name)
      Begins definition for a new Environment resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Environment definition.