CoreService

<back to all web services

CreateDeployment

Deployment - CRUD

Creates a new deployment

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
POST/api/deployments/Creates a new deployment
POST/deployments/Creates a new deployment
"use strict";
/** @typedef {'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'} */
export var ObjectTypes;
(function (ObjectTypes) {
    ObjectTypes["None"] = "None"
    ObjectTypes["ConfigItem"] = "ConfigItem"
    ObjectTypes["Tenant"] = "Tenant"
    ObjectTypes["Collection"] = "Collection"
    ObjectTypes["Resource"] = "Resource"
    ObjectTypes["ComputeNode"] = "ComputeNode"
    ObjectTypes["VirtualMachine"] = "VirtualMachine"
    ObjectTypes["PhysicalMachine"] = "PhysicalMachine"
    ObjectTypes["Disk"] = "Disk"
    ObjectTypes["Subnet"] = "Subnet"
    ObjectTypes["IPAddress"] = "IPAddress"
    ObjectTypes["Job"] = "Job"
    ObjectTypes["JobEvent"] = "JobEvent"
    ObjectTypes["FreezePeriod"] = "FreezePeriod"
    ObjectTypes["ResourceGroup"] = "ResourceGroup"
    ObjectTypes["Deployment"] = "Deployment"
    ObjectTypes["ResourceGroupTemplate"] = "ResourceGroupTemplate"
    ObjectTypes["DeploymentTemplate"] = "DeploymentTemplate"
    ObjectTypes["ResourceProvider"] = "ResourceProvider"
    ObjectTypes["GenericResource"] = "GenericResource"
    ObjectTypes["Role"] = "Role"
    ObjectTypes["Permission"] = "Permission"
    ObjectTypes["User"] = "User"
    ObjectTypes["PatchingWindow"] = "PatchingWindow"
    ObjectTypes["Update"] = "Update"
    ObjectTypes["ReportDefinition"] = "ReportDefinition"
    ObjectTypes["TimeSeries"] = "TimeSeries"
    ObjectTypes["DataPoint"] = "DataPoint"
    ObjectTypes["Action"] = "Action"
    ObjectTypes["ActionAssignment"] = "ActionAssignment"
    ObjectTypes["UserNote"] = "UserNote"
})(ObjectTypes || (ObjectTypes = {}));
export class TagDto {
    /** @param {{name?:string,value?:string,isProtected?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    name;
    /** @type {?string} */
    value;
    /** @type {boolean} */
    isProtected;
}
export class PathItemDto {
    /** @param {{label?:string,link?:string,objectType?:ObjectTypes,objectId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    label;
    /** @type {string} */
    link;
    /** @type {ObjectTypes} */
    objectType;
    /** @type {string} */
    objectId;
}
export class LinkDto {
    /** @param {{caption?:string,rel?:string,hRef?:string,method?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    caption;
    /** @type {string} */
    rel;
    /** @type {string} */
    hRef;
    /** @type {string} */
    method;
}
export class ConfigItemDto {
    /** @param {{id?:string,name?:string,displayName?:string,description?:string,objectType?:ObjectTypes,selfLink?:string,tags?:IList<TagDto>,path?:IList<PathItemDto>,created?:string,createUser?:string,createUserId?:string,modified?:string,modifyUser?:string,modifyUserId?:string,isDeleted?:boolean,deleted?:string,deleteUser?:string,deleteUserId?:string,links?:IList<LinkDto>}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    name;
    /** @type {string} */
    displayName;
    /** @type {?string} */
    description;
    /** @type {ObjectTypes} */
    objectType;
    /** @type {string} */
    selfLink;
    /** @type {IList<TagDto>} */
    tags;
    /** @type {IList<PathItemDto>} */
    path;
    /** @type {string} */
    created;
    /** @type {string} */
    createUser;
    /** @type {string} */
    createUserId;
    /** @type {string} */
    modified;
    /** @type {string} */
    modifyUser;
    /** @type {string} */
    modifyUserId;
    /** @type {boolean} */
    isDeleted;
    /** @type {?string} */
    deleted;
    /** @type {?string} */
    deleteUser;
    /** @type {?string} */
    deleteUserId;
    /** @type {IList<LinkDto>} */
    links;
}
/** @typedef {'None'|'Starting'|'Running'|'Stopping'|'Stopped'|'Restarting'|'Deleting'|'Unknown'} */
export var OperationalStates;
(function (OperationalStates) {
    OperationalStates["None"] = "None"
    OperationalStates["Starting"] = "Starting"
    OperationalStates["Running"] = "Running"
    OperationalStates["Stopping"] = "Stopping"
    OperationalStates["Stopped"] = "Stopped"
    OperationalStates["Restarting"] = "Restarting"
    OperationalStates["Deleting"] = "Deleting"
    OperationalStates["Unknown"] = "Unknown"
})(OperationalStates || (OperationalStates = {}));
/** @typedef {'New'|'Deploying'|'Deployed'|'Removing'|'Removed'|'Failure'|'Imported'} */
export var LifecycleStates;
(function (LifecycleStates) {
    LifecycleStates["New"] = "New"
    LifecycleStates["Deploying"] = "Deploying"
    LifecycleStates["Deployed"] = "Deployed"
    LifecycleStates["Removing"] = "Removing"
    LifecycleStates["Removed"] = "Removed"
    LifecycleStates["Failure"] = "Failure"
    LifecycleStates["Imported"] = "Imported"
})(LifecycleStates || (LifecycleStates = {}));
/** @typedef {'Lab'|'Poc'|'Dev'|'Test'|'Int'|'Uat'|'Prod'} */
export var Environments;
(function (Environments) {
    Environments["Lab"] = "Lab"
    Environments["Poc"] = "Poc"
    Environments["Dev"] = "Dev"
    Environments["Test"] = "Test"
    Environments["Int"] = "Int"
    Environments["Uat"] = "Uat"
    Environments["Prod"] = "Prod"
})(Environments || (Environments = {}));
/** @typedef {'String'|'Number'|'Boolean'|'SecureString'} */
export var ParameterValueType;
(function (ParameterValueType) {
    ParameterValueType["String"] = "String"
    ParameterValueType["Number"] = "Number"
    ParameterValueType["Boolean"] = "Boolean"
    ParameterValueType["SecureString"] = "SecureString"
})(ParameterValueType || (ParameterValueType = {}));
export class ParameterDto {
    /** @param {{name?:string,description?:string,value?:string,default?:string,optional?:boolean,type?:ParameterValueType,validation?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    name;
    /** @type {?string} */
    description;
    /**
     * @type {?string}
     * @description Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false). Note: string values need extra quotes */
    value;
    /**
     * @type {?string}
     * @description Optional default value for the frontend. Needs to be in the same format as the value */
    default;
    /**
     * @type {boolean}
     * @description Optional parameters do not need to have a value. Default -> Optional=false */
    optional;
    /**
     * @type {ParameterValueType}
     * @description The data type of the value and default property */
    type;
    /** @type {?string} */
    validation;
}
/** @typedef {'String'|'Number'|'Boolean'|'List'} */
export var ValueDataType;
(function (ValueDataType) {
    ValueDataType["String"] = "String"
    ValueDataType["Number"] = "Number"
    ValueDataType["Boolean"] = "Boolean"
    ValueDataType["List"] = "List"
})(ValueDataType || (ValueDataType = {}));
export class VariableDto {
    /** @param {{name?:string,value?:string,type?:ValueDataType,description?:string,isInherited?:boolean,environment?:Environments}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    name;
    /**
     * @type {string}
     * @description 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 */
    value;
    /**
     * @type {ValueDataType}
     * @description The data type of the value property */
    type;
    /** @type {?string} */
    description;
    /** @type {boolean} */
    isInherited;
    /** @type {?Environments} */
    environment;
}
/** @typedef {'Native'|'Foreign'|'Mixed'} */
export var ResourceCompositions;
(function (ResourceCompositions) {
    ResourceCompositions["Native"] = "Native"
    ResourceCompositions["Foreign"] = "Foreign"
    ResourceCompositions["Mixed"] = "Mixed"
})(ResourceCompositions || (ResourceCompositions = {}));
export class DeploymentDto extends ConfigItemDto {
    /** @param {{operationalState?:OperationalStates,resourcesRunning?:number,resourcesTotal?:number,shortId?:string,nameUserDefinedPart?:string,tenantId?:string,state?:LifecycleStates,environment?:Environments,templateId?:string,isTemplateBased?:boolean,parameters?:IList<ParameterDto>,variables?:IList<VariableDto>,variablesSnapshot?:IList<VariableDto>,parentId?:string,parent?:ConfigItemDto,validFrom?:string,validUntil?:string,isNeverExpiring?:boolean,nextPatchDate?:string,defaultResourceProviderId?:string,needsAttention?:boolean,composition?:ResourceCompositions,monthlyBudget?:number,sendBudgetNotificationMails?:boolean,budgetWarningThresholdPercent?:number,links?:IList<LinkDto>,id?:string,name?:string,displayName?:string,description?:string,objectType?:ObjectTypes,selfLink?:string,tags?:IList<TagDto>,path?:IList<PathItemDto>,created?:string,createUser?:string,createUserId?:string,modified?:string,modifyUser?:string,modifyUserId?:string,isDeleted?:boolean,deleted?:string,deleteUser?:string,deleteUserId?:string,links?:IList<LinkDto>}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {OperationalStates}
     * @description The operational state of the deployment (Running, Stopped, None, Unknown) */
    operationalState;
    /**
     * @type {number}
     * @description How many start/stop-capable resources are currently running */
    resourcesRunning;
    /**
     * @type {number}
     * @description Total number of start/stop-capable resources in this deployment */
    resourcesTotal;
    /**
     * @type {string}
     * @description Shorter id than the guid which can be used for automation (tenant wide unique) prefixed with a 'd'. E.g. dr36x3 */
    shortId;
    /**
     * @type {string}
     * @description The user defined part of the name property {userDefined}_{environment} */
    nameUserDefinedPart;
    /**
     * @type {string}
     * @description The id of the tenant */
    tenantId;
    /**
     * @type {LifecycleStates}
     * @description The state of the deployment */
    state;
    /**
     * @type {Environments}
     * @description The environment the deployment is deployed in */
    environment;
    /**
     * @type {?string}
     * @description The id of the template which was used to create the deployment */
    templateId;
    /**
     * @type {boolean}
     * @description Shows if a deployment was rolled out through a dune template or not */
    isTemplateBased;
    /**
     * @type {IList<ParameterDto>}
     * @description The parameters which were used to create this deployment */
    parameters;
    /**
     * @type {IList<VariableDto>}
     * @description A deployment scoped list of variables used for deployment of resources */
    variables;
    /**
     * @type {IList<VariableDto>}
     * @description A snapshot of the varialbs used to create the deployment */
    variablesSnapshot;
    /**
     * @type {string}
     * @description The id of the parent (collection) of the deployment */
    parentId;
    /**
     * @type {?ConfigItemDto}
     * @description The parent (collection) of the deployment */
    parent;
    /**
     * @type {string}
     * @description The Date when the resources got deployed */
    validFrom;
    /**
     * @type {?string}
     * @description The Date when the deployment expires and has to be reevaluated */
    validUntil;
    /**
     * @type {boolean}
     * @description The deployment will never expire */
    isNeverExpiring;
    /**
     * @type {?string}
     * @description The date, when the deployments resources will receive updates */
    nextPatchDate;
    /**
     * @type {string}
     * @description The default resource provider where the resources are deployed */
    defaultResourceProviderId;
    /**
     * @type {boolean}
     * @description Deployments which have issues in Jobs are marked with NeedsAttention */
    needsAttention;
    /**
     * @type {ResourceCompositions}
     * @description Composition show if all resources in the deployment are dune native, dune foreign or a mix of both */
    composition;
    /**
     * @type {?number}
     * @description The monthly cost budget for the whole collection */
    monthlyBudget;
    /**
     * @type {?boolean}
     * @description Whether to send budget information mails to the collection owners */
    sendBudgetNotificationMails;
    /**
     * @type {?number}
     * @description A threshold, when to send the first budget warning mail */
    budgetWarningThresholdPercent;
    /** @type {IList<LinkDto>} */
    links;
}
export class CreateDeployment {
    /** @param {{tenantName?:string,name?:string,displayName?:string,description?:string,parentId?:string,templateId?:string,defaultResourceProviderId?:string,environment?:Environments,parameters?:IList<ParameterDto>,variables?:IList<VariableDto>,tags?:IList<TagDto>,validUntil?:string,isNeverExpiring?:boolean,ownerUserIds?:IList<number>}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    tenantName;
    /**
     * @type {string}
     * @description The name of the deployment */
    name;
    /**
     * @type {?string}
     * @description The deployments display name */
    displayName;
    /**
     * @type {?string}
     * @description A more detailed description for the deployment */
    description;
    /**
     * @type {string}
     * @description The id of the collection, this deployment belongs to */
    parentId;
    /**
     * @type {?string}
     * @description The id of the template, this deployment is based on */
    templateId;
    /**
     * @type {string}
     * @description The default resource provider for this deployment */
    defaultResourceProviderId;
    /**
     * @type {Environments}
     * @description What kind of environment is this deployment */
    environment;
    /** @type {IList<ParameterDto>} */
    parameters;
    /** @type {?IList<VariableDto>} */
    variables;
    /** @type {?IList<TagDto>} */
    tags;
    /**
     * @type {?string}
     * @description The expiry date of the environment */
    validUntil;
    /**
     * @type {?boolean}
     * @description Set if the environment should never expire */
    isNeverExpiring;
    /** @type {IList<number>} */
    ownerUserIds;
}

JavaScript CreateDeployment 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/deployments/ HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"tenantName":"String","name":"String","displayName":"String","description":"String","parentId":"00000000-0000-0000-0000-000000000000","templateId":"00000000-0000-0000-0000-000000000000","defaultResourceProviderId":"00000000-0000-0000-0000-000000000000","environment":"Lab","parameters":null,"variables":null,"tags":null,"validUntil":"0001-01-01T00:00:00.0000000Z","isNeverExpiring":false,"ownerUserIds":null,"txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"operationalState":"None","resourcesRunning":0,"resourcesTotal":0,"shortId":"String","nameUserDefinedPart":"String","tenantId":"00000000-0000-0000-0000-000000000000","state":"New","environment":"Lab","templateId":"00000000-0000-0000-0000-000000000000","isTemplateBased":true,"parameters":null,"variables":null,"variablesSnapshot":null,"parentId":"00000000-0000-0000-0000-000000000000","parent":{"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},"validFrom":"0001-01-01T00:00:00.0000000Z","validUntil":"0001-01-01T00:00:00.0000000Z","isNeverExpiring":false,"nextPatchDate":"0001-01-01T00:00:00.0000000Z","defaultResourceProviderId":"00000000-0000-0000-0000-000000000000","needsAttention":false,"composition":"Native","monthlyBudget":0,"sendBudgetNotificationMails":false,"budgetWarningThresholdPercent":0,"links":[{"caption":"Index","rel":"index","hRef":"/deployments/","method":"GET"},{"caption":"Collection","rel":"up","hRef":"/collections/00000000-0000-0000-0000-000000000000","method":"GET"},{"caption":"Resourcegroups","rel":"down","hRef":"/resourcegroups?parentId=00000000-0000-0000-0000-000000000000","method":"GET"}],"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"}