Class DeploymentEnvironmentsClient

java.lang.Object
com.azure.developer.devcenter.DeploymentEnvironmentsClient

public final class DeploymentEnvironmentsClient extends Object
Initializes a new instance of the synchronous DeploymentEnvironmentsClient type.
  • Method Details

    • listAllEnvironments

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listAllEnvironments(String projectName, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists the environments for a project.

      Response Body Schema

       
       {
           parameters (Optional): {
               String: Object (Required)
           }
           name: String (Required)
           environmentType: String (Required)
           user: String (Optional)
           provisioningState: String(Succeeded/Failed/Canceled/Creating/Accepted/Deleting/Updating/Preparing/Running/Syncing/MovingResources/TransientFailure/StorageProvisioningFailed) (Optional)
           resourceGroupId: String (Optional)
           catalogName: String (Required)
           environmentDefinitionName: String (Required)
           error (Optional): {
               code: String (Required)
               message: String (Required)
               target: String (Optional)
               details (Optional): [
                   (recursive schema, see above)
               ]
               innererror (Optional): {
                   code: String (Optional)
                   innererror (Optional): (recursive schema, see innererror above)
               }
           }
       }
       
       
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of Environment items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • listEnvironments

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listEnvironments(String projectName, String userId, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists the environments for a project and user.

      Response Body Schema

       
       {
           parameters (Optional): {
               String: Object (Required)
           }
           name: String (Required)
           environmentType: String (Required)
           user: String (Optional)
           provisioningState: String(Succeeded/Failed/Canceled/Creating/Accepted/Deleting/Updating/Preparing/Running/Syncing/MovingResources/TransientFailure/StorageProvisioningFailed) (Optional)
           resourceGroupId: String (Optional)
           catalogName: String (Required)
           environmentDefinitionName: String (Required)
           error (Optional): {
               code: String (Required)
               message: String (Required)
               target: String (Optional)
               details (Optional): [
                   (recursive schema, see above)
               ]
               innererror (Optional): {
                   code: String (Optional)
                   innererror (Optional): (recursive schema, see innererror above)
               }
           }
       }
       
       
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of Environment items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • getEnvironmentWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getEnvironmentWithResponse(String projectName, String userId, String environmentName, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets an environment.

      Response Body Schema

       
       {
           parameters (Optional): {
               String: Object (Required)
           }
           name: String (Required)
           environmentType: String (Required)
           user: String (Optional)
           provisioningState: String(Succeeded/Failed/Canceled/Creating/Accepted/Deleting/Updating/Preparing/Running/Syncing/MovingResources/TransientFailure/StorageProvisioningFailed) (Optional)
           resourceGroupId: String (Optional)
           catalogName: String (Required)
           environmentDefinitionName: String (Required)
           error (Optional): {
               code: String (Required)
               message: String (Required)
               target: String (Optional)
               details (Optional): [
                   (recursive schema, see above)
               ]
               innererror (Optional): {
                   code: String (Optional)
                   innererror (Optional): (recursive schema, see innererror above)
               }
           }
       }
       
       
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      environmentName - Environment name.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      an environment along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • beginCreateOrUpdateEnvironment

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateOrUpdateEnvironment(String projectName, String userId, String environmentName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates or updates an environment.

      Request Body Schema

       
       {
           parameters (Optional): {
               String: Object (Required)
           }
           name: String (Required)
           environmentType: String (Required)
           user: String (Optional)
           provisioningState: String(Succeeded/Failed/Canceled/Creating/Accepted/Deleting/Updating/Preparing/Running/Syncing/MovingResources/TransientFailure/StorageProvisioningFailed) (Optional)
           resourceGroupId: String (Optional)
           catalogName: String (Required)
           environmentDefinitionName: String (Required)
           error (Optional): {
               code: String (Required)
               message: String (Required)
               target: String (Optional)
               details (Optional): [
                   (recursive schema, see above)
               ]
               innererror (Optional): {
                   code: String (Optional)
                   innererror (Optional): (recursive schema, see innererror above)
               }
           }
       }
       
       

      Response Body Schema

       
       {
           parameters (Optional): {
               String: Object (Required)
           }
           name: String (Required)
           environmentType: String (Required)
           user: String (Optional)
           provisioningState: String(Succeeded/Failed/Canceled/Creating/Accepted/Deleting/Updating/Preparing/Running/Syncing/MovingResources/TransientFailure/StorageProvisioningFailed) (Optional)
           resourceGroupId: String (Optional)
           catalogName: String (Required)
           environmentDefinitionName: String (Required)
           error (Optional): {
               code: String (Required)
               message: String (Required)
               target: String (Optional)
               details (Optional): [
                   (recursive schema, see above)
               ]
               innererror (Optional): {
                   code: String (Optional)
                   innererror (Optional): (recursive schema, see innererror above)
               }
           }
       }
       
       
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      environmentName - The name of the environment.
      body - Represents an environment.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of properties of an environment.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • beginDeleteEnvironment

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,Void> beginDeleteEnvironment(String projectName, String userId, String environmentName, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes an environment and all its associated resources.

      Response Body Schema

       
       {
           id: String (Required)
           name: String (Required)
           status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
           resourceId: String (Optional)
           startTime: OffsetDateTime (Optional)
           endTime: OffsetDateTime (Optional)
           percentComplete: Double (Optional)
           properties: Object (Optional)
           error (Optional): {
               code: String (Required)
               message: String (Required)
               target: String (Optional)
               details (Optional): [
                   (recursive schema, see above)
               ]
               innererror (Optional): {
                   code: String (Optional)
                   innererror (Optional): (recursive schema, see innererror above)
               }
           }
       }
       
       
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      environmentName - The name of the environment.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of the current status of an async operation.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • listCatalogs

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listCatalogs(String projectName, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all of the catalogs available for a project.

      Response Body Schema

       
       {
           name: String (Required)
       }
       
       
      Parameters:
      projectName - Name of the project.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of Catalog items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • getCatalogWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getCatalogWithResponse(String projectName, String catalogName, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets the specified catalog within the project.

      Response Body Schema

       
       {
           name: String (Required)
       }
       
       
      Parameters:
      projectName - Name of the project.
      catalogName - Name of the catalog.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the specified catalog within the project along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • listEnvironmentDefinitions

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listEnvironmentDefinitions(String projectName, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all environment definitions available for a project.

      Response Body Schema

       
       {
           id: String (Required)
           name: String (Required)
           catalogName: String (Required)
           description: String (Optional)
           parameters (Optional): [
                (Optional){
                   id: String (Required)
                   name: String (Optional)
                   description: String (Optional)
                   default: String (Optional)
                   type: String(array/boolean/integer/number/object/string) (Required)
                   readOnly: Boolean (Optional)
                   required: boolean (Required)
                   allowed (Optional): [
                       String (Optional)
                   ]
               }
           ]
           parametersSchema: String (Optional)
           templatePath: String (Optional)
       }
       
       
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of EnvironmentDefinition items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • listEnvironmentDefinitionsByCatalog

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listEnvironmentDefinitionsByCatalog(String projectName, String catalogName, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all environment definitions available within a catalog.

      Response Body Schema

       
       {
           id: String (Required)
           name: String (Required)
           catalogName: String (Required)
           description: String (Optional)
           parameters (Optional): [
                (Optional){
                   id: String (Required)
                   name: String (Optional)
                   description: String (Optional)
                   default: String (Optional)
                   type: String(array/boolean/integer/number/object/string) (Required)
                   readOnly: Boolean (Optional)
                   required: boolean (Required)
                   allowed (Optional): [
                       String (Optional)
                   ]
               }
           ]
           parametersSchema: String (Optional)
           templatePath: String (Optional)
       }
       
       
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      catalogName - The name of the catalog.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of EnvironmentDefinition items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • getEnvironmentDefinitionWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getEnvironmentDefinitionWithResponse(String projectName, String catalogName, String definitionName, com.azure.core.http.rest.RequestOptions requestOptions)
      Get an environment definition from a catalog.

      Response Body Schema

       
       {
           id: String (Required)
           name: String (Required)
           catalogName: String (Required)
           description: String (Optional)
           parameters (Optional): [
                (Optional){
                   id: String (Required)
                   name: String (Optional)
                   description: String (Optional)
                   default: String (Optional)
                   type: String(array/boolean/integer/number/object/string) (Required)
                   readOnly: Boolean (Optional)
                   required: boolean (Required)
                   allowed (Optional): [
                       String (Optional)
                   ]
               }
           ]
           parametersSchema: String (Optional)
           templatePath: String (Optional)
       }
       
       
      Parameters:
      projectName - Name of the project.
      catalogName - Name of the catalog.
      definitionName - Name of the environment definition.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      an environment definition from a catalog along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • listEnvironmentTypes

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listEnvironmentTypes(String projectName, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all environment types configured for a project.

      Response Body Schema

       
       {
           name: String (Required)
           deploymentTargetId: String (Required)
           status: String(Enabled/Disabled) (Required)
       }
       
       
      Parameters:
      projectName - Name of the project.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of EnvironmentType items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • listAllEnvironments

      public com.azure.core.http.rest.PagedIterable<DevCenterEnvironment> listAllEnvironments(String projectName)
      Lists the environments for a project.
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      Returns:
      paged collection of Environment items as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listEnvironments

      public com.azure.core.http.rest.PagedIterable<DevCenterEnvironment> listEnvironments(String projectName, String userId)
      Lists the environments for a project and user.
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      Returns:
      paged collection of Environment items as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getEnvironment

      public DevCenterEnvironment getEnvironment(String projectName, String userId, String environmentName)
      Gets an environment.
      Parameters:
      projectName - Name of the project.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      environmentName - Environment name.
      Returns:
      an environment.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginCreateOrUpdateEnvironment

      public com.azure.core.util.polling.SyncPoller<DevCenterOperationDetails,DevCenterEnvironment> beginCreateOrUpdateEnvironment(String projectName, String userId, DevCenterEnvironment environment)
      Creates or updates an environment.
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      environment - Represents an environment.
      Returns:
      the SyncPoller for polling of properties of an environment.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • beginDeleteEnvironment

      public com.azure.core.util.polling.SyncPoller<DevCenterOperationDetails,Void> beginDeleteEnvironment(String projectName, String userId, String environmentName)
      Deletes an environment and all its associated resources.
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      userId - The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.
      environmentName - The name of the environment.
      Returns:
      the SyncPoller for polling of the current status of an async operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listCatalogs

      public com.azure.core.http.rest.PagedIterable<DevCenterCatalog> listCatalogs(String projectName)
      Lists all of the catalogs available for a project.
      Parameters:
      projectName - Name of the project.
      Returns:
      paged collection of Catalog items as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getCatalog

      public DevCenterCatalog getCatalog(String projectName, String catalogName)
      Gets the specified catalog within the project.
      Parameters:
      projectName - Name of the project.
      catalogName - Name of the catalog.
      Returns:
      the specified catalog within the project.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listEnvironmentDefinitions

      public com.azure.core.http.rest.PagedIterable<EnvironmentDefinition> listEnvironmentDefinitions(String projectName)
      Lists all environment definitions available for a project.
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      Returns:
      paged collection of EnvironmentDefinition items as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listEnvironmentDefinitionsByCatalog

      public com.azure.core.http.rest.PagedIterable<EnvironmentDefinition> listEnvironmentDefinitionsByCatalog(String projectName, String catalogName)
      Lists all environment definitions available within a catalog.
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      catalogName - The name of the catalog.
      Returns:
      paged collection of EnvironmentDefinition items as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getEnvironmentDefinition

      public EnvironmentDefinition getEnvironmentDefinition(String projectName, String catalogName, String definitionName)
      Get an environment definition from a catalog.
      Parameters:
      projectName - Name of the project.
      catalogName - Name of the catalog.
      definitionName - Name of the environment definition.
      Returns:
      an environment definition from a catalog.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listEnvironmentTypes

      public com.azure.core.http.rest.PagedIterable<DevCenterEnvironmentType> listEnvironmentTypes(String projectName)
      Lists all environment types configured for a project.
      Parameters:
      projectName - Name of the project.
      Returns:
      paged collection of EnvironmentType items as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.