| Required role: | TenantReader |
| POST | /api/deploymenttemplates/ | Create a new deployment template | |
|---|---|---|---|
| POST | /deploymenttemplates/ | Create a new deployment template |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantName | header | string | Yes | |
| SchemaVersion | body | integer | Yes | The version of the template structureValid Range: 1 - 255 |
| Definition | body | string | Yes | The definition of the template (YAML) |
| AllowedEnvironments | body | array | No | Specify the environments the deployment template is allowed for |
| AllowedResourceProviderIds | body | array | No | Specify the resource providers the deployment template is allowed for |
| Lab | |
| Poc | |
| Dev | |
| Test | |
| Int | |
| Uat | |
| Prod |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantId | form | Guid | No | |
| SchemaVersion | form | int | No | The schema version of the attached definition (json/yaml structure) |
| Version | form | string | Yes | The version of the template (changes with each change to the template) |
| VersionNumeric | form | int | No | The version in a numeric (padded) form which can be used for sorting |
| Definition | form | string | No | The template definition as json/yaml |
| Variables | form | IList<VariableDto> | Yes | Template variables |
| Parameters | form | IList<ParameterDto> | Yes | Template parameters |
| IsDisabled | form | bool | No | Disabled templates should not be selected for deployments |
| IsLatest | form | bool | No | The template with the highest version number has IsLatest set to true |
| AllowedEnvironments | form | IList<Environments> | No | This template can be deployed only to the environments listed below |
| AllowedResourceProviders | form | IList<ResourceProviderDto> | No | This template can be deployed only to the resource providers listed below |
| ResourceGroupTemplates | form | IList<ResourceGroupTemplateDto> | No | An optional list of the child resource group templates |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | Yes | |
| DisplayName | form | string | Yes | |
| Description | form | string | No | |
| ObjectType | form | ObjectTypes | No | |
| SelfLink | form | string | Yes | |
| Tags | form | IList<TagDto> | Yes | |
| Path | form | IList<PathItemDto> | Yes | |
| Created | form | DateTime | No | |
| CreateUser | form | string | Yes | |
| CreateUserId | form | string | Yes | |
| Modified | form | DateTime | No | |
| ModifyUser | form | string | Yes | |
| ModifyUserId | form | string | Yes | |
| IsDeleted | form | bool | No | |
| Deleted | form | DateTime? | No | |
| DeleteUser | form | string | No | |
| DeleteUserId | form | string | No | |
| Links | form | IList<LinkDto> | Yes |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Value | form | string | No | |
| IsProtected | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Label | form | string | Yes | |
| Link | form | string | Yes | |
| ObjectType | form | ObjectTypes | No | |
| ObjectId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Caption | form | string | Yes | |
| Rel | form | string | Yes | |
| HRef | form | string | Yes | |
| Method | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Value | form | string | Yes | 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 | form | ValueDataType | No | The data type of the value property |
| Description | form | string | No | |
| IsInherited | form | bool | No | |
| Environment | form | Environments? | No |
| String | |
| Number | |
| Boolean | |
| List |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | No | |
| Value | form | string | No | Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false). Note: string values need extra quotes |
| Default | form | string | No | Optional default value for the frontend. Needs to be in the same format as the value |
| Optional | form | bool | No | Optional parameters do not need to have a value. Default -> Optional=false |
| Type | form | ParameterValueType | No | The data type of the value and default property |
| Validation | form | string | No |
| String | |
| Number | |
| Boolean | |
| SecureString |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantId | form | Guid | No | |
| DefaultEnvironment | form | Environments | No | If environment cannot be detected while scanning, default environment will be used |
| AllowedEnvironments | form | IList<Environments> | Yes | List off all allowed environments for this resource provider |
| Type | form | ResourceProviderTypes | No | Defines the provider type (e.g. Azure, Aws) |
| Config | form | IList<ProviderConfigEntryDto> | Yes | Additional generic data which varies depending on ProviderType |
| IsDisabled | form | bool | No | Disabled ResourceProviders cannot be selected for new deployments |
| IsReadyForDeployments | form | bool | No | Shows if a ResourceProvider has been initialized and can accept deployments (resources) |
| CostCurrentMonth | form | decimal | No | The cost for the current month |
| CostLastMonth | form | decimal | No | The cost for the last month |
| CostCurrency | form | string | Yes | The cost currency |
| Azure | |
| AmazonWebServices | |
| GoogleCloudPlatform | |
| ActiveDirectoryServices | |
| DomainNameSystem | |
| SwisscomESC | |
| AzureKeyVault |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Value | form | string | Yes | |
| isSecure | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantId | form | Guid | No | |
| SchemaVersion | form | int | No | The schema version of the attached definition (json/yaml structure) |
| Version | form | string | Yes | The version of the template (changes with each change to the template) |
| VersionNumeric | form | int | No | The version in a numeric (padded) form which can be used for sorting |
| Definition | form | string | No | The template definition/body either as json or yaml |
| Variables | form | IList<VariableDto> | Yes | Template variables |
| Parameters | form | IList<ParameterDto> | Yes | Template parameters |
| IsLatest | form | bool | No | The template with the highest version number has IsLatest set to true |
| ResourceTemplates | form | IList<ResourceTemplateDto> | Yes | List of contained resources |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| DisplayName | form | string | Yes | |
| Description | form | string | Yes | |
| Type | form | ObjectTypes | No |
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/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}