CoreService

<back to all web services

GetIpAddress

IpAddress - CRUD

Get an ip address

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/ipaddresses/{Id}returns an ip address by its id
GET/ipaddresses/{Id}returns an ip address by its id
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.Resources.Network.Crud;
using CoreService.ServiceModel.Dtos.Resources.Network.Responses;
using CoreService.ServiceModel.Dtos.Base.Responses;
using YCO.Dune.Models.Enums;
using CoreService.ServiceModel.Dtos.Resources.Common.Responses;
using CoreService.ServiceModel.Dtos.Deployments.Responses;
using CoreService.ServiceModel.Enums;
using CoreService.ServiceModel.Dtos.Collections.Responses;
using CoreService.ServiceModel.Dtos.Tenant.Responses;
using CoreService.ServiceModel.Dtos.ResourceProviders.Responses;

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 ParameterDto
    {
        public virtual string Name { get; set; }
        public virtual string? Description { get; set; }
        ///<summary>
        ///Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false). Note: string values need extra quotes
        ///</summary>
        public virtual string? Value { get; set; }
        ///<summary>
        ///Optional default value for the frontend. Needs to be in the same format as the value
        ///</summary>
        public virtual string? Default { get; set; }
        ///<summary>
        ///Optional parameters do not need to have a value. Default -> Optional=false
        ///</summary>
        public virtual bool Optional { get; set; }
        ///<summary>
        ///The data type of the value and default property
        ///</summary>
        public virtual ParameterValueType Type { get; set; }
        public virtual string? Validation { 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; }
    }

    public partial class VariableDto
    {
        public virtual string Name { get; set; }
        ///<summary>
        ///Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false, List = [1,2,3,4]). Note: string values need extra quotes
        ///</summary>
        public virtual string Value { get; set; }
        ///<summary>
        ///The data type of the value property
        ///</summary>
        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.Dtos.Collections.Responses
{
    public partial class DeploymentCollectionDto
        : ConfigItemDto, IHasTenantId
    {
        public virtual Guid TenantId { get; set; }
        public virtual TenantDto? Tenant { get; set; }
        ///<summary>
        ///A collection scoped list of variables
        ///</summary>
        public virtual IList<VariableDto> Variables { get; set; }
        ///<summary>
        ///Defines the collection where scanned but not deployed resources will be stored
        ///</summary>
        public virtual bool IsLostAndFound { get; set; }
        ///<summary>
        ///The monthly cost budget for the whole collection
        ///</summary>
        public virtual decimal? MonthlyBudget { get; set; }
        ///<summary>
        ///Whether to send budget information mails to the collection owners
        ///</summary>
        public virtual bool? SendBudgetNotificationMails { get; set; }
        ///<summary>
        ///A threshold, when to send the first budget warning mail
        ///</summary>
        public virtual int? BudgetWarningThresholdPercent { get; set; }
        public virtual IList<LinkDto> Links { get; set; }
    }

}

namespace CoreService.ServiceModel.Dtos.Deployments.Responses
{
    public partial class DeploymentDto
        : ConfigItemDto, IHasParentDto, IHasTenantId, IEnvironmentSpecific
    {
        ///<summary>
        ///The operational state of the deployment (Running, Stopped, None, Unknown)
        ///</summary>
        public virtual OperationalStates OperationalState { get; set; }
        ///<summary>
        ///How many start/stop-capable resources are currently running
        ///</summary>
        public virtual int ResourcesRunning { get; set; }
        ///<summary>
        ///Total number of start/stop-capable resources in this deployment
        ///</summary>
        public virtual int ResourcesTotal { get; set; }
        ///<summary>
        ///Shorter id than the guid which can be used for automation (tenant wide unique) prefixed with a 'd'. E.g. dr36x3
        ///</summary>
        public virtual string ShortId { get; set; }
        ///<summary>
        ///The user defined part of the name property {userDefined}_{environment}
        ///</summary>
        public virtual string NameUserDefinedPart { get; set; }
        ///<summary>
        ///The id of the tenant
        ///</summary>
        public virtual Guid TenantId { get; set; }
        ///<summary>
        ///The state of the deployment
        ///</summary>
        public virtual LifecycleStates State { get; set; }
        ///<summary>
        ///The environment the deployment is deployed in
        ///</summary>
        public virtual Environments Environment { get; set; }
        ///<summary>
        ///The id of the template which was used to create the deployment
        ///</summary>
        public virtual Guid? TemplateId { get; set; }
        ///<summary>
        ///Shows if a deployment was rolled out through a dune template or not
        ///</summary>
        public virtual bool IsTemplateBased { get; set; }
        ///<summary>
        ///The parameters which were used to create this deployment
        ///</summary>
        public virtual IList<ParameterDto> Parameters { get; set; }
        ///<summary>
        ///A deployment scoped list of variables used for deployment of resources
        ///</summary>
        public virtual IList<VariableDto> Variables { get; set; }
        ///<summary>
        ///A snapshot of the varialbs used to create the deployment
        ///</summary>
        public virtual IList<VariableDto> VariablesSnapshot { get; set; }
        ///<summary>
        ///The id of the parent (collection) of the deployment
        ///</summary>
        public virtual Guid ParentId { get; set; }
        ///<summary>
        ///The parent (collection) of the deployment
        ///</summary>
        public virtual ConfigItemDto? Parent { get; set; }
        ///<summary>
        ///The Date when the resources got deployed
        ///</summary>
        public virtual DateTime ValidFrom { get; set; }
        ///<summary>
        ///The Date when the deployment expires and has to be reevaluated
        ///</summary>
        public virtual DateTime? ValidUntil { get; set; }
        ///<summary>
        ///The deployment will never expire
        ///</summary>
        public virtual bool IsNeverExpiring { get; set; }
        ///<summary>
        ///The date, when the deployments resources will receive updates
        ///</summary>
        public virtual DateTime? NextPatchDate { get; set; }
        ///<summary>
        ///The default resource provider where the resources are deployed
        ///</summary>
        public virtual Guid DefaultResourceProviderId { get; set; }
        ///<summary>
        ///Deployments which have issues in Jobs are marked with NeedsAttention
        ///</summary>
        public virtual bool NeedsAttention { get; set; }
        ///<summary>
        ///Composition show if all resources in the deployment are dune native, dune foreign or a mix of both
        ///</summary>
        public virtual ResourceCompositions Composition { get; set; }
        ///<summary>
        ///The monthly cost budget for the whole collection
        ///</summary>
        public virtual decimal? MonthlyBudget { get; set; }
        ///<summary>
        ///Whether to send budget information mails to the collection owners
        ///</summary>
        public virtual bool? SendBudgetNotificationMails { get; set; }
        ///<summary>
        ///A threshold, when to send the first budget warning mail
        ///</summary>
        public virtual int? BudgetWarningThresholdPercent { get; set; }
        public virtual IList<LinkDto> Links { 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.Dtos.Resources.Common.Responses
{
    public partial class ResourceDto
        : ConfigItemDto, IResourceDto
    {
        ///<summary>
        ///Free text field to store an external resource id
        ///</summary>
        public virtual string? ExtId { get; set; }
        ///<summary>
        ///Free text field to store an external resource type
        ///</summary>
        public virtual string? ExtType { get; set; }
        ///<summary>
        ///Free text field to store an external resource name
        ///</summary>
        public virtual string? ExtName { get; set; }
        ///<summary>
        ///The id of the tenant
        ///</summary>
        public virtual Guid TenantId { get; set; }
        ///<summary>
        ///The id of the parent (ResourceGroup)
        ///</summary>
        public virtual Guid ParentId { get; set; }
        ///<summary>
        ///The parent (ResourceGroup
        ///</summary>
        public virtual ConfigItemDto? Parent { get; set; }
        ///<summary>
        ///The id of the parent (Deployment
        ///</summary>
        public virtual Guid DeploymentId { get; set; }
        ///<summary>
        ///The parent (Deployement
        ///</summary>
        public virtual DeploymentDto? Deployment { get; set; }
        ///<summary>
        ///The id of the collection the resource belongs to
        ///</summary>
        public virtual Guid CollectionId { get; set; }
        ///<summary>
        ///The collection the resource belongs to
        ///</summary>
        public virtual DeploymentCollectionDto? Collection { get; set; }
        ///<summary>
        ///The environment the resourcegroup is deployed in
        ///</summary>
        public virtual Environments Environment { get; set; }
        ///<summary>
        ///The id of the provider of the resource (e.g. Azure, AWS, other DC provider
        ///</summary>
        public virtual Guid ResourceProviderId { get; set; }
        ///<summary>
        ///The provider of the resource (e.g. Azure, AWS, other DC provider
        ///</summary>
        public virtual ResourceProviderDto? ResourceProvider { get; set; }
        ///<summary>
        ///State of the resource
        ///</summary>
        public virtual OperationalStates State { get; set; }
        public virtual IList<VariableDto> Variables { get; set; }
        ///<summary>
        ///Can be used for dc location
        ///</summary>
        public virtual string? Location { get; set; }
        ///<summary>
        ///Last time the resource was seen/updated by a scan/cfgmgmt run etc.
        ///</summary>
        public virtual DateTime? LastSeen { get; set; }
        ///<summary>
        ///Last time the resource has been patched successfully
        ///</summary>
        public virtual DateTime? LastPatchDate { get; set; }
        ///<summary>
        ///Scheduled time for the next patching window
        ///</summary>
        public virtual DateTime? NextPatchDate { get; set; }
        ///<summary>
        ///Time of the last successfull backup
        ///</summary>
        public virtual DateTime? LastBackupDate { get; set; }
        ///<summary>
        ///True = scanned (not deployed from dune template), False = deployed from dune with template
        ///</summary>
        public virtual bool IsForeign { get; set; }
        ///<summary>
        ///Is alerting in external monitoring activated
        ///</summary>
        public virtual bool IsAlerting { get; set; }
        ///<summary>
        ///Used to identify external monitoring maintenance/downtime id
        ///</summary>
        public virtual string? AlertingDisabledId { get; set; }
        ///<summary>
        ///Reason why alerting is disabled
        ///</summary>
        public virtual string? AlertingDisabledReason { get; set; }
        ///<summary>
        ///Identifies the resource as vulnerable (security)
        ///</summary>
        public virtual bool IsVulnerable { get; set; }
        ///<summary>
        ///Reason why the resource is vulnerable
        ///</summary>
        public virtual string? VulnerabilityReason { get; set; }
        ///<summary>
        ///True if resource is in cmdb but missing on provider/infra
        ///</summary>
        public virtual bool IsMissingOnProvider { get; set; }
        ///<summary>
        ///Shows if a resource can be started/stopped
        ///</summary>
        public virtual bool SupportsStartStop { 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; }
        ///<summary>
        ///Additional generic configs
        ///</summary>
        public virtual Dictionary<string, Object> Config { get; set; } = new();
        public virtual IList<LinkDto> Links { get; set; }
    }

}

namespace CoreService.ServiceModel.Dtos.Resources.Network.Crud
{
    ///<summary>
    ///Get an ip address
    ///</summary>
    [Api(Description="Get an ip address")]
    [ApiResponse(Description="The request ended successfully", IsDefaultResponse=true, ResponseType=typeof(CoreService.ServiceModel.Dtos.Resources.Network.Responses.IpAddressDto), StatusCode=200)]
    public partial class GetIpAddress
        : IGetSingleRequest, IHasTenantName, IGet
    {
        [ApiMember(DataType="string", 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.Resources.Network.Responses
{
    public partial class IpAddressDto
        : ConfigItemDto, IHasTenantId
    {
        public virtual Guid TenantId { get; set; }
        public virtual string? ExtId { get; set; }
        public virtual Guid ResourceId { get; set; }
        public virtual ResourceDto? Resource { get; set; }
        public virtual Guid? SubnetId { get; set; }
        public virtual SubnetDto? Subnet { get; set; }
        ///<summary>
        ///Either a V4 or V6 address
        ///</summary>
        public virtual string Address { get; set; }
        ///<summary>
        ///Bits defining the subnet mask
        ///</summary>
        public virtual short? SubnetBits { get; set; }
        ///<summary>
        ///Address and subnet bits
        ///</summary>
        public virtual string Cidr { get; set; }
        public virtual bool IsPrimary { get; set; }
        public virtual IpVersion Version { get; set; }
        public virtual Guid? ResourceProviderId { get; set; }
    }

    public partial class SubnetDto
        : ConfigItemDto, IResourceDto
    {
        public virtual Guid TenantId { get; set; }
        public virtual string? ExtId { get; set; }
        public virtual string? ExtType { get; set; }
        public virtual string? ExtName { get; set; }
        ///<summary>
        ///The id of the parent (ResourceGroup)
        ///</summary>
        public virtual Guid ParentId { get; set; }
        ///<summary>
        ///The parent (ResourceGroup
        ///</summary>
        public virtual ConfigItemDto? Parent { get; set; }
        ///<summary>
        ///The id of the parent (Deployment
        ///</summary>
        public virtual Guid DeploymentId { get; set; }
        ///<summary>
        ///The parent (Deployement
        ///</summary>
        public virtual DeploymentDto? Deployment { get; set; }
        ///<summary>
        ///The id of the collection the resource belongs to
        ///</summary>
        public virtual Guid CollectionId { get; set; }
        ///<summary>
        ///The collection the resource belongs to
        ///</summary>
        public virtual DeploymentCollectionDto? Collection { get; set; }
        public virtual Environments Environment { get; set; }
        ///<summary>
        ///The id of the provider of the resource (e.g. Azure Subscription, AWS, other DC provider
        ///</summary>
        public virtual Guid ResourceProviderId { get; set; }
        ///<summary>
        ///The provider of the resource (e.g. Azure Subscription, AWS, other DC provider
        ///</summary>
        public virtual ResourceProviderDto? ResourceProvider { get; set; }
        public virtual OperationalStates State { get; set; }
        public virtual IList<VariableDto> Variables { get; set; }
        ///<summary>
        ///Can be used for dc location
        ///</summary>
        public virtual string? Location { get; set; }
        ///<summary>
        ///Last time the resource was seen/updated by a scan/cfgmgmt run etc.
        ///</summary>
        public virtual DateTime? LastSeen { get; set; }
        ///<summary>
        ///True = scanned (not deployed from dune template), False = deployed from dune with template
        ///</summary>
        public virtual bool IsForeign { get; set; }
        ///<summary>
        ///Either a V4 or V6 address (network address)
        ///</summary>
        public virtual string NetworkAddress { get; set; }
        ///<summary>
        ///Bits defining the subnet mask (together with NetworkAddress it defines the subnet range)
        ///</summary>
        public virtual short SubnetBits { get; set; }
        ///<summary>
        ///NetworkAddress and subnet bits
        ///</summary>
        public virtual string Cidr { get; set; }
        ///<summary>
        ///Either V4 or V6
        ///</summary>
        public virtual IpVersion Version { get; set; }
        ///<summary>
        ///Can hold additional generic data
        ///</summary>
        public virtual Dictionary<string, Object> Config { get; set; } = new();
        ///<summary>
        ///Is alerting in external monitoring activated
        ///</summary>
        public virtual bool IsAlerting { get; set; }
        ///<summary>
        ///Used to identify external monitoring maintenance/downtime id
        ///</summary>
        public virtual string? AlertingDisabledId { get; set; }
        ///<summary>
        ///Reason why alerting is disabled
        ///</summary>
        public virtual string? AlertingDisabledReason { get; set; }
        ///<summary>
        ///Identifies the resource as vulnerable (security)
        ///</summary>
        public virtual bool IsVulnerable { get; set; }
        ///<summary>
        ///Reason why the resource is vulnerable
        ///</summary>
        public virtual string? VulnerabilityReason { get; set; }
        ///<summary>
        ///True if resource is in cmdb but missing on provider/infra
        ///</summary>
        public virtual bool IsMissingOnProvider { get; set; }
        ///<summary>
        ///Shows if a resource can be started/stopped
        ///</summary>
        public virtual bool SupportsStartStop { get; set; }
        public virtual IList<LinkDto> Links { 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.Dtos.Tenant.Responses
{
    public partial class TenantDto
        : ConfigItemDto
    {
        ///<summary>
        ///Variables defined on tenant level
        ///</summary>
        public virtual IList<VariableDto> Variables { get; set; }
        ///<summary>
        ///Allowed email domains used for authentication
        ///</summary>
        public virtual IList<string> AllowedMailDomains { get; set; }
        ///<summary>
        ///List of licensed modules for this tenant
        ///</summary>
        public virtual IList<string> LicensedModules { get; set; }
        ///<summary>
        ///Amount of days until a Deployment expires
        ///</summary>
        public virtual short DefaultDeploymentLifetimeDays { get; set; }
        ///<summary>
        ///Max amount of days until a Deployment expires
        ///</summary>
        public virtual short MaxDeploymentLifetimeDays { get; set; }
        ///<summary>
        ///Amount of days without patching until a unpatched warning is shown
        ///</summary>
        public virtual short SystemUnpatchedWarningDays { get; set; }
        ///<summary>
        ///Amount of hours without backup until a backup missing warning is shown
        ///</summary>
        public virtual short SystemBackupMissingWarningHours { get; set; }
        ///<summary>
        ///Amount of days until a vulnerable resource is getting stopped
        ///</summary>
        public virtual short StopVulnerableResourceAfterDays { get; set; }
        ///<summary>
        ///Amount of days before deployment expiration, which triggers the expiration warning
        ///</summary>
        public virtual short DeploymentExpirationWarningDays { get; set; }
        ///<summary>
        ///Amount of days the patch notification is sent out prior to the patch date
        ///</summary>
        public virtual short PatchNotificationDays { get; set; }
        ///<summary>
        ///Use a pool with your own hostnames (true) or let the hostname be auto generated (false)
        ///</summary>
        public virtual bool UseCustomHostnames { get; set; }
        ///<summary>
        ///After how many days inactive vulnerabilities will be purged from database
        ///</summary>
        public virtual short RemoveInactiveVulnerabilitiesAfterDays { get; set; }
        public virtual IList<LinkDto> Links { get; set; }
    }

}

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

    public enum IpVersion
    {
        V4,
        V6,
    }

    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 ResourceProviderTypes
    {
        Azure,
        AmazonWebServices,
        GoogleCloudPlatform,
        ActiveDirectoryServices,
        DomainNameSystem,
        SwisscomESC,
        AzureKeyVault,
    }

    public enum ValueDataType
    {
        String,
        Number,
        Boolean,
        List,
    }

}

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# GetIpAddress 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/ipaddresses/{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","extId":"String","resourceId":"00000000-0000-0000-0000-000000000000","resource":{"extId":"String","extType":"String","extName":"String","tenantId":"00000000-0000-0000-0000-000000000000","parentId":"00000000-0000-0000-0000-000000000000","parent":{"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},"deploymentId":"00000000-0000-0000-0000-000000000000","deployment":{"operationalState":"None","resourcesRunning":0,"resourcesTotal":0,"shortId":"String","nameUserDefinedPart":"String","tenantId":"00000000-0000-0000-0000-000000000000","state":"New","environment":"Lab","templateId":"00000000-0000-0000-0000-000000000000","isTemplateBased":true,"parameters":null,"variables":null,"variablesSnapshot":null,"parentId":"00000000-0000-0000-0000-000000000000","parent":{"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},"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,"links":[{"caption":"Index","rel":"index","hRef":"/deployments/","method":"GET"},{"caption":"Collection","rel":"up","hRef":"/collections/00000000-0000-0000-0000-000000000000","method":"GET"},{"caption":"Resourcegroups","rel":"down","hRef":"/resourcegroups?parentId=00000000-0000-0000-0000-000000000000","method":"GET"}],"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"},"collectionId":"00000000-0000-0000-0000-000000000000","collection":{"tenantId":"00000000-0000-0000-0000-000000000000","tenant":{"variables":null,"allowedMailDomains":null,"licensedModules":null,"defaultDeploymentLifetimeDays":0,"maxDeploymentLifetimeDays":0,"systemUnpatchedWarningDays":0,"systemBackupMissingWarningHours":0,"stopVulnerableResourceAfterDays":0,"deploymentExpirationWarningDays":0,"patchNotificationDays":0,"useCustomHostnames":false,"removeInactiveVulnerabilitiesAfterDays":0,"links":[{"caption":"Collections","rel":"down","hRef":"/collections/","method":"GET"}],"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"},"variables":null,"isLostAndFound":false,"monthlyBudget":0,"sendBudgetNotificationMails":false,"budgetWarningThresholdPercent":0,"links":[{"caption":"Index","rel":"up","hRef":"/collections/","method":"GET"},{"caption":"Deployments","rel":"down","hRef":"/deployments?parentId=00000000-0000-0000-0000-000000000000","method":"GET"}],"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"},"environment":"Lab","resourceProviderId":"00000000-0000-0000-0000-000000000000","resourceProvider":{"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},"state":"None","variables":null,"location":"String","lastSeen":"0001-01-01T00:00:00.0000000Z","lastPatchDate":"0001-01-01T00:00:00.0000000Z","nextPatchDate":"0001-01-01T00:00:00.0000000Z","lastBackupDate":"0001-01-01T00:00:00.0000000Z","isForeign":false,"isAlerting":false,"alertingDisabledId":"String","alertingDisabledReason":"String","isVulnerable":false,"vulnerabilityReason":"String","isMissingOnProvider":false,"supportsStartStop":false,"costCurrentMonth":0,"costLastMonth":0,"costCurrency":"String","config":{"String":{}},"links":[{"caption":"Index","rel":"index","hRef":"/resources/","method":"GET"},{"caption":"ResourceGroup","rel":"up","hRef":"/resourcegroups/00000000-0000-0000-0000-000000000000","method":"GET"},{"caption":"Deployment","rel":"up","hRef":"/deployments/00000000-0000-0000-0000-000000000000","method":"GET"}],"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"},"subnetId":"00000000-0000-0000-0000-000000000000","subnet":{"tenantId":"00000000-0000-0000-0000-000000000000","extId":"String","extType":"String","extName":"String","parentId":"00000000-0000-0000-0000-000000000000","parent":{"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},"deploymentId":"00000000-0000-0000-0000-000000000000","deployment":{"operationalState":"None","resourcesRunning":0,"resourcesTotal":0,"shortId":"String","nameUserDefinedPart":"String","tenantId":"00000000-0000-0000-0000-000000000000","state":"New","environment":"Lab","templateId":"00000000-0000-0000-0000-000000000000","isTemplateBased":true,"parameters":null,"variables":null,"variablesSnapshot":null,"parentId":"00000000-0000-0000-0000-000000000000","parent":{"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},"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,"links":[{"caption":"Index","rel":"index","hRef":"/deployments/","method":"GET"},{"caption":"Collection","rel":"up","hRef":"/collections/00000000-0000-0000-0000-000000000000","method":"GET"},{"caption":"Resourcegroups","rel":"down","hRef":"/resourcegroups?parentId=00000000-0000-0000-0000-000000000000","method":"GET"}],"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"},"collectionId":"00000000-0000-0000-0000-000000000000","collection":{"tenantId":"00000000-0000-0000-0000-000000000000","tenant":{"variables":null,"allowedMailDomains":null,"licensedModules":null,"defaultDeploymentLifetimeDays":0,"maxDeploymentLifetimeDays":0,"systemUnpatchedWarningDays":0,"systemBackupMissingWarningHours":0,"stopVulnerableResourceAfterDays":0,"deploymentExpirationWarningDays":0,"patchNotificationDays":0,"useCustomHostnames":false,"removeInactiveVulnerabilitiesAfterDays":0,"links":[{"caption":"Collections","rel":"down","hRef":"/collections/","method":"GET"}],"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"},"variables":null,"isLostAndFound":false,"monthlyBudget":0,"sendBudgetNotificationMails":false,"budgetWarningThresholdPercent":0,"links":[{"caption":"Index","rel":"up","hRef":"/collections/","method":"GET"},{"caption":"Deployments","rel":"down","hRef":"/deployments?parentId=00000000-0000-0000-0000-000000000000","method":"GET"}],"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"},"environment":"Lab","resourceProviderId":"00000000-0000-0000-0000-000000000000","resourceProvider":{"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},"state":"None","variables":null,"location":"String","lastSeen":"0001-01-01T00:00:00.0000000Z","isForeign":false,"networkAddress":"String","subnetBits":0,"cidr":"String/0","version":"V4","config":{"String":{}},"isAlerting":false,"alertingDisabledId":"String","alertingDisabledReason":"String","isVulnerable":false,"vulnerabilityReason":"String","isMissingOnProvider":false,"supportsStartStop":false,"links":[{"caption":"Index","rel":"index","hRef":"/subnets/","method":"GET"},{"caption":"ResourceGroup","rel":"up","hRef":"/resourcegroups/00000000-0000-0000-0000-000000000000","method":"GET"},{"caption":"Deployment","rel":"up","hRef":"/deployments/00000000-0000-0000-0000-000000000000","method":"GET"}],"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"},"address":"String","subnetBits":0,"cidr":"String/0","isPrimary":false,"version":"V4","resourceProviderId":"00000000-0000-0000-0000-000000000000","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}