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
namespace CoreService.ServiceModel.Dtos.Base.Responses

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type ObjectTypes =
        | None = 0
        | ConfigItem = 1
        | Tenant = 2
        | Collection = 3
        | Resource = 4
        | ComputeNode = 5
        | VirtualMachine = 6
        | PhysicalMachine = 7
        | Disk = 8
        | Subnet = 9
        | IPAddress = 10
        | Job = 11
        | JobEvent = 12
        | FreezePeriod = 13
        | ResourceGroup = 14
        | Deployment = 15
        | ResourceGroupTemplate = 16
        | DeploymentTemplate = 17
        | ResourceProvider = 18
        | GenericResource = 19
        | Role = 20
        | Permission = 21
        | User = 22
        | PatchingWindow = 23
        | Update = 24
        | ReportDefinition = 25
        | TimeSeries = 26
        | DataPoint = 27
        | Action = 28
        | ActionAssignment = 29
        | UserNote = 30

    [<AllowNullLiteral>]
    type TagDto() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set
        member val IsProtected:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PathItemDto() = 
        member val Label:String = null with get,set
        member val Link:String = null with get,set
        member val ObjectType:ObjectTypes = new ObjectTypes() with get,set
        member val ObjectId:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type LinkDto() = 
        member val Caption:String = null with get,set
        member val Rel:String = null with get,set
        member val HRef:String = null with get,set
        member val Method:String = null with get,set

    [<AllowNullLiteral>]
    type ConfigItemDto() = 
        member val Id:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val DisplayName:String = null with get,set
        member val Description:String = null with get,set
        member val ObjectType:ObjectTypes = new ObjectTypes() with get,set
        member val SelfLink:String = null with get,set
        member val Tags:IList<TagDto> = null with get,set
        member val Path:IList<PathItemDto> = null with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val CreateUser:String = null with get,set
        member val CreateUserId:String = null with get,set
        member val Modified:DateTime = new DateTime() with get,set
        member val ModifyUser:String = null with get,set
        member val ModifyUserId:String = null with get,set
        member val IsDeleted:Boolean = new Boolean() with get,set
        member val Deleted:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeleteUser:String = null with get,set
        member val DeleteUserId:String = null with get,set
        member val Links:IList<LinkDto> = null with get,set

    type Environments =
        | Lab = 0
        | Poc = 1
        | Dev = 2
        | Test = 3
        | Int = 4
        | Uat = 5
        | Prod = 6

    type ResourceProviderTypes =
        | Azure = 0
        | AmazonWebServices = 1
        | GoogleCloudPlatform = 2
        | ActiveDirectoryServices = 3
        | DomainNameSystem = 4
        | SwisscomESC = 5
        | AzureKeyVault = 6

    [<AllowNullLiteral>]
    type ProviderConfigEntryDto() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set
        member val isSecure:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ResourceProviderDto() = 
        inherit ConfigItemDto()
        member val TenantId:Guid = new Guid() with get,set
        ///<summary>
        ///If environment cannot be detected while scanning, default environment will be used
        ///</summary>
        member val DefaultEnvironment:Environments = new Environments() with get,set

        ///<summary>
        ///List off all allowed environments for this resource provider
        ///</summary>
        member val AllowedEnvironments:IList<Environments> = null with get,set

        ///<summary>
        ///Defines the provider type (e.g. Azure, Aws)
        ///</summary>
        member val Type:ResourceProviderTypes = new ResourceProviderTypes() with get,set

        ///<summary>
        ///Additional generic data which varies depending on ProviderType
        ///</summary>
        member val Config:IList<ProviderConfigEntryDto> = null with get,set

        ///<summary>
        ///Disabled ResourceProviders cannot be selected for new deployments
        ///</summary>
        member val IsDisabled:Boolean = new Boolean() with get,set

        ///<summary>
        ///Shows if a ResourceProvider has been initialized and can accept deployments (resources)
        ///</summary>
        member val IsReadyForDeployments:Boolean = new Boolean() with get,set

        ///<summary>
        ///The cost for the current month
        ///</summary>
        member val CostCurrentMonth:Decimal = new Decimal() with get,set

        ///<summary>
        ///The cost for the last month
        ///</summary>
        member val CostLastMonth:Decimal = new Decimal() with get,set

        ///<summary>
        ///The cost currency
        ///</summary>
        member val CostCurrency:String = null with get,set

    ///<summary>
    ///Returns a single resourceprovider by its id
    ///</summary>
    [<Api(Description="Returns a single resourceprovider by its id")>]
    [<ApiResponse(Description="The request endend successful", IsDefaultResponse=true, ResponseType=typeof<ResourceProviderDto>, StatusCode=200)>]
    [<AllowNullLiteral>]
    type GetResourceProvider() = 
        interface IGet
        ///<summary>
        ///The primary key of every config item
        ///</summary>
        [<ApiMember(DataType="string", Description="The primary key of every config item", Format="guid", IsRequired=true, ParameterType="path")>]
        member val Id:Guid = new Guid() with get,set

        [<ApiMember(DataType="string", IsRequired=true, ParameterType="header")>]
        [<Validate(Validator="NotEmpty")>]
        member val TenantName:String = null with get,set

        ///<summary>
        ///If true, also soft deleted items will be returned
        ///</summary>
        [<ApiMember(Description="If true, also soft deleted items will be returned", ParameterType="query")>]
        member val IncludeDeleted:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<ApiMember(ParameterType="query", Verb="GET")>]
        member val IncludeReferencedObjects:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# 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}