Microservice

createMicroservice

Creates a new microservice for a project or application.

Arguments

Argument Name	Type	Description
projectName	String	(Required) The name for the project that must be unique among all projects.
applicationName	String	(Required) The name of the application.
microserviceName	String	(Required) The name of the microservice.
addDeployProcess	Boolean	If set to true, then a microservice process is also created.
definitionSource	MicroserviceDefinitionSource	Enum representing the source of the microservice definition.
definitionSourceParameters	Map	Parameters to resolve the source of the artifact representing microservice definition.
definitionType	MicroserviceDefinitionType	Microservice definition type.
deployParameters	Map	Parameters to supply to deploy procedure of microservice definition type provider.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
rollbackParameters	Map	Parameters to store microservice definition rollback parameters.

Argument Name

Type

Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

microserviceName

String

(Required) The name of the microservice.

addDeployProcess

Boolean

If set to true, then a microservice process is also created.

definitionSource

MicroserviceDefinitionSource

Enum representing the source of the microservice definition.

definitionSourceParameters

Map

Parameters to resolve the source of the artifact representing microservice definition.

definitionType

MicroserviceDefinitionType

Microservice definition type.

deployParameters

Map

Parameters to supply to deploy procedure of microservice definition type provider.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

rollbackParameters

Map

Parameters to store microservice definition rollback parameters.

Positional arguments

projectName, applicationName, microserviceName

Usage

ec-perl

$cmdr->createMicroservice(<projectName>, <applicationName>, <microserviceName>, {<optionals>});▼

ectool

ectool createMicroservice projectName applicationName microserviceName [optionals]▼

deleteMicroservice

Deletes a microservice application.

Arguments

Argument Name	Type	Description
projectName	String	(Required) The name for the project that must be unique among all projects.
applicationName	String	(Required) The name of the application.
microserviceName	String	(Required) The name of the microservice.

Argument Name

Type

Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

microserviceName

String

(Required) The name of the microservice.

Positional arguments

projectName, applicationName, microserviceName

Usage

ec-perl

$cmdr->deleteMicroservice(<projectName>, <applicationName>, <microserviceName>);▼

ectool

ectool deleteMicroservice projectName applicationName microserviceName▼

getMicroservice

Retrieves a microservice by name.

Arguments

Argument Name	Type	Description
projectName	String	(Required) The name for the project that must be unique among all projects.
applicationName	String	(Required) The name of the application.
microserviceName	String	(Required) The name of the microservice.

Argument Name

Type

Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

microserviceName

String

(Required) The name of the microservice.

Positional arguments

projectName, applicationName, microserviceName

Usage

ec-perl

$cmdr->getMicroservice(<projectName>, <applicationName>, <microserviceName>);▼

ectool

ectool getMicroservice projectName applicationName microserviceName▼

getMicroservices

Retrieves all microservices in a project or application.

Arguments

Argument Name	Type	Description
projectName	String	(Required) The name for the project that must be unique among all projects.
applicationName	String	(Required) The name of the application.

Argument Name

Type

Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

Positional arguments

projectName, applicationName

Usage

ec-perl

$cmdr->getMicroservices(<projectName>, <applicationName>);▼

ectool

ectool getMicroservices projectName applicationName▼

modifyMicroservice

Modifies an existing microservice.

Arguments

Argument Name	Type	Description
projectName	String	(Required) The name for the project that must be unique among all projects.
applicationName	String	(Required) The name of the application.
microserviceName	String	(Required) The name of the microservice.
definitionSource	MicroserviceDefinitionSource	Enum representing the source of the microservice definition.
definitionSourceParameters	Map	Parameters to resolve the source of the artifact representing microservice definition.
definitionType	MicroserviceDefinitionType	Microservice definition type.
deployParameters	Map	Parameters to supply to deploy procedure of microservice definition type provider.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
newName	String	The new name for an existing object that is being renamed.
rollbackParameters	Map	Parameters to store microservice definition rollback parameters.

Argument Name

Type

Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application.

microserviceName

String

(Required) The name of the microservice.

definitionSource

MicroserviceDefinitionSource

Enum representing the source of the microservice definition.

definitionSourceParameters

Map

Parameters to resolve the source of the artifact representing microservice definition.

definitionType

MicroserviceDefinitionType

Microservice definition type.

deployParameters

Map

Parameters to supply to deploy procedure of microservice definition type provider.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

newName

String

The new name for an existing object that is being renamed.

rollbackParameters

Map

Parameters to store microservice definition rollback parameters.

Positional arguments

projectName, applicationName, microserviceName

Usage

ec-perl

$cmdr->modifyMicroservice(<projectName>, <applicationName>, <microserviceName>, {<optionals>});▼

ectool

ectool modifyMicroservice projectName applicationName microserviceName [optionals]▼