| Required role: | TenantReader |
| GET | /api/resourcegroups/ | Returns all resourcegroups | |
|---|---|---|---|
| GET | /resourcegroups/ | Returns all resourcegroups |
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.ResourceGroups.Crud;
using CoreService.ServiceModel.BusinessObjects.Structure;
using CoreService.ServiceModel.BusinessObjects.Base;
using CoreService.ServiceModel.BusinessObjects.Audit;
using YCO.Dune.Models.Enums;
using CoreService.ServiceModel.Enums;
using CoreService.ServiceModel.BusinessObjects.TimeSeries;
namespace CoreService.ServiceModel.BusinessObjects.Audit
{
public partial class Auditable
: IAuditable
{
[Required]
public virtual DateTime Created { get; set; }
[Required]
public virtual string CreateUser { get; set; }
[Required]
public virtual string CreateUserId { get; set; }
[Required]
public virtual DateTime Modified { get; set; }
[Required]
public virtual string ModifyUser { get; set; }
[Required]
public virtual string ModifyUserId { get; set; }
[Required]
public virtual bool IsDeleted { get; set; }
public virtual DateTime? Deleted { get; set; }
public virtual string? DeleteUser { get; set; }
public virtual string? DeleteUserId { get; set; }
}
}
namespace CoreService.ServiceModel.BusinessObjects.Base
{
public partial class ConfigItem
: Auditable, IConfigItem
{
public virtual Guid Id { get; set; }
[Required]
public virtual string Name { get; set; }
[Required]
[StringLength(250)]
public virtual string DisplayName { get; set; }
[StringLength(8000)]
public virtual string? Description { get; set; }
public virtual ObjectTypes ObjectType { get; set; }
[Ignore]
public virtual string SelfLink { get; set; }
[Required]
public virtual IList<Tag> Tags { get; set; }
[Required]
public virtual IList<PathItem> Path { get; set; }
}
public partial class Parameter
{
public virtual string Name { get; set; }
public virtual string? Description { get; set; }
public virtual string? Value { get; set; }
public virtual string? Default { get; set; }
public virtual bool Optional { get; set; }
public virtual ParameterValueType Type { get; set; }
public virtual string? Validation { get; set; }
}
public partial class PathItem
{
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 Tag
{
public virtual string Name { get; set; }
public virtual string? Value { get; set; }
public virtual bool IsProtected { get; set; }
}
public partial class Variable
{
public virtual string Name { get; set; }
public virtual string Value { get; set; }
public virtual ValueDataType Type { get; set; }
public virtual string? Description { get; set; }
public virtual bool IsInherited { get; set; }
public virtual Environments? Environment { get; set; }
}
}
namespace CoreService.ServiceModel.BusinessObjects.Structure
{
public partial class Deployment
: ConfigItem, IHasTenantId, IHasVariables, IEnvironmentSpecific, IHasSequence
{
[Required]
public virtual string ShortId { get; set; }
[Required]
public virtual Guid TenantId { get; set; }
[Required]
[StringLength(100)]
public virtual string Name { get; set; }
[Required]
public virtual string NameUserDefinedPart { get; set; }
[Required]
public virtual ObjectTypes ObjectType { get; set; }
[Ignore]
public virtual string SelfLink { get; set; }
[Required]
public virtual LifecycleStates State { get; set; }
[Required]
public virtual Environments Environment { get; set; }
public virtual Guid? TemplateId { get; set; }
[Required]
public virtual IList<Parameter> Parameters { get; set; }
[Required]
public virtual IList<Variable> Variables { get; set; }
[Required]
public virtual IList<Variable> VariablesSnapshot { get; set; }
[Required]
[References(typeof(CoreService.ServiceModel.BusinessObjects.Structure.DeploymentCollection))]
public virtual Guid ParentId { get; set; }
public virtual DeploymentCollection? Parent { get; set; }
[Required]
public virtual DateTime ValidFrom { get; set; }
public virtual DateTime? ValidUntil { get; set; }
[Required]
public virtual bool IsNeverExpiring { get; set; }
public virtual DateTime? NextPatchDate { get; set; }
[Required]
public virtual Guid DefaultResourceProviderId { get; set; }
[Required]
public virtual bool NeedsAttention { get; set; }
public virtual ResourceCompositions Composition { get; set; }
public virtual decimal MonthlyBudget { get; set; }
public virtual bool SendBudgetNotificationMails { get; set; }
public virtual int BudgetWarningThresholdPercent { get; set; }
public virtual OperationalStates OperationalState { get; set; }
public virtual int ResourcesRunning { get; set; }
public virtual int ResourcesTotal { get; set; }
}
public partial class DeploymentCollection
: ConfigItem, IHasTenantId, IHasVariables
{
[Required]
public virtual Guid TenantId { get; set; }
[Required]
[StringLength(50)]
public virtual string Name { get; set; }
[Required]
public virtual ObjectTypes ObjectType { get; set; }
[Ignore]
public virtual string SelfLink { get; set; }
[Required]
public virtual IList<Variable> Variables { get; set; }
[Required]
public virtual bool IsLostAndFound { get; set; }
public virtual decimal MonthlyBudget { get; set; }
public virtual bool SendBudgetNotificationMails { get; set; }
public virtual int BudgetWarningThresholdPercent { get; set; }
}
public partial class ResourceGroup
: ConfigItem, IHasTenantId, IHasVariables, IEnvironmentSpecific, IHasSequence
{
[Required]
public virtual string ShortId { get; set; }
[Required]
public virtual Guid TenantId { get; set; }
[Required]
[StringLength(50)]
public virtual string Name { get; set; }
[Required]
public virtual ObjectTypes ObjectType { get; set; }
[Ignore]
public virtual string SelfLink { get; set; }
[Required]
public virtual Environments Environment { get; set; }
[Required]
public virtual LifecycleStates State { get; set; }
[Required]
[References(typeof(CoreService.ServiceModel.BusinessObjects.Structure.Deployment))]
public virtual Guid ParentId { get; set; }
public virtual Deployment? Parent { get; set; }
public virtual Guid? TemplateId { get; set; }
[Required]
public virtual IList<Parameter> Parameters { get; set; }
[Required]
public virtual IList<Variable> Variables { get; set; }
public virtual DateTime? NextPatchDate { get; set; }
public virtual ResourceCompositions Composition { get; set; }
}
public partial class Tenant
: ConfigItem, IHasVariables
{
[Required]
[StringLength(10)]
public virtual string Name { get; set; }
[Required]
public virtual ObjectTypes ObjectType { get; set; }
[Ignore]
public virtual string SelfLink { get; set; }
[Required]
public virtual IList<Variable> Variables { get; set; }
[Required]
public virtual IList<string> AllowedMailDomains { get; set; }
[Required]
public virtual IList<string> LicensedModules { get; set; }
[Required]
public virtual short DefaultDeploymentLifetimeDays { get; set; }
[Required]
public virtual short MaxDeploymentLifetimeDays { get; set; }
[Required]
public virtual short SystemUnpatchedWarningDays { get; set; }
[Required]
public virtual short SystemBackupMissingWarningHours { get; set; }
[Required]
public virtual short StopVulnerableResourceAfterDays { get; set; }
[Required]
public virtual short DeploymentExpirationWarningDays { get; set; }
[Required]
public virtual short PatchNotificationDays { get; set; }
[Required]
public virtual bool UseCustomHostnames { get; set; }
[Required]
public virtual short RemoveInactiveVulnerabilitiesAfterDays { get; set; }
}
}
namespace CoreService.ServiceModel.BusinessObjects.TimeSeries
{
public partial class TimeSeriesDefinition
: Auditable, IHasIdName, IHasTenantId, IHasObjectType
{
public virtual Guid Id { get; set; }
[References(typeof(CoreService.ServiceModel.BusinessObjects.Structure.Tenant))]
public virtual Guid TenantId { get; set; }
public virtual Tenant? Tenant { get; set; }
public virtual string Name { get; set; }
public virtual string? DisplayName { get; set; }
[Ignore]
public virtual string SelfLink { get; set; }
[Required]
public virtual ObjectTypes ObjectType { get; set; }
public virtual string? Description { get; set; }
public virtual ObjectTypes SourceType { get; set; }
public virtual bool AutoCollection { get; set; }
public virtual string? AutoCollectionQuery { get; set; }
public virtual int? AutoCollectionInterval { get; set; }
public virtual IntervalUnits? AutoCollectionIntervalUnit { get; set; }
public virtual TimeOnly? AutoCollectionTime { get; set; }
public virtual DateTime? LastAutoCollected { get; set; }
public virtual int RetentionTimeMonths { get; set; }
}
}
namespace CoreService.ServiceModel.Dtos.ResourceGroups.Crud
{
///<summary>
///GetResourceGroups
///</summary>
[Api(Description="GetResourceGroups")]
[ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(YCO.Dune.Models.Dtos.Common.Responses.ItemsResponse`1[[CoreService.ServiceModel.Dtos.ResourceGroups.Responses.ResourceGroupDto, CoreService.ServiceModel, Version=0.15.14.0, Culture=neutral, PublicKeyToken=null]]), StatusCode=200)]
public partial class QueryResourceGroups
: QueryDb<ResourceGroup>, IGetMultipleRequest, IHasTenantName, IGet, IGroupable
{
[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; }
///<summary>
///The property, the data will be grouped on
///</summary>
[ApiMember(Description="The property, the data will be grouped on", ParameterType="query")]
public virtual string? GroupBy { get; set; }
///<summary>
///The property, used for aggregation
///</summary>
[ApiMember(Description="The property, used for aggregation", ParameterType="query")]
public virtual string? AggregateOn { get; set; }
///<summary>
///The aggregation function to use
///</summary>
[ApiMember(Description="The aggregation function to use", ParameterType="query")]
public virtual Aggregations? Aggregation { get; set; }
///<summary>
///Returns all referenced object
///</summary>
[ApiMember(Description="Returns all referenced object", ParameterType="query")]
public virtual bool? IncludeReferencedObjects { get; set; }
}
}
namespace CoreService.ServiceModel.Enums
{
public enum Aggregations
{
None,
Count,
DistinctCount,
Sum,
Min,
Max,
Avg,
First,
}
public enum Environments
{
Lab,
Poc,
Dev,
Test,
Int,
Uat,
Prod,
}
public enum LifecycleStates
{
New,
Deploying,
Deployed,
Removing,
Removed,
Failure,
Imported,
}
public enum OperationalStates
{
None,
Starting,
Running,
Stopping,
Stopped,
Restarting,
Deleting,
Unknown,
}
public enum ParameterValueType
{
String,
Number,
Boolean,
SecureString,
}
public enum ResourceCompositions
{
Native,
Foreign,
Mixed,
}
public enum ValueDataType
{
String,
Number,
Boolean,
List,
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
[DataMember(Order=1)]
public virtual int? Skip { get; set; }
[DataMember(Order=2)]
public virtual int? Take { get; set; }
[DataMember(Order=3)]
public virtual string? OrderBy { get; set; }
[DataMember(Order=4)]
public virtual string? OrderByDesc { get; set; }
[DataMember(Order=5)]
public virtual string? Include { get; set; }
[DataMember(Order=6)]
public virtual string? Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string>? Meta { get; set; }
}
public partial class QueryDb<T>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<T>
{
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<TimeSeriesDefinition> Results { get; set; } = [];
[DataMember(Order=4)]
public virtual Dictionary<string, string>? Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus? ResponseStatus { get; set; }
}
}
namespace YCO.Dune.Models.Enums
{
public enum IntervalUnits
{
Second,
Minute,
Hour,
Day,
Week,
Month,
Year,
}
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,
}
}
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.
GET /api/resourcegroups/ HTTP/1.1 Host: core.starburst.svc Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"offset":0,"total":0,"results":[{"shortId":"String","tenantId":"00000000-0000-0000-0000-000000000000","name":"String","objectType":"ResourceGroup","selfLink":"/resourcegroups/00000000-0000-0000-0000-000000000000","environment":"Lab","state":"New","parentId":"00000000-0000-0000-0000-000000000000","parent":{"shortId":"String","tenantId":"00000000-0000-0000-0000-000000000000","name":"String","nameUserDefinedPart":"String","objectType":"Deployment","selfLink":"/deployments/00000000-0000-0000-0000-000000000000","state":"New","environment":"Lab","templateId":"00000000-0000-0000-0000-000000000000","parameters":null,"variables":null,"variablesSnapshot":null,"parentId":"00000000-0000-0000-0000-000000000000","parent":{"tenantId":"00000000-0000-0000-0000-000000000000","name":"String","objectType":"Collection","selfLink":"/collections/00000000-0000-0000-0000-000000000000","variables":null,"isLostAndFound":false,"monthlyBudget":0,"sendBudgetNotificationMails":false,"budgetWarningThresholdPercent":0,"id":"00000000-0000-0000-0000-000000000000","displayName":"String","description":"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"},"validFrom":"0001-01-01T00:00:00.0000000Z","validUntil":"0001-01-01T00:00:00.0000000Z","isNeverExpiring":false,"nextPatchDate":"0001-01-01T00:00:00.0000000Z","defaultResourceProviderId":"00000000-0000-0000-0000-000000000000","needsAttention":false,"composition":"Native","monthlyBudget":0,"sendBudgetNotificationMails":false,"budgetWarningThresholdPercent":0,"operationalState":"None","resourcesRunning":0,"resourcesTotal":0,"id":"00000000-0000-0000-0000-000000000000","displayName":"String","description":"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"},"templateId":"00000000-0000-0000-0000-000000000000","parameters":null,"variables":null,"nextPatchDate":"0001-01-01T00:00:00.0000000Z","composition":"Native","id":"00000000-0000-0000-0000-000000000000","displayName":"String","description":"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"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}