| Required role: | TenantReader |
| GET | /api/resourcegrouptemplates/{Id}/definition/ | Returns the template definition | |
|---|---|---|---|
| GET | /api/resourcegrouptemplates/{Name}/{Version}/definition | Returns the template definition | |
| GET | /resourcegrouptemplates/{Id}/definition/ | Returns the template definition | |
| GET | /resourcegrouptemplates/{Name}/{Version}/definition | Returns the template definition |
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.Templates.ResourceGroup.Crud
Imports CoreService.ServiceModel.Enums
Imports CoreService.ServiceModel.Dtos.Base.Responses
Namespace Global
Namespace CoreService.ServiceModel.Dtos.Base.Responses
Public Partial Class TemplateDefinitionDto
'''<Summary>
'''The schema version of the attached definition
'''</Summary>
Public Overridable Property SchemaVersion As Integer
'''<Summary>
'''The template definition/body either as json or yaml
'''</Summary>
Public Overridable Property Definition As String
End Class
End Namespace
Namespace CoreService.ServiceModel.Dtos.Templates.ResourceGroup.Crud
'''<Summary>
'''Returns the template definition
'''</Summary>
<Api(Description:="Returns the template definition")>
<ApiResponse(Description:="Success", IsDefaultResponse:=true, ResponseType:=GetType(TemplateDefinitionDto), StatusCode:=200)>
Public Partial Class GetResourceGroupTemplateDefinition
Implements IGetSingleRequest
Implements IHasTenantName
Implements IGet
<ApiMember(DataType:="string", Format:="guid", IsRequired:=true, ParameterType:="path")>
Public Overridable Property Id As Guid?
'''<Summary>
'''The templates name
'''</Summary>
<ApiMember(DataType:="string", Description:="The templates name", ParameterType:="query")>
Public Overridable Property Name As String
'''<Summary>
'''The templates version
'''</Summary>
<ApiMember(DataType:="string", Description:="The templates version", ParameterType:="query")>
Public Overridable Property Version As String
<ApiMember(DataType:="string", IsRequired:=true, ParameterType:="header")>
<Validate(Validator:="NotEmpty")>
Public Overridable Property TenantName As String Implements IHasTenantName.TenantName
<ApiMember(IsRequired:=true, ParameterType:="query")>
Public Overridable Property DefinitionFormat As TemplateLanguages
'''<Summary>
'''If true, also soft deleted items will be returned
'''</Summary>
<ApiMember(Description:="If true, also soft deleted items will be returned", ParameterType:="query")>
Public Overridable Property IncludeDeleted As Boolean? Implements IGetSingleRequest.IncludeDeleted
<ApiMember(ParameterType:="query", Verb:="GET")>
Public Overridable Property IncludeReferencedObjects As Boolean? Implements IGetSingleRequest.IncludeReferencedObjects
End Class
End Namespace
Namespace CoreService.ServiceModel.Enums
Public Enum TemplateLanguages
Json
Yaml
End Enum
End Namespace
End Namespace
VB.NET GetResourceGroupTemplateDefinition 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/resourcegrouptemplates/{Id}/definition/ HTTP/1.1
Host: core.starburst.svc
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"schemaVersion":0,"definition":"String"}