CloudImage
A cloud image that stores settings for individual cloud machine instances (the ID of an instance to start, post-launch sripts, and more). Cloud images are owned by cloud profiles.
Related Help article: Host Build Agents in Cloud
Properties
id
The ID of this cloud image. Typically consists of the truncated image name added to the parent profile ID.
name
The full image name. Includes the public cloud image name and ID.
href
The shortened (without the server URL) link to this cloud image.
profile
The cloud profile that owns this image.
instances
Currently existing virtual machines spawned from this image.
errorMessage
This property is deprecated, use error instead.
error
The CloudError object that stores information about a cloud image problem.
agentTypeId
The value of the typeId property of all agents spawned from this image. Allows you to identify sibling cloud agents.
agentPoolId
The ID of the agent pool to which agents spawned from this image belong.
operatingSystemName
The full name of the OS installed on virtual machines spawned from this image.
webUrl
Returns the full web link to access this cloud image.
newInstanceLimitation
Returns the reason why TeamCity cannot currently start new instances of this cloud image, or null if there are no such reasons.
locator
Schema
Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.
A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.