| Required role: | TenantReader |
| GET | /api/deploymenttemplates/{Id}/structure | Returns an object describing the structure of the deployment template | |
|---|---|---|---|
| GET | /deploymenttemplates/{Id}/structure | Returns an object describing the structure of the deployment template |
"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 HierarchyItemDto {
/** @param {{id?:string,configItemType?:ObjectTypes,name?:string,displayName?:string,description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {ObjectTypes} */
configItemType;
/** @type {?string} */
name;
/** @type {?string} */
displayName;
/** @type {?string} */
description;
}
export class NestedHierarchyItemDto extends HierarchyItemDto {
/** @param {{children?:NestedHierarchyItemDto[],id?:string,configItemType?:ObjectTypes,name?:string,displayName?:string,description?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {NestedHierarchyItemDto[]} */
children = [];
}
export class GetDeploymentTemplateStructure {
/** @param {{id?:string,tenantName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
tenantName;
}
JavaScript GetDeploymentTemplateStructure 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/deploymenttemplates/{Id}/structure HTTP/1.1
Host: core.starburst.svc
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"children":[{"children":[{"children":[{"children":null,"id":"00000000-0000-0000-0000-000000000000","configItemType":"None","name":"String","displayName":"String","description":"String"}],"id":"00000000-0000-0000-0000-000000000000","configItemType":"None","name":"String","displayName":"String","description":"String"}],"id":"00000000-0000-0000-0000-000000000000","configItemType":"None","name":"String","displayName":"String","description":"String"}],"id":"00000000-0000-0000-0000-000000000000","configItemType":"None","name":"String","displayName":"String","description":"String"}