| Required roles: | TenantReader, TenantAdmin |
| POST | /api/resourceproviders/ | Creates a new resourceprovider | |
|---|---|---|---|
| POST | /resourceproviders/ | Creates a new resourceprovider |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Creates a new resourceprovider
*/
@Api(Description="Creates a new resourceprovider")
@ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=ResourceProviderDto.class, StatusCode=201)
public static class CreateResourceProvider implements ICreateRequest, IHasTenantName, IPost
{
@ApiMember(DataType="string", IsRequired=true, ParameterType="header")
@Validate(Validator="NotEmpty")
public String tenantName = null;
/**
* The resource providers name
*/
@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]+$′)")
public String name = null;
/**
* The resource providers display name
*/
@ApiMember(DataType="string", Description="The resource providers display name", ParameterType="body")
@Validate(Validator="MaximumLength(250)")
public String displayName = null;
/**
* A more detailed description for the resource provider
*/
@ApiMember(DataType="string", Description="A more detailed description for the resource provider", ParameterType="body")
@Validate(Validator="MaximumLength(8000)")
public String description = null;
/**
* If environment cannot be detected while scanning, default environment will be used
*/
@ApiMember(Description="If environment cannot be detected while scanning, default environment will be used", IsRequired=true, ParameterType="body")
@Validate(Validator="NotNull")
public Environments defaultEnvironment = null;
/**
* List off all allowed environments for this resource provider
*/
@ApiMember(Description="List off all allowed environments for this resource provider", IsRequired=true, ParameterType="body")
@Validate(Validator="NotEmpty")
public IList<Environments> allowedEnvironments = null;
/**
* The provider type (e.g. Azure)
*/
@ApiMember(Description="The provider type (e.g. Azure)", IsRequired=true, ParameterType="body")
@Validate(Validator="NotNull")
public ResourceProviderTypes type = null;
/**
* The resource provider config
*/
@ApiMember(DataType="array", Description="The resource provider config", IsRequired=true, ParameterType="body")
@Validate(Validator="NotNull")
public IList<ProviderConfigEntryDto> config = null;
@ApiMember(DataType="array", ParameterType="body")
public IList<TagDto> tags = null;
/**
* Disabled resource providers will be ignored when scanning, etc.
*/
@ApiMember(Description="Disabled resource providers will be ignored when scanning, etc.", IsRequired=true, ParameterType="body")
@Validate(Validator="NotNull")
public Boolean isDisabled = null;
/**
* Start the initialization process, which enables the resource provider for deployments if successfull
*/
@ApiMember(Description="Start the initialization process, which enables the resource provider for deployments if successfull", IsRequired=true, ParameterType="body")
@Validate(Validator="NotNull")
public Boolean initializeForDeployments = null;
public String getTenantName() { return tenantName; }
public CreateResourceProvider setTenantName(String value) { this.tenantName = value; return this; }
public String getName() { return name; }
public CreateResourceProvider setName(String value) { this.name = value; return this; }
public String getDisplayName() { return displayName; }
public CreateResourceProvider setDisplayName(String value) { this.displayName = value; return this; }
public String getDescription() { return description; }
public CreateResourceProvider setDescription(String value) { this.description = value; return this; }
public Environments getDefaultEnvironment() { return defaultEnvironment; }
public CreateResourceProvider setDefaultEnvironment(Environments value) { this.defaultEnvironment = value; return this; }
public IList<Environments> getAllowedEnvironments() { return allowedEnvironments; }
public CreateResourceProvider setAllowedEnvironments(IList<Environments> value) { this.allowedEnvironments = value; return this; }
public ResourceProviderTypes getType() { return type; }
public CreateResourceProvider setType(ResourceProviderTypes value) { this.type = value; return this; }
public IList<ProviderConfigEntryDto> getConfig() { return config; }
public CreateResourceProvider setConfig(IList<ProviderConfigEntryDto> value) { this.config = value; return this; }
public IList<TagDto> getTags() { return tags; }
public CreateResourceProvider setTags(IList<TagDto> value) { this.tags = value; return this; }
public Boolean getIsDisabled() { return isDisabled; }
public CreateResourceProvider setIsDisabled(Boolean value) { this.isDisabled = value; return this; }
public Boolean isInitializeForDeployments() { return initializeForDeployments; }
public CreateResourceProvider setInitializeForDeployments(Boolean value) { this.initializeForDeployments = value; return this; }
}
public static enum Environments
{
Lab,
Poc,
Dev,
Test,
Int,
Uat,
Prod;
}
public static enum ResourceProviderTypes
{
Azure,
AmazonWebServices,
GoogleCloudPlatform,
ActiveDirectoryServices,
DomainNameSystem,
SwisscomESC,
AzureKeyVault;
}
public static class ProviderConfigEntryDto
{
public String name = null;
public String value = null;
public Boolean isSecure = null;
public String getName() { return name; }
public ProviderConfigEntryDto setName(String value) { this.name = value; return this; }
public String getValue() { return value; }
public ProviderConfigEntryDto setValue(String value) { this.value = value; return this; }
public Boolean getIsSecure() { return isSecure; }
public ProviderConfigEntryDto setIsSecure(Boolean value) { this.isSecure = value; return this; }
}
public static class TagDto
{
public String name = null;
public String value = null;
public Boolean isProtected = null;
public String getName() { return name; }
public TagDto setName(String value) { this.name = value; return this; }
public String getValue() { return value; }
public TagDto setValue(String value) { this.value = value; return this; }
public Boolean getIsProtected() { return isProtected; }
public TagDto setIsProtected(Boolean value) { this.isProtected = value; return this; }
}
public static class ResourceProviderDto extends ConfigItemDto implements IHasTenantId
{
public UUID tenantId = null;
/**
* If environment cannot be detected while scanning, default environment will be used
*/
public Environments defaultEnvironment = null;
/**
* List off all allowed environments for this resource provider
*/
public IList<Environments> allowedEnvironments = null;
/**
* Defines the provider type (e.g. Azure, Aws)
*/
public ResourceProviderTypes type = null;
/**
* Additional generic data which varies depending on ProviderType
*/
public IList<ProviderConfigEntryDto> config = null;
/**
* Disabled ResourceProviders cannot be selected for new deployments
*/
public Boolean isDisabled = null;
/**
* Shows if a ResourceProvider has been initialized and can accept deployments (resources)
*/
public Boolean isReadyForDeployments = null;
/**
* The cost for the current month
*/
public BigDecimal costCurrentMonth = null;
/**
* The cost for the last month
*/
public BigDecimal costLastMonth = null;
/**
* The cost currency
*/
public String costCurrency = null;
public UUID getTenantId() { return tenantId; }
public ResourceProviderDto setTenantId(UUID value) { this.tenantId = value; return this; }
public Environments getDefaultEnvironment() { return defaultEnvironment; }
public ResourceProviderDto setDefaultEnvironment(Environments value) { this.defaultEnvironment = value; return this; }
public IList<Environments> getAllowedEnvironments() { return allowedEnvironments; }
public ResourceProviderDto setAllowedEnvironments(IList<Environments> value) { this.allowedEnvironments = value; return this; }
public ResourceProviderTypes getType() { return type; }
public ResourceProviderDto setType(ResourceProviderTypes value) { this.type = value; return this; }
public IList<ProviderConfigEntryDto> getConfig() { return config; }
public ResourceProviderDto setConfig(IList<ProviderConfigEntryDto> value) { this.config = value; return this; }
public Boolean getIsDisabled() { return isDisabled; }
public ResourceProviderDto setIsDisabled(Boolean value) { this.isDisabled = value; return this; }
public Boolean getIsReadyForDeployments() { return isReadyForDeployments; }
public ResourceProviderDto setIsReadyForDeployments(Boolean value) { this.isReadyForDeployments = value; return this; }
public BigDecimal getCostCurrentMonth() { return costCurrentMonth; }
public ResourceProviderDto setCostCurrentMonth(BigDecimal value) { this.costCurrentMonth = value; return this; }
public BigDecimal getCostLastMonth() { return costLastMonth; }
public ResourceProviderDto setCostLastMonth(BigDecimal value) { this.costLastMonth = value; return this; }
public String getCostCurrency() { return costCurrency; }
public ResourceProviderDto setCostCurrency(String value) { this.costCurrency = value; return this; }
}
public static class ConfigItemDto implements IConfigItem
{
public UUID id = null;
public String name = null;
public String displayName = null;
public String description = null;
public ObjectTypes objectType = null;
public String selfLink = null;
public IList<TagDto> tags = null;
public IList<PathItemDto> path = null;
public Date created = null;
public String createUser = null;
public String createUserId = null;
public Date modified = null;
public String modifyUser = null;
public String modifyUserId = null;
public Boolean isDeleted = null;
public Date deleted = null;
public String deleteUser = null;
public String deleteUserId = null;
public IList<LinkDto> links = null;
public UUID getId() { return id; }
public ConfigItemDto setId(UUID value) { this.id = value; return this; }
public String getName() { return name; }
public ConfigItemDto setName(String value) { this.name = value; return this; }
public String getDisplayName() { return displayName; }
public ConfigItemDto setDisplayName(String value) { this.displayName = value; return this; }
public String getDescription() { return description; }
public ConfigItemDto setDescription(String value) { this.description = value; return this; }
public ObjectTypes getObjectType() { return objectType; }
public ConfigItemDto setObjectType(ObjectTypes value) { this.objectType = value; return this; }
public String getSelfLink() { return selfLink; }
public ConfigItemDto setSelfLink(String value) { this.selfLink = value; return this; }
public IList<TagDto> getTags() { return tags; }
public ConfigItemDto setTags(IList<TagDto> value) { this.tags = value; return this; }
public IList<PathItemDto> getPath() { return path; }
public ConfigItemDto setPath(IList<PathItemDto> value) { this.path = value; return this; }
public Date getCreated() { return created; }
public ConfigItemDto setCreated(Date value) { this.created = value; return this; }
public String getCreateUser() { return createUser; }
public ConfigItemDto setCreateUser(String value) { this.createUser = value; return this; }
public String getCreateUserId() { return createUserId; }
public ConfigItemDto setCreateUserId(String value) { this.createUserId = value; return this; }
public Date getModified() { return modified; }
public ConfigItemDto setModified(Date value) { this.modified = value; return this; }
public String getModifyUser() { return modifyUser; }
public ConfigItemDto setModifyUser(String value) { this.modifyUser = value; return this; }
public String getModifyUserId() { return modifyUserId; }
public ConfigItemDto setModifyUserId(String value) { this.modifyUserId = value; return this; }
public Boolean getIsDeleted() { return isDeleted; }
public ConfigItemDto setIsDeleted(Boolean value) { this.isDeleted = value; return this; }
public Date getDeleted() { return deleted; }
public ConfigItemDto setDeleted(Date value) { this.deleted = value; return this; }
public String getDeleteUser() { return deleteUser; }
public ConfigItemDto setDeleteUser(String value) { this.deleteUser = value; return this; }
public String getDeleteUserId() { return deleteUserId; }
public ConfigItemDto setDeleteUserId(String value) { this.deleteUserId = value; return this; }
public IList<LinkDto> getLinks() { return links; }
public ConfigItemDto setLinks(IList<LinkDto> value) { this.links = value; return this; }
}
public static 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;
}
public static class PathItemDto
{
public String label = null;
public String link = null;
public ObjectTypes objectType = null;
public UUID objectId = null;
public String getLabel() { return label; }
public PathItemDto setLabel(String value) { this.label = value; return this; }
public String getLink() { return link; }
public PathItemDto setLink(String value) { this.link = value; return this; }
public ObjectTypes getObjectType() { return objectType; }
public PathItemDto setObjectType(ObjectTypes value) { this.objectType = value; return this; }
public UUID getObjectId() { return objectId; }
public PathItemDto setObjectId(UUID value) { this.objectId = value; return this; }
}
public static class LinkDto
{
public String caption = null;
public String rel = null;
public String hRef = null;
public String method = null;
public String getCaption() { return caption; }
public LinkDto setCaption(String value) { this.caption = value; return this; }
public String getRel() { return rel; }
public LinkDto setRel(String value) { this.rel = value; return this; }
public String getHRef() { return hRef; }
public LinkDto setHRef(String value) { this.hRef = value; return this; }
public String getMethod() { return method; }
public LinkDto setMethod(String value) { this.method = value; return this; }
}
}
Java 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}