| Required role: | TenantReader |
| POST | /api/deployments/ | Creates a new deployment | |
|---|---|---|---|
| POST | /deployments/ | Creates a new deployment |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')
class ObjectTypes(str, Enum):
NONE = 'None'
CONFIG_ITEM = 'ConfigItem'
TENANT = 'Tenant'
COLLECTION = 'Collection'
RESOURCE = 'Resource'
COMPUTE_NODE = 'ComputeNode'
VIRTUAL_MACHINE = 'VirtualMachine'
PHYSICAL_MACHINE = 'PhysicalMachine'
DISK = 'Disk'
SUBNET = 'Subnet'
IP_ADDRESS = 'IPAddress'
JOB = 'Job'
JOB_EVENT = 'JobEvent'
FREEZE_PERIOD = 'FreezePeriod'
RESOURCE_GROUP = 'ResourceGroup'
DEPLOYMENT = 'Deployment'
RESOURCE_GROUP_TEMPLATE = 'ResourceGroupTemplate'
DEPLOYMENT_TEMPLATE = 'DeploymentTemplate'
RESOURCE_PROVIDER = 'ResourceProvider'
GENERIC_RESOURCE = 'GenericResource'
ROLE = 'Role'
PERMISSION = 'Permission'
USER = 'User'
PATCHING_WINDOW = 'PatchingWindow'
UPDATE = 'Update'
REPORT_DEFINITION = 'ReportDefinition'
TIME_SERIES = 'TimeSeries'
DATA_POINT = 'DataPoint'
ACTION = 'Action'
ACTION_ASSIGNMENT = 'ActionAssignment'
USER_NOTE = 'UserNote'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TagDto:
name: Optional[str] = None
value: Optional[str] = None
is_protected: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PathItemDto:
label: Optional[str] = None
link: Optional[str] = None
object_type: Optional[ObjectTypes] = None
object_id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LinkDto:
caption: Optional[str] = None
rel: Optional[str] = None
h_ref: Optional[str] = None
method: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConfigItemDto(IConfigItem):
id: Optional[str] = None
name: Optional[str] = None
display_name: Optional[str] = None
description: Optional[str] = None
object_type: Optional[ObjectTypes] = None
self_link: Optional[str] = None
tags: Optional[IList[TagDto]] = None
path: Optional[IList[PathItemDto]] = None
created: datetime.datetime = datetime.datetime(1, 1, 1)
create_user: Optional[str] = None
create_user_id: Optional[str] = None
modified: datetime.datetime = datetime.datetime(1, 1, 1)
modify_user: Optional[str] = None
modify_user_id: Optional[str] = None
is_deleted: bool = False
deleted: Optional[datetime.datetime] = None
delete_user: Optional[str] = None
delete_user_id: Optional[str] = None
links: Optional[IList[LinkDto]] = None
class OperationalStates(str, Enum):
NONE = 'None'
STARTING = 'Starting'
RUNNING = 'Running'
STOPPING = 'Stopping'
STOPPED = 'Stopped'
RESTARTING = 'Restarting'
DELETING = 'Deleting'
UNKNOWN = 'Unknown'
class LifecycleStates(str, Enum):
NEW = 'New'
DEPLOYING = 'Deploying'
DEPLOYED = 'Deployed'
REMOVING = 'Removing'
REMOVED = 'Removed'
FAILURE = 'Failure'
IMPORTED = 'Imported'
class Environments(str, Enum):
LAB = 'Lab'
POC = 'Poc'
DEV = 'Dev'
TEST = 'Test'
INT_ = 'Int'
UAT = 'Uat'
PROD = 'Prod'
class ParameterValueType(str, Enum):
STRING = 'String'
NUMBER = 'Number'
BOOLEAN = 'Boolean'
SECURE_STRING = 'SecureString'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ParameterDto:
name: Optional[str] = None
description: Optional[str] = None
value: Optional[str] = None
"""
Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false). Note: string values need extra quotes
"""
default: Optional[str] = None
"""
Optional default value for the frontend. Needs to be in the same format as the value
"""
optional: bool = False
"""
Optional parameters do not need to have a value. Default -> Optional=false
"""
type: Optional[ParameterValueType] = None
"""
The data type of the value and default property
"""
validation: Optional[str] = None
class ValueDataType(str, Enum):
STRING = 'String'
NUMBER = 'Number'
BOOLEAN = 'Boolean'
LIST = 'List'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VariableDto:
name: Optional[str] = None
value: Optional[str] = None
"""
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
"""
type: Optional[ValueDataType] = None
"""
The data type of the value property
"""
description: Optional[str] = None
is_inherited: bool = False
environment: Optional[Environments] = None
class ResourceCompositions(str, Enum):
NATIVE = 'Native'
FOREIGN = 'Foreign'
MIXED = 'Mixed'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeploymentDto(ConfigItemDto, IHasParentDto, IHasTenantId, IEnvironmentSpecific):
operational_state: Optional[OperationalStates] = None
"""
The operational state of the deployment (Running, Stopped, None, Unknown)
"""
resources_running: int = 0
"""
How many start/stop-capable resources are currently running
"""
resources_total: int = 0
"""
Total number of start/stop-capable resources in this deployment
"""
short_id: Optional[str] = None
"""
Shorter id than the guid which can be used for automation (tenant wide unique) prefixed with a 'd'. E.g. dr36x3
"""
name_user_defined_part: Optional[str] = None
"""
The user defined part of the name property {userDefined}_{environment}
"""
tenant_id: Optional[str] = None
"""
The id of the tenant
"""
state: Optional[LifecycleStates] = None
"""
The state of the deployment
"""
environment: Optional[Environments] = None
"""
The environment the deployment is deployed in
"""
template_id: Optional[str] = None
"""
The id of the template which was used to create the deployment
"""
is_template_based: bool = False
"""
Shows if a deployment was rolled out through a dune template or not
"""
parameters: Optional[IList[ParameterDto]] = None
"""
The parameters which were used to create this deployment
"""
variables: Optional[IList[VariableDto]] = None
"""
A deployment scoped list of variables used for deployment of resources
"""
variables_snapshot: Optional[IList[VariableDto]] = None
"""
A snapshot of the varialbs used to create the deployment
"""
parent_id: Optional[str] = None
"""
The id of the parent (collection) of the deployment
"""
parent: Optional[ConfigItemDto] = None
"""
The parent (collection) of the deployment
"""
valid_from: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The Date when the resources got deployed
"""
valid_until: Optional[datetime.datetime] = None
"""
The Date when the deployment expires and has to be reevaluated
"""
is_never_expiring: bool = False
"""
The deployment will never expire
"""
next_patch_date: Optional[datetime.datetime] = None
"""
The date, when the deployments resources will receive updates
"""
default_resource_provider_id: Optional[str] = None
"""
The default resource provider where the resources are deployed
"""
needs_attention: bool = False
"""
Deployments which have issues in Jobs are marked with NeedsAttention
"""
composition: Optional[ResourceCompositions] = None
"""
Composition show if all resources in the deployment are dune native, dune foreign or a mix of both
"""
monthly_budget: Optional[Decimal] = None
"""
The monthly cost budget for the whole collection
"""
send_budget_notification_mails: Optional[bool] = None
"""
Whether to send budget information mails to the collection owners
"""
budget_warning_threshold_percent: Optional[int] = None
"""
A threshold, when to send the first budget warning mail
"""
links: Optional[IList[LinkDto]] = None
# @Api(Description="Creates a new deployment")
# @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(DeploymentDto), StatusCode=201)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateDeployment(ICreateRequest, IHasTenantName, IHasParent, IPost):
"""
Creates a new deployment
"""
# @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
# @Validate(Validator="NotEmpty")
tenant_name: Optional[str] = None
# @ApiMember(DataType="string", Description="The name of the deployment", IsRequired=true, ParameterType="body")
# @Validate(Validator="NotEmpty")
# @Validate(Validator="MaximumLength(100)")
# @Validate(Validator="RegularExpression(′^([0-9a-z]+[0-9a-z-]*[0-9a-z]+)_([a-z]+)$′)")
name: Optional[str] = None
"""
The name of the deployment
"""
# @ApiMember(DataType="string", Description="The deployments display name", ParameterType="body")
# @Validate(Validator="MaximumLength(250)")
display_name: Optional[str] = None
"""
The deployments display name
"""
# @ApiMember(DataType="string", Description="A more detailed description for the deployment", ParameterType="body")
# @Validate(Validator="MaximumLength(8000)")
description: Optional[str] = None
"""
A more detailed description for the deployment
"""
# @ApiMember(DataType="string", Description="The id of the collection, this deployment belongs to", Format="guid", IsRequired=true, ParameterType="body")
parent_id: Optional[str] = None
"""
The id of the collection, this deployment belongs to
"""
# @ApiMember(DataType="string", Description="The id of the template, this deployment is based on", Format="guid", ParameterType="body")
template_id: Optional[str] = None
"""
The id of the template, this deployment is based on
"""
# @ApiMember(DataType="string", Description="The default resource provider for this deployment", Format="guid", IsRequired=true, ParameterType="body")
default_resource_provider_id: Optional[str] = None
"""
The default resource provider for this deployment
"""
# @ApiMember(Description="What kind of environment is this deployment", IsRequired=true, ParameterType="body")
environment: Optional[Environments] = None
"""
What kind of environment is this deployment
"""
# @ApiMember(DataType="array", ParameterType="body")
parameters: Optional[IList[ParameterDto]] = None
# @ApiMember(DataType="array", ParameterType="body")
variables: Optional[IList[VariableDto]] = None
# @ApiMember(DataType="array", ParameterType="body")
tags: Optional[IList[TagDto]] = None
# @ApiMember(DataType="string", Description="The expiry date of the environment", ParameterType="body")
valid_until: Optional[datetime.datetime] = None
"""
The expiry date of the environment
"""
# @ApiMember(DataType="bool", Description="Set if the environment should never expire", ParameterType="body")
is_never_expiring: Optional[bool] = None
"""
Set if the environment should never expire
"""
# @ApiMember(DataType="array", IsRequired=true, ParameterType="body")
# @Validate(Validator="NotEmpty")
owner_user_ids: Optional[IList[int]] = None
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
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"}