CoreService

<back to all web services

CreateDeploymentTemplate

DeploymentTemplate - CRUD

Create a new deployment template

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
POST/api/deploymenttemplates/Create a new deployment template
POST/deploymenttemplates/Create a new deployment template
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Create a new deployment template
*/
@Api(Description="Create a new deployment template")
@ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=DeploymentTemplateDto::class, StatusCode=201)
open class CreateDeploymentTemplate : IBaseRequest, IHasTenantName, IPost
{
    @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    @Validate(Validator="NotEmpty")
    override var tenantName:String? = null

    /**
    * The version of the template structure
    */
    @ApiMember(DataType="integer", Description="The version of the template structure", IsRequired=true, ParameterType="body")
    @Validate(Validator="GreaterThan(0)")
    open var schemaVersion:Int? = null

    /**
    * The definition of the template (YAML)
    */
    @ApiMember(DataType="string", Description="The definition of the template (YAML)", Format="yaml", IsRequired=true, ParameterType="body")
    @Validate(Validator="NotEmpty")
    open var definition:String? = null

    /**
    * Specify the environments the deployment template is allowed for
    */
    @ApiMember(DataType="array", Description="Specify the environments the deployment template is allowed for", ParameterType="body")
    open var allowedEnvironments:IList<Environments>? = null

    /**
    * Specify the resource providers the deployment template is allowed for
    */
    @ApiMember(DataType="array", Description="Specify the resource providers the deployment template is allowed for", ParameterType="body")
    open var allowedResourceProviderIds:IList<UUID>? = null
}

enum class Environments
{
    Lab,
    Poc,
    Dev,
    Test,
    Int,
    Uat,
    Prod,
}

open class DeploymentTemplateDto : ConfigItemDto(), IHasTenantId
{
    override var tenantId:UUID? = null
    /**
    * The schema version of the attached definition (json/yaml structure)
    */
    open var schemaVersion:Int? = null
    /**
    * The version of the template (changes with each change to the template)
    */
    open var version:String? = null
    /**
    * The version in a numeric (padded) form which can be used for sorting
    */
    open var versionNumeric:Int? = null
    /**
    * The template definition as json/yaml
    */
    open var definition:String? = null
    /**
    * Template variables
    */
    open var variables:IList<VariableDto>? = null
    /**
    * Template parameters
    */
    open var parameters:IList<ParameterDto>? = null
    /**
    * Disabled templates should not be selected for deployments
    */
    open var isDisabled:Boolean? = null
    /**
    * The template with the highest version number has IsLatest set to true
    */
    open var isLatest:Boolean? = null
    /**
    * This template can be deployed only to the environments listed below
    */
    open var allowedEnvironments:IList<Environments>? = null
    /**
    * This template can be deployed only to the resource providers listed below
    */
    open var allowedResourceProviders:IList<ResourceProviderDto>? = null
    /**
    * An optional list of the child resource group templates
    */
    open var resourceGroupTemplates:IList<ResourceGroupTemplateDto>? = null
}

open class ConfigItemDto : IConfigItem
{
    open var id:UUID? = null
    open var name:String? = null
    override var displayName:String? = null
    override var description:String? = null
    open var objectType:ObjectTypes? = null
    override var selfLink:String? = null
    override var tags:IList<TagDto>? = null
    open var path:IList<PathItemDto>? = null
    open var created:Date? = null
    open var createUser:String? = null
    open var createUserId:String? = null
    open var modified:Date? = null
    open var modifyUser:String? = null
    open var modifyUserId:String? = null
    open var isDeleted:Boolean? = null
    open var deleted:Date? = null
    open var deleteUser:String? = null
    open var deleteUserId:String? = null
    open var links:IList<LinkDto>? = null
}

enum class ObjectTypes
{
    None,
    ConfigItem,
    Tenant,
    Collection,
    Resource,
    ComputeNode,
    VirtualMachine,
    PhysicalMachine,
    Disk,
    Subnet,
    IpAddress,
    Job,
    JobEvent,
    FreezePeriod,
    ResourceGroup,
    Deployment,
    ResourceGroupTemplate,
    DeploymentTemplate,
    ResourceProvider,
    GenericResource,
    Role,
    Permission,
    User,
    PatchingWindow,
    Update,
    ReportDefinition,
    TimeSeries,
    DataPoint,
    Action,
    ActionAssignment,
    UserNote,
}

open class TagDto
{
    open var name:String? = null
    open var value:String? = null
    open var isProtected:Boolean? = null
}

open class PathItemDto
{
    open var label:String? = null
    open var link:String? = null
    open var objectType:ObjectTypes? = null
    open var objectId:UUID? = null
}

open class LinkDto
{
    open var caption:String? = null
    open var rel:String? = null
    open var hRef:String? = null
    open var method:String? = null
}

open class VariableDto
{
    open var name:String? = null
    /**
    * Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false, List = [1,2,3,4]). Note: string values need extra quotes
    */
    open var value:String? = null
    /**
    * The data type of the value property
    */
    @SerializedName("type") open var Type:ValueDataType? = null
    open var description:String? = null
    open var isInherited:Boolean? = null
    open var environment:Environments? = null
}

enum class ValueDataType
{
    String,
    Number,
    Boolean,
    List,
}

open class ParameterDto
{
    open var name:String? = null
    open var description:String? = null
    /**
    * Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false). Note: string values need extra quotes
    */
    open var value:String? = null
    /**
    * Optional default value for the frontend. Needs to be in the same format as the value
    */
    @SerializedName("default") open var Default:String? = null
    /**
    * Optional parameters do not need to have a value. Default -> Optional=false
    */
    open var optional:Boolean? = null
    /**
    * The data type of the value and default property
    */
    @SerializedName("type") open var Type:ParameterValueType? = null
    open var validation:String? = null
}

enum class ParameterValueType
{
    String,
    Number,
    Boolean,
    SecureString,
}

open class ResourceProviderDto : ConfigItemDto(), IHasTenantId
{
    override var tenantId:UUID? = null
    /**
    * If environment cannot be detected while scanning, default environment will be used
    */
    open var defaultEnvironment:Environments? = null
    /**
    * List off all allowed environments for this resource provider
    */
    open var allowedEnvironments:IList<Environments>? = null
    /**
    * Defines the provider type (e.g. Azure, Aws)
    */
    @SerializedName("type") open var Type:ResourceProviderTypes? = null
    /**
    * Additional generic data which varies depending on ProviderType
    */
    open var config:IList<ProviderConfigEntryDto>? = null
    /**
    * Disabled ResourceProviders cannot be selected for new deployments
    */
    open var isDisabled:Boolean? = null
    /**
    * Shows if a ResourceProvider has been initialized and can accept deployments (resources)
    */
    open var isReadyForDeployments:Boolean? = null
    /**
    * The cost for the current month
    */
    open var costCurrentMonth:BigDecimal? = null
    /**
    * The cost for the last month
    */
    open var costLastMonth:BigDecimal? = null
    /**
    * The cost currency
    */
    open var costCurrency:String? = null
}

enum class ResourceProviderTypes
{
    Azure,
    AmazonWebServices,
    GoogleCloudPlatform,
    ActiveDirectoryServices,
    DomainNameSystem,
    SwisscomESC,
    AzureKeyVault,
}

open class ProviderConfigEntryDto
{
    open var name:String? = null
    open var value:String? = null
    open var isSecure:Boolean? = null
}

open class ResourceGroupTemplateDto : ConfigItemDto(), IHasTenantId
{
    override var tenantId:UUID? = null
    /**
    * The schema version of the attached definition (json/yaml structure)
    */
    open var schemaVersion:Int? = null
    /**
    * The version of the template (changes with each change to the template)
    */
    open var version:String? = null
    /**
    * The version in a numeric (padded) form which can be used for sorting
    */
    open var versionNumeric:Int? = null
    /**
    * The template definition/body either as json or yaml
    */
    open var definition:String? = null
    /**
    * Template variables
    */
    open var variables:IList<VariableDto>? = null
    /**
    * Template parameters
    */
    open var parameters:IList<ParameterDto>? = null
    /**
    * The template with the highest version number has IsLatest set to true
    */
    open var isLatest:Boolean? = null
    /**
    * List of contained resources
    */
    open var resourceTemplates:IList<ResourceTemplateDto>? = null
}

open class ResourceTemplateDto
{
    open var name:String? = null
    open var displayName:String? = null
    open var description:String? = null
    @SerializedName("type") open var Type:ObjectTypes? = null
}

Kotlin CreateDeploymentTemplate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/deploymenttemplates/ HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"tenantName":"String","schemaVersion":0,"definition":"String","allowedEnvironments":null,"allowedResourceProviderIds":null,"txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"tenantId":"00000000-0000-0000-0000-000000000000","schemaVersion":0,"version":"String","versionNumeric":0,"definition":"String","variables":null,"parameters":null,"isDisabled":false,"isLatest":false,"allowedEnvironments":null,"allowedResourceProviders":null,"resourceGroupTemplates":null,"id":"00000000-0000-0000-0000-000000000000","name":"String","displayName":"String","description":"String","objectType":"None","selfLink":"String","tags":null,"path":null,"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String","links":null}