| Required roles: | TenantReader, TenantAdmin |
| POST | /api/resourceproviders/ | Creates a new resourceprovider | |
|---|---|---|---|
| POST | /resourceproviders/ | Creates a new resourceprovider |
"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 TagDto {
/** @param {{name?:string,value?:string,isProtected?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
/** @type {?string} */
value;
/** @type {boolean} */
isProtected;
}
export class PathItemDto {
/** @param {{label?:string,link?:string,objectType?:ObjectTypes,objectId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
label;
/** @type {string} */
link;
/** @type {ObjectTypes} */
objectType;
/** @type {string} */
objectId;
}
export class LinkDto {
/** @param {{caption?:string,rel?:string,hRef?:string,method?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
caption;
/** @type {string} */
rel;
/** @type {string} */
hRef;
/** @type {string} */
method;
}
export class ConfigItemDto {
/** @param {{id?:string,name?:string,displayName?:string,description?:string,objectType?:ObjectTypes,selfLink?:string,tags?:IList<TagDto>,path?:IList<PathItemDto>,created?:string,createUser?:string,createUserId?:string,modified?:string,modifyUser?:string,modifyUserId?:string,isDeleted?:boolean,deleted?:string,deleteUser?:string,deleteUserId?:string,links?:IList<LinkDto>}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
name;
/** @type {string} */
displayName;
/** @type {?string} */
description;
/** @type {ObjectTypes} */
objectType;
/** @type {string} */
selfLink;
/** @type {IList<TagDto>} */
tags;
/** @type {IList<PathItemDto>} */
path;
/** @type {string} */
created;
/** @type {string} */
createUser;
/** @type {string} */
createUserId;
/** @type {string} */
modified;
/** @type {string} */
modifyUser;
/** @type {string} */
modifyUserId;
/** @type {boolean} */
isDeleted;
/** @type {?string} */
deleted;
/** @type {?string} */
deleteUser;
/** @type {?string} */
deleteUserId;
/** @type {IList<LinkDto>} */
links;
}
/** @typedef {'Lab'|'Poc'|'Dev'|'Test'|'Int'|'Uat'|'Prod'} */
export var Environments;
(function (Environments) {
Environments["Lab"] = "Lab"
Environments["Poc"] = "Poc"
Environments["Dev"] = "Dev"
Environments["Test"] = "Test"
Environments["Int"] = "Int"
Environments["Uat"] = "Uat"
Environments["Prod"] = "Prod"
})(Environments || (Environments = {}));
/** @typedef {'Azure'|'AmazonWebServices'|'GoogleCloudPlatform'|'ActiveDirectoryServices'|'DomainNameSystem'|'SwisscomESC'|'AzureKeyVault'} */
export var ResourceProviderTypes;
(function (ResourceProviderTypes) {
ResourceProviderTypes["Azure"] = "Azure"
ResourceProviderTypes["AmazonWebServices"] = "AmazonWebServices"
ResourceProviderTypes["GoogleCloudPlatform"] = "GoogleCloudPlatform"
ResourceProviderTypes["ActiveDirectoryServices"] = "ActiveDirectoryServices"
ResourceProviderTypes["DomainNameSystem"] = "DomainNameSystem"
ResourceProviderTypes["SwisscomESC"] = "SwisscomESC"
ResourceProviderTypes["AzureKeyVault"] = "AzureKeyVault"
})(ResourceProviderTypes || (ResourceProviderTypes = {}));
export class ProviderConfigEntryDto {
/** @param {{name?:string,value?:string,isSecure?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
/** @type {string} */
value;
/** @type {boolean} */
isSecure;
}
export class ResourceProviderDto extends ConfigItemDto {
/** @param {{tenantId?:string,defaultEnvironment?:Environments,allowedEnvironments?:IList<Environments>,type?:ResourceProviderTypes,config?:IList<ProviderConfigEntryDto>,isDisabled?:boolean,isReadyForDeployments?:boolean,costCurrentMonth?:number,costLastMonth?:number,costCurrency?:string,id?:string,name?:string,displayName?:string,description?:string,objectType?:ObjectTypes,selfLink?:string,tags?:IList<TagDto>,path?:IList<PathItemDto>,created?:string,createUser?:string,createUserId?:string,modified?:string,modifyUser?:string,modifyUserId?:string,isDeleted?:boolean,deleted?:string,deleteUser?:string,deleteUserId?:string,links?:IList<LinkDto>}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
tenantId;
/**
* @type {Environments}
* @description If environment cannot be detected while scanning, default environment will be used */
defaultEnvironment;
/**
* @type {IList<Environments>}
* @description List off all allowed environments for this resource provider */
allowedEnvironments;
/**
* @type {ResourceProviderTypes}
* @description Defines the provider type (e.g. Azure, Aws) */
type;
/**
* @type {IList<ProviderConfigEntryDto>}
* @description Additional generic data which varies depending on ProviderType */
config;
/**
* @type {boolean}
* @description Disabled ResourceProviders cannot be selected for new deployments */
isDisabled;
/**
* @type {boolean}
* @description Shows if a ResourceProvider has been initialized and can accept deployments (resources) */
isReadyForDeployments;
/**
* @type {number}
* @description The cost for the current month */
costCurrentMonth;
/**
* @type {number}
* @description The cost for the last month */
costLastMonth;
/**
* @type {string}
* @description The cost currency */
costCurrency;
}
export class CreateResourceProvider {
/** @param {{tenantName?:string,name?:string,displayName?:string,description?:string,defaultEnvironment?:Environments,allowedEnvironments?:IList<Environments>,type?:ResourceProviderTypes,config?:IList<ProviderConfigEntryDto>,tags?:IList<TagDto>,isDisabled?:boolean,initializeForDeployments?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
tenantName;
/**
* @type {string}
* @description The resource providers name */
name;
/**
* @type {?string}
* @description The resource providers display name */
displayName;
/**
* @type {?string}
* @description A more detailed description for the resource provider */
description;
/**
* @type {Environments}
* @description If environment cannot be detected while scanning, default environment will be used */
defaultEnvironment;
/**
* @type {IList<Environments>}
* @description List off all allowed environments for this resource provider */
allowedEnvironments;
/**
* @type {ResourceProviderTypes}
* @description The provider type (e.g. Azure) */
type;
/**
* @type {IList<ProviderConfigEntryDto>}
* @description The resource provider config */
config;
/** @type {?IList<TagDto>} */
tags;
/**
* @type {boolean}
* @description Disabled resource providers will be ignored when scanning, etc. */
isDisabled;
/**
* @type {boolean}
* @description Start the initialization process, which enables the resource provider for deployments if successfull */
initializeForDeployments;
}
JavaScript CreateResourceProvider 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/resourceproviders/ 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","defaultEnvironment":"Lab","allowedEnvironments":null,"type":"Azure","config":null,"tags":null,"isDisabled":false,"initializeForDeployments":false,"txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"tenantId":"00000000-0000-0000-0000-000000000000","defaultEnvironment":"Lab","allowedEnvironments":null,"type":"Azure","config":null,"isDisabled":false,"isReadyForDeployments":false,"costCurrentMonth":0,"costLastMonth":0,"costCurrency":"String","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}