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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CoreService.ServiceModel.Dtos.ResourceProviders.Crud;
using CoreService.ServiceModel.Dtos.ResourceProviders.Responses;
using CoreService.ServiceModel.Dtos.Base.Responses;
using YCO.Dune.Models.Enums;
using CoreService.ServiceModel.Enums;

namespace CoreService.ServiceModel.Dtos.Base.Responses
{
    public partial class ConfigItemDto
        : IConfigItem
    {
        public virtual Guid Id { get; set; }
        public virtual string Name { get; set; }
        public virtual string DisplayName { get; set; }
        public virtual string? Description { get; set; }
        public virtual ObjectTypes ObjectType { get; set; }
        public virtual string SelfLink { get; set; }
        public virtual IList<TagDto> Tags { get; set; }
        public virtual IList<PathItemDto> Path { get; set; }
        public virtual DateTime Created { get; set; }
        public virtual string CreateUser { get; set; }
        public virtual string CreateUserId { get; set; }
        public virtual DateTime Modified { get; set; }
        public virtual string ModifyUser { get; set; }
        public virtual string ModifyUserId { get; set; }
        public virtual bool IsDeleted { get; set; }
        public virtual DateTime? Deleted { get; set; }
        public virtual string? DeleteUser { get; set; }
        public virtual string? DeleteUserId { get; set; }
        public virtual IList<LinkDto> Links { get; set; }
    }

    public partial class LinkDto
    {
        public virtual string Caption { get; set; }
        public virtual string Rel { get; set; }
        public virtual string HRef { get; set; }
        public virtual string Method { get; set; }
    }

    public partial class PathItemDto
    {
        public virtual string Label { get; set; }
        public virtual string Link { get; set; }
        public virtual ObjectTypes ObjectType { get; set; }
        public virtual Guid ObjectId { get; set; }
    }

    public partial class TagDto
    {
        public virtual string Name { get; set; }
        public virtual string? Value { get; set; }
        public virtual bool IsProtected { get; set; }
    }

}

namespace CoreService.ServiceModel.Dtos.ResourceProviders.Crud
{
    ///<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(CoreService.ServiceModel.Dtos.ResourceProviders.Responses.ResourceProviderDto), StatusCode=200)]
    public partial class GetResourceProvider
        : IGetSingleRequest, IHasId, IHasTenantName, 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")]
        public virtual Guid Id { get; set; }

        [ApiMember(DataType="string", IsRequired=true, ParameterType="header")]
        [Validate("NotEmpty")]
        public virtual string TenantName { 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")]
        public virtual bool? IncludeDeleted { get; set; }

        [ApiMember(ParameterType="query", Verb="GET")]
        public virtual bool? IncludeReferencedObjects { get; set; }
    }

}

namespace CoreService.ServiceModel.Dtos.ResourceProviders.Responses
{
    public partial class ProviderConfigEntryDto
    {
        public virtual string Name { get; set; }
        public virtual string Value { get; set; }
        public virtual bool isSecure { get; set; }
    }

    public partial class ResourceProviderDto
        : ConfigItemDto, IHasTenantId
    {
        public virtual Guid TenantId { get; set; }
        ///<summary>
        ///If environment cannot be detected while scanning, default environment will be used
        ///</summary>
        public virtual Environments DefaultEnvironment { get; set; }
        ///<summary>
        ///List off all allowed environments for this resource provider
        ///</summary>
        public virtual IList<Environments> AllowedEnvironments { get; set; }
        ///<summary>
        ///Defines the provider type (e.g. Azure, Aws)
        ///</summary>
        public virtual ResourceProviderTypes Type { get; set; }
        ///<summary>
        ///Additional generic data which varies depending on ProviderType
        ///</summary>
        public virtual IList<ProviderConfigEntryDto> Config { get; set; }
        ///<summary>
        ///Disabled ResourceProviders cannot be selected for new deployments
        ///</summary>
        public virtual bool IsDisabled { get; set; }
        ///<summary>
        ///Shows if a ResourceProvider has been initialized and can accept deployments (resources)
        ///</summary>
        public virtual bool IsReadyForDeployments { get; set; }
        ///<summary>
        ///The cost for the current month
        ///</summary>
        public virtual decimal CostCurrentMonth { get; set; }
        ///<summary>
        ///The cost for the last month
        ///</summary>
        public virtual decimal CostLastMonth { get; set; }
        ///<summary>
        ///The cost currency
        ///</summary>
        public virtual string CostCurrency { get; set; }
    }

}

namespace CoreService.ServiceModel.Enums
{
    public enum Environments
    {
        Lab,
        Poc,
        Dev,
        Test,
        Int,
        Uat,
        Prod,
    }

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

}

namespace YCO.Dune.Models.Enums
{
    public enum 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,
    }

}

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