CoreService

<back to all web services

GetResourceProvider

ResourceProvider - CRUD

Returns a single resourceprovider by its id

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/resourceproviders/{Id}Returns a resourceprovider
GET/resourceproviders/{Id}Returns a resourceprovider
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Returns a single resourceprovider by its id
*/
@Api(Description="Returns a single resourceprovider by its id")
@ApiResponse(Description="The request endend successful", IsDefaultResponse=true, ResponseType=ResourceProviderDto::class, StatusCode=200)
open class GetResourceProvider : IGetSingleRequest, IHasId, IHasTenantName, IGet
{
    /**
    * The primary key of every config item
    */
    @ApiMember(DataType="string", Description="The primary key of every config item", Format="guid", IsRequired=true, ParameterType="path")
    override var id:UUID? = null

    @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    @Validate(Validator="NotEmpty")
    override var tenantName:String? = null

    /**
    * If true, also soft deleted items will be returned
    */
    @ApiMember(Description="If true, also soft deleted items will be returned", ParameterType="query")
    override var includeDeleted:Boolean? = null

    @ApiMember(ParameterType="query", Verb="GET")
    override var includeReferencedObjects:Boolean? = null
}

open class ResourceProviderDto : ConfigItemDto(), IHasTenantId
{
    override var tenantId:UUID? = null
    /**
    * If environment cannot be detected while scanning, default environment will be used
    */
    open var defaultEnvironment:Environments? = null
    /**
    * List off all allowed environments for this resource provider
    */
    open var allowedEnvironments:IList<Environments>? = null
    /**
    * Defines the provider type (e.g. Azure, Aws)
    */
    @SerializedName("type") open var Type:ResourceProviderTypes? = null
    /**
    * Additional generic data which varies depending on ProviderType
    */
    open var config:IList<ProviderConfigEntryDto>? = null
    /**
    * Disabled ResourceProviders cannot be selected for new deployments
    */
    open var isDisabled:Boolean? = null
    /**
    * Shows if a ResourceProvider has been initialized and can accept deployments (resources)
    */
    open var isReadyForDeployments:Boolean? = null
    /**
    * The cost for the current month
    */
    open var costCurrentMonth:BigDecimal? = null
    /**
    * The cost for the last month
    */
    open var costLastMonth:BigDecimal? = null
    /**
    * The cost currency
    */
    open var costCurrency:String? = null
}

open class ConfigItemDto : IConfigItem
{
    open var id:UUID? = null
    open var name:String? = null
    override var displayName:String? = null
    override var description:String? = null
    open var objectType:ObjectTypes? = null
    override var selfLink:String? = null
    override var tags:IList<TagDto>? = null
    open var path:IList<PathItemDto>? = null
    open var created:Date? = null
    open var createUser:String? = null
    open var createUserId:String? = null
    open var modified:Date? = null
    open var modifyUser:String? = null
    open var modifyUserId:String? = null
    open var isDeleted:Boolean? = null
    open var deleted:Date? = null
    open var deleteUser:String? = null
    open var deleteUserId:String? = null
    open var links:IList<LinkDto>? = null
}

enum class 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,
}

open class TagDto
{
    open var name:String? = null
    open var value:String? = null
    open var isProtected:Boolean? = null
}

open class PathItemDto
{
    open var label:String? = null
    open var link:String? = null
    open var objectType:ObjectTypes? = null
    open var objectId:UUID? = null
}

open class LinkDto
{
    open var caption:String? = null
    open var rel:String? = null
    open var hRef:String? = null
    open var method:String? = null
}

enum class Environments
{
    Lab,
    Poc,
    Dev,
    Test,
    Int,
    Uat,
    Prod,
}

enum class ResourceProviderTypes
{
    Azure,
    AmazonWebServices,
    GoogleCloudPlatform,
    ActiveDirectoryServices,
    DomainNameSystem,
    SwisscomESC,
    AzureKeyVault,
}

open class ProviderConfigEntryDto
{
    open var name:String? = null
    open var value:String? = null
    open var isSecure:Boolean? = null
}

Kotlin GetResourceProvider 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/resourceproviders/{Id} HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
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}