DeploymentEnvironmentsClient Class

Package:
com.azure.developer.devcenter
Maven Artifact:
com.azure:azure-developer-devcenter:1.0.14
  • java.lang.Object
    • com.azure.developer.devcenter.DeploymentEnvironmentsClient

public final class DeploymentEnvironmentsClient

Initializes a new instance of the synchronous DeploymentEnvironmentsClient type.

Method Summary

Modifier and Type Method and Description
SyncPoller<DevCenterOperationDetails,DevCenterEnvironment> beginCreateOrUpdateEnvironment(String projectName, String userId, DevCenterEnvironment environment)

Creates or updates an environment.
SyncPoller<BinaryData,BinaryData> beginCreateOrUpdateEnvironment(String projectName, String userId, String environmentName, BinaryData body, RequestOptions requestOptions)

Creates or updates an environment.
SyncPoller<DevCenterOperationDetails,Void> beginDeleteEnvironment(String projectName, String userId, String environmentName)

Deletes an environment and all its associated resources.
SyncPoller<BinaryData,Void> beginDeleteEnvironment(String projectName, String userId, String environmentName, RequestOptions requestOptions)

Deletes an environment and all its associated resources.
DevCenterCatalog getCatalog(String projectName, String catalogName)

Gets the specified catalog within the project.
Response<BinaryData> getCatalogWithResponse(String projectName, String catalogName, RequestOptions requestOptions)

Gets the specified catalog within the project.
DevCenterEnvironment getEnvironment(String projectName, String userId, String environmentName)

Gets an environment.
EnvironmentDefinition getEnvironmentDefinition(String projectName, String catalogName, String definitionName)

Get an environment definition from a catalog.
Response<BinaryData> getEnvironmentDefinitionWithResponse(String projectName, String catalogName, String definitionName, RequestOptions requestOptions)

Get an environment definition from a catalog.
Response<BinaryData> getEnvironmentWithResponse(String projectName, String userId, String environmentName, RequestOptions requestOptions)

Gets an environment.
PagedIterable<DevCenterEnvironment> listAllEnvironments(String projectName)

Lists the environments for a project.
PagedIterable<BinaryData> listAllEnvironments(String projectName, RequestOptions requestOptions)

Lists the environments for a project.
PagedIterable<DevCenterCatalog> listCatalogs(String projectName)

Lists all of the catalogs available for a project.
PagedIterable<BinaryData> listCatalogs(String projectName, RequestOptions requestOptions)

Lists all of the catalogs available for a project.
PagedIterable<EnvironmentDefinition> listEnvironmentDefinitions(String projectName)

Lists all environment definitions available for a project.
PagedIterable<BinaryData> listEnvironmentDefinitions(String projectName, RequestOptions requestOptions)

Lists all environment definitions available for a project.
PagedIterable<EnvironmentDefinition> listEnvironmentDefinitionsByCatalog(String projectName, String catalogName)

Lists all environment definitions available within a catalog.
PagedIterable<BinaryData> listEnvironmentDefinitionsByCatalog(String projectName, String catalogName, RequestOptions requestOptions)

Lists all environment definitions available within a catalog.
PagedIterable<DevCenterEnvironment> listEnvironments(String projectName, String userId)

Lists the environments for a project and user.
PagedIterable<BinaryData> listEnvironments(String projectName, String userId, RequestOptions requestOptions)

Lists the environments for a project and user.
PagedIterable<DevCenterEnvironmentType> listEnvironmentTypes(String projectName)

Lists all environment types configured for a project.
PagedIterable<BinaryData> listEnvironmentTypes(String projectName, RequestOptions requestOptions)

Lists all environment types configured for a project.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

beginCreateOrUpdateEnvironment

public 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<T,U> for polling of properties of an environment.

beginCreateOrUpdateEnvironment

public SyncPoller<BinaryData,BinaryData> beginCreateOrUpdateEnvironment(String projectName, String userId, String environmentName, BinaryData body, 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<T,U> for polling of properties of an environment.

beginDeleteEnvironment

public 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<T,U> for polling of the current status of an async operation.

beginDeleteEnvironment

public SyncPoller<BinaryData,Void> beginDeleteEnvironment(String projectName, String userId, String environmentName, 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<T,U> for polling of the current status of an async operation.

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.

getCatalogWithResponse

public Response<BinaryData> getCatalogWithResponse(String projectName, String catalogName, 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<T>.

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.

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.

getEnvironmentDefinitionWithResponse

public Response<BinaryData> getEnvironmentDefinitionWithResponse(String projectName, String catalogName, String definitionName, 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<T>.

getEnvironmentWithResponse

public Response<BinaryData> getEnvironmentWithResponse(String projectName, String userId, String environmentName, 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<T>.

listAllEnvironments

public 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<T>.

listAllEnvironments

public PagedIterable<BinaryData> listAllEnvironments(String projectName, 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<T>.

listCatalogs

public 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<T>.

listCatalogs

public PagedIterable<BinaryData> listCatalogs(String projectName, 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<T>.

listEnvironmentDefinitions

public 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<T>.

listEnvironmentDefinitions

public PagedIterable<BinaryData> listEnvironmentDefinitions(String projectName, 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<T>.

listEnvironmentDefinitionsByCatalog

public 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<T>.

listEnvironmentDefinitionsByCatalog

public PagedIterable<BinaryData> listEnvironmentDefinitionsByCatalog(String projectName, String catalogName, 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<T>.

listEnvironments

public 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<T>.

listEnvironments

public PagedIterable<BinaryData> listEnvironments(String projectName, String userId, 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<T>.

listEnvironmentTypes

public 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<T>.

listEnvironmentTypes

public PagedIterable<BinaryData> listEnvironmentTypes(String projectName, 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<T>.

Applies to