| Required roles: | TenantReader, TenantAdmin |
| POST | /api/resourceproviders/ | Creates a new resourceprovider | |
|---|---|---|---|
| POST | /resourceproviders/ | Creates a new 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>
///Creates a new resourceprovider
///</summary>
[<Api(Description="Creates a new resourceprovider")>]
[<ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof<ResourceProviderDto>, StatusCode=201)>]
[<AllowNullLiteral>]
type CreateResourceProvider() =
interface IPost
[<ApiMember(DataType="string", IsRequired=true, ParameterType="header")>]
[<Validate(Validator="NotEmpty")>]
member val TenantName:String = null with get,set
///<summary>
///The resource providers name
///</summary>
[<ApiMember(DataType="string", Description="The resource providers name", IsRequired=true, ParameterType="body")>]
[<Validate(Validator="NotEmpty")>]
[<Validate(Validator="MaximumLength(50)")>]
[<Validate(Validator="RegularExpression(′^[0-9a-z]+[0-9a-z-]*[0-9a-z]+$′)")>]
member val Name:String = null with get,set
///<summary>
///The resource providers display name
///</summary>
[<ApiMember(DataType="string", Description="The resource providers display name", ParameterType="body")>]
[<Validate(Validator="MaximumLength(250)")>]
member val DisplayName:String = null with get,set
///<summary>
///A more detailed description for the resource provider
///</summary>
[<ApiMember(DataType="string", Description="A more detailed description for the resource provider", ParameterType="body")>]
[<Validate(Validator="MaximumLength(8000)")>]
member val Description:String = null with get,set
///<summary>
///If environment cannot be detected while scanning, default environment will be used
///</summary>
[<ApiMember(Description="If environment cannot be detected while scanning, default environment will be used", IsRequired=true, ParameterType="body")>]
[<Validate(Validator="NotNull")>]
member val DefaultEnvironment:Environments = new Environments() with get,set
///<summary>
///List off all allowed environments for this resource provider
///</summary>
[<ApiMember(Description="List off all allowed environments for this resource provider", IsRequired=true, ParameterType="body")>]
[<Validate(Validator="NotEmpty")>]
member val AllowedEnvironments:IList<Environments> = null with get,set
///<summary>
///The provider type (e.g. Azure)
///</summary>
[<ApiMember(Description="The provider type (e.g. Azure)", IsRequired=true, ParameterType="body")>]
[<Validate(Validator="NotNull")>]
member val Type:Nullable<ResourceProviderTypes> = new Nullable<ResourceProviderTypes>() with get,set
///<summary>
///The resource provider config
///</summary>
[<ApiMember(DataType="array", Description="The resource provider config", IsRequired=true, ParameterType="body")>]
[<Validate(Validator="NotNull")>]
member val Config:IList<ProviderConfigEntryDto> = null with get,set
[<ApiMember(DataType="array", ParameterType="body")>]
member val Tags:IList<TagDto> = null with get,set
///<summary>
///Disabled resource providers will be ignored when scanning, etc.
///</summary>
[<ApiMember(Description="Disabled resource providers will be ignored when scanning, etc.", IsRequired=true, ParameterType="body")>]
[<Validate(Validator="NotNull")>]
member val IsDisabled:Boolean = new Boolean() with get,set
///<summary>
///Start the initialization process, which enables the resource provider for deployments if successfull
///</summary>
[<ApiMember(Description="Start the initialization process, which enables the resource provider for deployments if successfull", IsRequired=true, ParameterType="body")>]
[<Validate(Validator="NotNull")>]
member val InitializeForDeployments:Boolean = new Boolean() with get,set
F# 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}