CoreService

<back to all web services

GetResourceGroupTemplateDefinition

ResourceGroupTemplate - CRUD

Returns the template definition

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/resourcegrouptemplates/{Id}/definition/Returns the template definition
GET/api/resourcegrouptemplates/{Name}/{Version}/definitionReturns the template definition
GET/resourcegrouptemplates/{Id}/definition/Returns the template definition
GET/resourcegrouptemplates/{Name}/{Version}/definitionReturns the template definition
"use strict";
export class TemplateDefinitionDto {
    /** @param {{schemaVersion?:number,definition?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The schema version of the attached definition */
    schemaVersion;
    /**
     * @type {string}
     * @description The template definition/body either as json or yaml */
    definition;
}
/** @typedef {'Json'|'Yaml'} */
export var TemplateLanguages;
(function (TemplateLanguages) {
    TemplateLanguages["Json"] = "Json"
    TemplateLanguages["Yaml"] = "Yaml"
})(TemplateLanguages || (TemplateLanguages = {}));
export class GetResourceGroupTemplateDefinition {
    /** @param {{id?:string,name?:string,version?:string,tenantName?:string,definitionFormat?:TemplateLanguages,includeDeleted?:boolean,includeReferencedObjects?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /**
     * @type {?string}
     * @description The templates name */
    name;
    /**
     * @type {?string}
     * @description The templates version */
    version;
    /** @type {string} */
    tenantName;
    /** @type {TemplateLanguages} */
    definitionFormat;
    /**
     * @type {?boolean}
     * @description If true, also soft deleted items will be returned */
    includeDeleted;
    /** @type {?boolean} */
    includeReferencedObjects;
}

JavaScript 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

HTTP + JSON

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"}