Package com.azure.developer.devcenter

Class EnvironmentsClient

java.lang.Object
com.azure.developer.devcenter.EnvironmentsClient
public final class EnvironmentsClient extends Object
Initializes a new instance of the synchronous DevCenterClient type.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>
    beginCustomEnvironmentAction(String projectName, String userId, String environmentName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
    Executes a custom action.
    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 it's associated resources.
    com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>
    beginDeleteEnvironmentAction(String projectName, String userId, String environmentName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
    Executes a delete action.
    com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>
    beginDeployEnvironmentAction(String projectName, String userId, String environmentName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
    Executes a deploy action.
    com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
    getCatalogItemVersionWithResponse(String projectName, String catalogItemId, String version, com.azure.core.http.rest.RequestOptions requestOptions)
    Get a specific catalog item version from a project.
    com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
    getCatalogItemWithResponse(String projectName, String catalogItemId, com.azure.core.http.rest.RequestOptions requestOptions)
    Get a catalog item from a project.
    com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
    getEnvironmentByUserWithResponse(String projectName, String userId, String environmentName, com.azure.core.http.rest.RequestOptions requestOptions)
    Gets an environment.
    com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>
    listArtifactsByEnvironment(String projectName, String userId, String environmentName, com.azure.core.http.rest.RequestOptions requestOptions)
    Lists the artifacts for an environment.
    com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>
    listArtifactsByEnvironmentAndPath(String projectName, String userId, String environmentName, String artifactPath, com.azure.core.http.rest.RequestOptions requestOptions)
    Lists the artifacts for an environment at a specified path, or returns the file at the path.
    com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>
    listCatalogItems(String projectName, com.azure.core.http.rest.RequestOptions requestOptions)
    Lists latest version of all catalog items available for a project.
    com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>
    listCatalogItemVersions(String projectName, String catalogItemId, com.azure.core.http.rest.RequestOptions requestOptions)
    List all versions of a catalog item from a project.
    com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>
    listEnvironments(String projectName, com.azure.core.http.rest.RequestOptions requestOptions)
    Lists the environments for a project.
    com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>
    listEnvironmentsByUser(String projectName, String userId, com.azure.core.http.rest.RequestOptions requestOptions)
    Lists the environments for a project and user.
    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.
    com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
    updateEnvironmentWithResponse(String projectName, String userId, String environmentName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
    Partially updates an environment.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • listEnvironments

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

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      topIntegerNoThe maximum number of resources to return from the operation. Example: 'top=10'.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema 

      
 {
     description: String (Optional)
     catalogName: String (Optional)
     catalogItemName: String (Optional)
     parameters: Object (Optional)
     scheduledTasks (Optional): {
         String (Optional): {
             type: String(AutoExpire) (Required)
             enabled: String(Enabled/Disabled) (Optional)
             startTime: OffsetDateTime (Required)
         }
     }
     tags (Optional): {
         String: String (Optional)
     }
     name: String (Optional)
     environmentType: String (Required)
     owner: String (Optional)
     provisioningState: String (Optional)
     resourceGroupId: 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:
      results of the environment list operation 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.

    • listEnvironmentsByUser

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

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      topIntegerNoThe maximum number of resources to return from the operation. Example: 'top=10'.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema 

      
 {
     description: String (Optional)
     catalogName: String (Optional)
     catalogItemName: String (Optional)
     parameters: Object (Optional)
     scheduledTasks (Optional): {
         String (Optional): {
             type: String(AutoExpire) (Required)
             enabled: String(Enabled/Disabled) (Optional)
             startTime: OffsetDateTime (Required)
         }
     }
     tags (Optional): {
         String: String (Optional)
     }
     name: String (Optional)
     environmentType: String (Required)
     owner: String (Optional)
     provisioningState: String (Optional)
     resourceGroupId: String (Optional)
 }
      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:
      results of the environment list operation 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.

    • getEnvironmentByUserWithResponse

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

      Response Body Schema 

      
 {
     description: String (Optional)
     catalogName: String (Optional)
     catalogItemName: String (Optional)
     parameters: Object (Optional)
     scheduledTasks (Optional): {
         String (Optional): {
             type: String(AutoExpire) (Required)
             enabled: String(Enabled/Disabled) (Optional)
             startTime: OffsetDateTime (Required)
         }
     }
     tags (Optional): {
         String: String (Optional)
     }
     name: String (Optional)
     environmentType: String (Required)
     owner: String (Optional)
     provisioningState: String (Optional)
     resourceGroupId: String (Optional)
 }
      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:
      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 

      
 {
     description: String (Optional)
     catalogName: String (Optional)
     catalogItemName: String (Optional)
     parameters: Object (Optional)
     scheduledTasks (Optional): {
         String (Optional): {
             type: String(AutoExpire) (Required)
             enabled: String(Enabled/Disabled) (Optional)
             startTime: OffsetDateTime (Required)
         }
     }
     tags (Optional): {
         String: String (Optional)
     }
     name: String (Optional)
     environmentType: String (Required)
     owner: String (Optional)
     provisioningState: String (Optional)
     resourceGroupId: String (Optional)
 }

      Response Body Schema 

      
 {
     description: String (Optional)
     catalogName: String (Optional)
     catalogItemName: String (Optional)
     parameters: Object (Optional)
     scheduledTasks (Optional): {
         String (Optional): {
             type: String(AutoExpire) (Required)
             enabled: String(Enabled/Disabled) (Optional)
             startTime: OffsetDateTime (Required)
         }
     }
     tags (Optional): {
         String: String (Optional)
     }
     name: String (Optional)
     environmentType: String (Required)
     owner: String (Optional)
     provisioningState: String (Optional)
     resourceGroupId: String (Optional)
 }
      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 a 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.

    • updateEnvironmentWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> updateEnvironmentWithResponse(String projectName, String userId, String environmentName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
      Partially updates an environment.

      Request Body Schema 

      
 {
     description: String (Optional)
     catalogName: String (Optional)
     catalogItemName: String (Optional)
     parameters: Object (Optional)
     scheduledTasks (Optional): {
         String (Optional): {
             type: String(AutoExpire) (Required)
             enabled: String(Enabled/Disabled) (Optional)
             startTime: OffsetDateTime (Required)
         }
     }
     tags (Optional): {
         String: String (Optional)
     }
 }

      Response Body Schema 

      
 {
     description: String (Optional)
     catalogName: String (Optional)
     catalogItemName: String (Optional)
     parameters: Object (Optional)
     scheduledTasks (Optional): {
         String (Optional): {
             type: String(AutoExpire) (Required)
             enabled: String(Enabled/Disabled) (Optional)
             startTime: OffsetDateTime (Required)
         }
     }
     tags (Optional): {
         String: String (Optional)
     }
     name: String (Optional)
     environmentType: String (Required)
     owner: String (Optional)
     provisioningState: String (Optional)
     resourceGroupId: String (Optional)
 }
      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 - Updatable environment properties.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      properties of 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.

    • 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 it's 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.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of long-running 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.

    • beginDeployEnvironmentAction

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginDeployEnvironmentAction(String projectName, String userId, String environmentName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
      Executes a deploy action.

      Request Body Schema 

      
 {
     actionId: String (Required)
     parameters: Object (Optional)
 }
      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 - Action properties overriding the environment's default values.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of long-running 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.

    • beginDeleteEnvironmentAction

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginDeleteEnvironmentAction(String projectName, String userId, String environmentName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
      Executes a delete action.

      Request Body Schema 

      
 {
     actionId: String (Required)
     parameters: Object (Optional)
 }
      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 - Action properties overriding the environment's default values.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of long-running 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.

    • beginCustomEnvironmentAction

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCustomEnvironmentAction(String projectName, String userId, String environmentName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
      Executes a custom action.

      Request Body Schema 

      
 {
     actionId: String (Required)
     parameters: Object (Optional)
 }
      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 - Action properties overriding the environment's default values.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of long-running 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.

    • listArtifactsByEnvironment

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listArtifactsByEnvironment(String projectName, String userId, String environmentName, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists the artifacts for an environment.

      Response Body Schema 

      
 {
     id: String (Optional)
     name: String (Optional)
     isDirectory: Boolean (Optional)
     downloadUri: String (Optional)
     fileSize: Float (Optional)
     createdTime: OffsetDateTime (Optional)
     lastModifiedTime: OffsetDateTime (Optional)
 }
      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:
      results of the artifact list operation 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.

    • listArtifactsByEnvironmentAndPath

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listArtifactsByEnvironmentAndPath(String projectName, String userId, String environmentName, String artifactPath, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists the artifacts for an environment at a specified path, or returns the file at the path.

      Response Body Schema 

      
 {
     id: String (Optional)
     name: String (Optional)
     isDirectory: Boolean (Optional)
     downloadUri: String (Optional)
     fileSize: Float (Optional)
     createdTime: OffsetDateTime (Optional)
     lastModifiedTime: OffsetDateTime (Optional)
 }
      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.
      artifactPath - The path of the artifact.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      results of the artifact list operation 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.

    • listCatalogItems

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listCatalogItems(String projectName, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists latest version of all catalog items available for a project.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      topIntegerNoThe maximum number of resources to return from the operation. Example: 'top=10'.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema 

      
 {
     id: String (Optional)
     name: String (Optional)
     catalogName: 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:
      results of the catalog item list operation 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.

    • getCatalogItemWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getCatalogItemWithResponse(String projectName, String catalogItemId, com.azure.core.http.rest.RequestOptions requestOptions)
      Get a catalog item from a project.

      Response Body Schema 

      
 {
     id: String (Optional)
     name: String (Optional)
     catalogName: String (Optional)
 }
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      catalogItemId - The unique id of the catalog item.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      a catalog item from a 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.

    • listCatalogItemVersions

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listCatalogItemVersions(String projectName, String catalogItemId, com.azure.core.http.rest.RequestOptions requestOptions)
      List all versions of a catalog item from a project.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      topIntegerNoThe maximum number of resources to return from the operation. Example: 'top=10'.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema 

      
 {
     catalogItemId: String (Optional)
     catalogItemName: String (Optional)
     catalogName: String (Optional)
     version: String (Optional)
     summary: String (Optional)
     description: String (Optional)
     templatePath: String (Optional)
     parametersSchema: String (Optional)
     parameters (Optional): [
          (Optional){
             id: String (Optional)
             name: String (Optional)
             description: String (Optional)
             default: Object (Optional)
             type: String(array/boolean/integer/null/number/object/string) (Optional)
             readOnly: Boolean (Optional)
             required: Boolean (Optional)
             allowed (Optional): [
                 Object (Optional)
             ]
         }
     ]
     actions (Optional): [
          (Optional){
             id: String (Optional)
             name: String (Optional)
             description: String (Optional)
             parametersSchema: String (Optional)
             parameters (Optional): [
                 (recursive schema, see above)
             ]
             type: String(Custom/Deploy/Delete) (Optional)
             typeName: String (Optional)
             runner: String (Optional)
         }
     ]
     runner: String (Optional)
     status: String(Enabled/Disabled) (Optional)
     eligibleForLatestVersion: Boolean (Optional)
 }
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      catalogItemId - The unique id of the catalog item.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      results of the catalog item list operation 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.

    • getCatalogItemVersionWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getCatalogItemVersionWithResponse(String projectName, String catalogItemId, String version, com.azure.core.http.rest.RequestOptions requestOptions)
      Get a specific catalog item version from a project.

      Response Body Schema 

      
 {
     catalogItemId: String (Optional)
     catalogItemName: String (Optional)
     catalogName: String (Optional)
     version: String (Optional)
     summary: String (Optional)
     description: String (Optional)
     templatePath: String (Optional)
     parametersSchema: String (Optional)
     parameters (Optional): [
          (Optional){
             id: String (Optional)
             name: String (Optional)
             description: String (Optional)
             default: Object (Optional)
             type: String(array/boolean/integer/null/number/object/string) (Optional)
             readOnly: Boolean (Optional)
             required: Boolean (Optional)
             allowed (Optional): [
                 Object (Optional)
             ]
         }
     ]
     actions (Optional): [
          (Optional){
             id: String (Optional)
             name: String (Optional)
             description: String (Optional)
             parametersSchema: String (Optional)
             parameters (Optional): [
                 (recursive schema, see above)
             ]
             type: String(Custom/Deploy/Delete) (Optional)
             typeName: String (Optional)
             runner: String (Optional)
         }
     ]
     runner: String (Optional)
     status: String(Enabled/Disabled) (Optional)
     eligibleForLatestVersion: Boolean (Optional)
 }
      Parameters:
      projectName - The DevCenter Project upon which to execute operations.
      catalogItemId - The unique id of the catalog item.
      version - The version of the catalog item.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      a specific catalog item version from a 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.

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

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      topIntegerNoThe maximum number of resources to return from the operation. Example: 'top=10'.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema 

      
 {
     name: String (Optional)
     deploymentTargetId: String (Optional)
     status: String(Enabled/Disabled) (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:
      result of the environment type list operation 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.