| Required role: | TenantReader |
| POST | /api/resourcegroups/ | Creates a new resourcegroup | |
|---|---|---|---|
| POST | /resourcegroups/ | Creates a new resourcegroup |
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CoreService.ServiceModel.Dtos.ResourceGroups.Crud
Imports CoreService.ServiceModel.Dtos.Base.Responses
Imports CoreService.ServiceModel.Enums
Imports CoreService.ServiceModel.Dtos.ResourceGroups.Responses
Imports YCO.Dune.Models.Enums
Namespace Global
Namespace CoreService.ServiceModel.Dtos.Base.Responses
Public Partial Class ConfigItemDto
Implements IConfigItem
Public Overridable Property Id As Guid
Public Overridable Property Name As String
Public Overridable Property DisplayName As String Implements IConfigItem.DisplayName
Public Overridable Property Description As String Implements IConfigItem.Description
Public Overridable Property ObjectType As ObjectTypes
Public Overridable Property SelfLink As String Implements IConfigItem.SelfLink
Public Overridable Property Tags As IList(Of TagDto) Implements IConfigItem.Tags
Public Overridable Property Path As IList(Of PathItemDto)
Public Overridable Property Created As Date
Public Overridable Property CreateUser As String
Public Overridable Property CreateUserId As String
Public Overridable Property Modified As Date
Public Overridable Property ModifyUser As String
Public Overridable Property ModifyUserId As String
Public Overridable Property IsDeleted As Boolean
Public Overridable Property Deleted As Date?
Public Overridable Property DeleteUser As String
Public Overridable Property DeleteUserId As String
Public Overridable Property Links As IList(Of LinkDto)
End Class
Public Partial Class LinkDto
Public Overridable Property Caption As String
Public Overridable Property Rel As String
Public Overridable Property HRef As String
Public Overridable Property Method As String
End Class
Public Partial Class ParameterDto
Public Overridable Property Name As String
Public Overridable Property Description As String
'''<Summary>
'''Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false). Note: string values need extra quotes
'''</Summary>
Public Overridable Property Value As String
'''<Summary>
'''Optional default value for the frontend. Needs to be in the same format as the value
'''</Summary>
Public Overridable Property [Default] As String
'''<Summary>
'''Optional parameters do not need to have a value. Default -> Optional=false
'''</Summary>
Public Overridable Property [Optional] As Boolean
'''<Summary>
'''The data type of the value and default property
'''</Summary>
Public Overridable Property Type As ParameterValueType
Public Overridable Property Validation As String
End Class
Public Partial Class PathItemDto
Public Overridable Property Label As String
Public Overridable Property Link As String
Public Overridable Property ObjectType As ObjectTypes
Public Overridable Property ObjectId As Guid
End Class
Public Partial Class TagDto
Public Overridable Property Name As String
Public Overridable Property Value As String
Public Overridable Property IsProtected As Boolean
End Class
Public Partial Class VariableDto
Public Overridable Property Name As String
'''<Summary>
'''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
'''</Summary>
Public Overridable Property Value As String
'''<Summary>
'''The data type of the value property
'''</Summary>
Public Overridable Property Type As ValueDataType
Public Overridable Property Description As String
Public Overridable Property IsInherited As Boolean
Public Overridable Property Environment As Environments?
End Class
End Namespace
Namespace CoreService.ServiceModel.Dtos.ResourceGroups.Crud
'''<Summary>
'''Create a new resourcegroup
'''</Summary>
<Api(Description:="Create a new resourcegroup")>
<ApiResponse(Description:="Success", IsDefaultResponse:=true, ResponseType:=GetType(ResourceGroupDto), StatusCode:=201)>
Public Partial Class CreateResourceGroup
Implements ICreateRequest
Implements IHasTenantName
Implements IHasParent
Implements IPost
<ApiMember(DataType:="string", IsRequired:=true, ParameterType:="header")>
<Validate(Validator:="NotEmpty")>
Public Overridable Property TenantName As String Implements IHasTenantName.TenantName
'''<Summary>
'''The resourcegroups name
'''</Summary>
<ApiMember(DataType:="string", Description:="The resourcegroups name", IsRequired:=true, ParameterType:="body")>
<Validate(Validator:="NotEmpty")>
<Validate(Validator:="MaximumLength(50)")>
<Validate(Validator:="RegularExpression(′^[0-9a-z]+[0-9a-z-]*[0-9a-z]+$′)")>
Public Overridable Property Name As String Implements ICreateRequest.Name
'''<Summary>
'''The resourcegroups display name
'''</Summary>
<ApiMember(DataType:="string", Description:="The resourcegroups display name", ParameterType:="body")>
<Validate(Validator:="MaximumLength(250)")>
Public Overridable Property DisplayName As String Implements ICreateRequest.DisplayName
'''<Summary>
'''A more detailed description for the resourcegroup
'''</Summary>
<ApiMember(DataType:="string", Description:="A more detailed description for the resourcegroup", ParameterType:="body")>
<Validate(Validator:="MaximumLength(8000)")>
Public Overridable Property Description As String Implements ICreateRequest.Description
'''<Summary>
'''The id of the deployment, this resourcegroup belongs to
'''</Summary>
<ApiMember(DataType:="string", Description:="The id of the deployment, this resourcegroup belongs to", Format:="guid", IsRequired:=true, ParameterType:="body")>
Public Overridable Property ParentId As Guid Implements IHasParent.ParentId
'''<Summary>
'''The id of the template, this resourcegroup is based on
'''</Summary>
<ApiMember(DataType:="string", Description:="The id of the template, this resourcegroup is based on", Format:="guid", ParameterType:="body")>
Public Overridable Property TemplateId As Guid?
<ApiMember(DataType:="array", ParameterType:="body")>
Public Overridable Property Parameters As IList(Of ParameterDto)
<ApiMember(DataType:="array", ParameterType:="body")>
Public Overridable Property Variables As IList(Of VariableDto)
<ApiMember(DataType:="array", ParameterType:="body")>
Public Overridable Property Tags As IList(Of TagDto)
End Class
End Namespace
Namespace CoreService.ServiceModel.Dtos.ResourceGroups.Responses
Public Partial Class ResourceGroupDto
Inherits ConfigItemDto
Implements IHasParent
Implements IHasTenantId
Implements IEnvironmentSpecific
'''<Summary>
'''Shorter id than the guid which can be used for automation (tenant wide unique) prefixed with a 'g'. E.g. gk36x3
'''</Summary>
Public Overridable Property ShortId As String
'''<Summary>
'''The id of the tenant
'''</Summary>
Public Overridable Property TenantId As Guid Implements IHasTenantId.TenantId
'''<Summary>
'''The environment the resourcegroup is deployed in
'''</Summary>
Public Overridable Property Environment As Environments Implements IEnvironmentSpecific.Environment
'''<Summary>
'''The state of the deployment
'''</Summary>
Public Overridable Property State As LifecycleStates
'''<Summary>
'''The id of the parent (deployment) of the resourcegroup
'''</Summary>
Public Overridable Property ParentId As Guid Implements IHasParent.ParentId
'''<Summary>
'''The id of the template which was used to create the resourcegroup
'''</Summary>
Public Overridable Property TemplateId As Guid?
'''<Summary>
'''Shows if a resourcegroup was rolled out through a dune template or not
'''</Summary>
Public Overridable Property IsTemplateBased As Boolean
'''<Summary>
'''The parent (deployment) of the resourcegroup
'''</Summary>
Public Overridable Property Parent As ConfigItemDto
'''<Summary>
'''The parameters which were used to create this resourcegroup
'''</Summary>
Public Overridable Property Parameters As IList(Of ParameterDto)
'''<Summary>
'''A resourcegroup scoped list of variables used for resourcegroup of resources
'''</Summary>
Public Overridable Property Variables As IList(Of VariableDto)
'''<Summary>
'''The date, when the resourcegroups resources will receive updates
'''</Summary>
Public Overridable Property NextPatchDate As Date?
'''<Summary>
'''Composition show if all resources in the resourcegroup are dune native, dune foreign or a mix of both
'''</Summary>
Public Overridable Property Composition As ResourceCompositions
Public Overridable Property Links As IList(Of LinkDto)
End Class
End Namespace
Namespace CoreService.ServiceModel.Enums
Public Enum Environments
Lab
Poc
Dev
Test
Int
Uat
Prod
End Enum
Public Enum LifecycleStates
[New]
Deploying
Deployed
Removing
Removed
Failure
Imported
End Enum
Public Enum ParameterValueType
[String]
Number
[Boolean]
SecureString
End Enum
Public Enum ResourceCompositions
Native
Foreign
Mixed
End Enum
Public Enum ValueDataType
[String]
Number
[Boolean]
List
End Enum
End Namespace
Namespace YCO.Dune.Models.Enums
Public Enum ObjectTypes
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
End Enum
End Namespace
End Namespace
VB.NET CreateResourceGroup 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.
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"}