CoreService

<back to all web services

CreateResourceGroup

ResourceGroup - CRUD

Create a new resourcegroup

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
POST/api/resourcegroups/Creates a new resourcegroup
POST/resourcegroups/Creates a new resourcegroup
CreateResourceGroup Parameters:
NameParameterData TypeRequiredDescription
TenantNameheaderstringYes
NamebodystringYesThe resourcegroups name
DisplayNamebodystringNoThe resourcegroups display name
DescriptionbodystringNoA more detailed description for the resourcegroup
ParentIdbodystringYesThe id of the deployment, this resourcegroup belongs to
TemplateIdbodystringNoThe id of the template, this resourcegroup is based on
ParametersbodyarrayYes
VariablesbodyarrayNo
TagsbodyarrayNo
ParameterDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringNo
ValueformstringNoValue in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false). Note: string values need extra quotes
DefaultformstringNoOptional default value for the frontend. Needs to be in the same format as the value
OptionalformboolNoOptional parameters do not need to have a value. Default -> Optional=false
TypeformParameterValueTypeNoThe data type of the value and default property
ValidationformstringNo
ParameterValueType Enum:
String
Number
Boolean
SecureString
VariableDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
ValueformstringYesValue 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
TypeformValueDataTypeNoThe data type of the value property
DescriptionformstringNo
IsInheritedformboolNo
EnvironmentformEnvironments?No
ValueDataType Enum:
String
Number
Boolean
List
Environments Enum:
Lab
Poc
Dev
Test
Int
Uat
Prod
TagDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
ValueformstringNo
IsProtectedformboolNo
ResourceGroupDto Parameters:
NameParameterData TypeRequiredDescription
ShortIdformstringYesShorter id than the guid which can be used for automation (tenant wide unique) prefixed with a 'g'. E.g. gk36x3
TenantIdformGuidNoThe id of the tenant
EnvironmentformEnvironmentsNoThe environment the resourcegroup is deployed in
StateformLifecycleStatesNoThe state of the deployment
ParentIdformGuidNoThe id of the parent (deployment) of the resourcegroup
TemplateIdformGuid?NoThe id of the template which was used to create the resourcegroup
IsTemplateBasedformboolNoShows if a resourcegroup was rolled out through a dune template or not
ParentformConfigItemDtoNoThe parent (deployment) of the resourcegroup
ParametersformIList<ParameterDto>YesThe parameters which were used to create this resourcegroup
VariablesformIList<VariableDto>YesA resourcegroup scoped list of variables used for resourcegroup of resources
NextPatchDateformDateTime?NoThe date, when the resourcegroups resources will receive updates
CompositionformResourceCompositionsNoComposition show if all resources in the resourcegroup are dune native, dune foreign or a mix of both
LinksformIList<LinkDto>Yes
ConfigItemDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringYes
DisplayNameformstringYes
DescriptionformstringNo
ObjectTypeformObjectTypesNo
SelfLinkformstringYes
TagsformIList<TagDto>Yes
PathformIList<PathItemDto>Yes
CreatedformDateTimeNo
CreateUserformstringYes
CreateUserIdformstringYes
ModifiedformDateTimeNo
ModifyUserformstringYes
ModifyUserIdformstringYes
IsDeletedformboolNo
DeletedformDateTime?No
DeleteUserformstringNo
DeleteUserIdformstringNo
LinksformIList<LinkDto>Yes
ObjectTypes Enum:
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
PathItemDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
LinkformstringYes
ObjectTypeformObjectTypesNo
ObjectIdformGuidNo
LinkDto Parameters:
NameParameterData TypeRequiredDescription
CaptionformstringYes
RelformstringYes
HRefformstringYes
MethodformstringYes
LifecycleStates Enum:
New
Deploying
Deployed
Removing
Removed
Failure
Imported
ResourceCompositions Enum:
Native
Foreign
Mixed

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/resourcegroups/ 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","parameters":null,"variables":null,"tags":null,"txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"shortId":"String","tenantId":"00000000-0000-0000-0000-000000000000","environment":"Lab","state":"New","parentId":"00000000-0000-0000-0000-000000000000","templateId":"00000000-0000-0000-0000-000000000000","isTemplateBased":true,"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},"parameters":null,"variables":null,"nextPatchDate":"0001-01-01T00:00:00.0000000Z","composition":"Native","links":[{"caption":"Index","rel":"index","hRef":"/resourcegroups/","method":"GET"},{"caption":"Deployment","rel":"up","hRef":"/deployments/00000000-0000-0000-0000-000000000000","method":"GET"},{"caption":"Resources","rel":"down","hRef":"/resources?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"}