GET Cleanroom Target

Get the details of cleanroom target

Path Parameters

id int32 required
Id of the cleanroom target

Responses

Success

application/json

Schema
Example (from schema)

Schema

general object
deployCleanroomResources object
isEnabled boolean
If enabled, all supported resources will be automatically created for recovery. Otherwise, all supported resources will have to be manually created by the user and linked to target.
target object
id int32
Target id
name string
Target name
vendor string
Possible values: [NONE, AZURE_V2, AMAZON]
Target vendor
applicationType string
Possible values: [NONE, CLEAN_ROOM]
Target application type
hypervisor object
id int32
Hypervisor id
name string
Hypervisor name
displayName string
Hypervisor display name
instanceId int32
Hypervisor instance id
accessNode object
id int32
name string
displayName string
type string
Possible values: [Client, Group, Automatic]
Target application type
security object
users object[]
Users that have access to the target
id int32
name string
fullName string
userGroups object[]
User groups that have access to the target
id int32
name string
entityDisplayName object
Prefix or Suffix appended to create display name for destination instance
prefix string
A prefix string that will be appended to the source VM to create a display name for each destination VM
suffix string
A suffix string that will be appended to the source VM to create a display name for each destination VM
useOriginalName boolean
Default value: false
If true, ignore prefix and suffix and use the original VM name.
recovery object
resourceGroup object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
region object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
storageAccount object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
availabilityZone object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
storageType object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
virtualNetwork object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
vpc object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
securityGroup object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
iamRole object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
vmSize object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
instanceType object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
createPublicIPAddress boolean
volumeType string
encryptionKey object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
instanceProfile object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
securityGroups object[]
List of security groups that provide controlled access.
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
keyPair object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
infrastructure object
maxNoOfAccessNodes int32
networkSettings object
virtualNetwork object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
vpc object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
natGatewayPublicIPSettings object
createPublicIPAddress boolean
ipPrefix object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
securityGroup object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
createPublicIPAddress boolean
infrastructurePublicIPSettings object
createPublicIPAddress boolean
ipPrefix object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
securityGroups object[]
List of security groups that provide controlled access.
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
networkTopologySettings object
workloadServerGroup object
id int32
name string
type string
infrastructureServerGroup object
id int32
name string
type string
infrastructureNetworkGateway string
Optional network gateway used by infrastructure. To use, specify in the format hostname:port, else leave empty.
advancedSettings object
serverGroup object
id int32
name string
type string
resourceGroup object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
iamRole object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
vmSize object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
instanceType object
guid string
name string
type string
Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]
customImages object[]
imageGUID string
imageName string
operatingSystem string
Possible values: [UNIX, WINDOWS]
advanced object
networkAddressSpace object
virtualNetwork string
recoveredEntity string
infrastructure string
deploySecureConnection boolean
endpointSubnet string
publicSubnet string
bastion string
securityGroupRules object
recoveredEntity object[]
priority int32
isDefault boolean
name string
sourceIPRange string
sourcePortRange string
destinationIPRange string
destinationPortRange string
sourceIPRanges string[]
sourcePortRanges string[]
destinationIPRanges string[]
destinationPortRanges string[]
direction string
Possible values: [INBOUND, OUTBOUND]
Security group rule direction
access string
Possible values: [ALLOW, DENY]
Security group rule access
infrastructure object[]
priority int32
isDefault boolean
name string
sourceIPRange string
sourcePortRange string
destinationIPRange string
destinationPortRange string
sourceIPRanges string[]
sourcePortRanges string[]
destinationIPRanges string[]
destinationPortRanges string[]
direction string
Possible values: [INBOUND, OUTBOUND]
Security group rule direction
access string
Possible values: [ALLOW, DENY]
Security group rule access

{
  "general": {
    "deployCleanroomResources": {
      "isEnabled": true
    },
    "target": {
      "id": 0,
      "name": "string",
      "vendor": "NONE",
      "applicationType": "NONE"
    },
    "hypervisor": {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "instanceId": 0
    },
    "accessNode": {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "type": "Client"
    },
    "security": {
      "users": [
        {
          "id": 0,
          "name": "string",
          "fullName": "string"
        }
      ],
      "userGroups": [
        {
          "id": 0,
          "name": "string"
        }
      ]
    },
    "entityDisplayName": {
      "prefix": "string",
      "suffix": "string",
      "useOriginalName": false
    }
  },
  "recovery": {
    "resourceGroup": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "region": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "storageAccount": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "availabilityZone": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "storageType": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "virtualNetwork": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "vpc": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "securityGroup": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "iamRole": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "vmSize": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "instanceType": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "createPublicIPAddress": true,
    "volumeType": "string",
    "encryptionKey": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "instanceProfile": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "securityGroups": [
      {
        "guid": "string",
        "name": "string",
        "type": "CREATE_NEW"
      }
    ],
    "keyPair": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    }
  },
  "infrastructure": {
    "maxNoOfAccessNodes": 0,
    "networkSettings": {
      "virtualNetwork": {
        "guid": "string",
        "name": "string",
        "type": "CREATE_NEW"
      },
      "vpc": {
        "guid": "string",
        "name": "string",
        "type": "CREATE_NEW"
      },
      "natGatewayPublicIPSettings": {
        "createPublicIPAddress": true,
        "ipPrefix": {
          "guid": "string",
          "name": "string",
          "type": "CREATE_NEW"
        }
      },
      "securityGroup": {
        "guid": "string",
        "name": "string",
        "type": "CREATE_NEW"
      },
      "createPublicIPAddress": true,
      "infrastructurePublicIPSettings": {
        "createPublicIPAddress": true,
        "ipPrefix": {
          "guid": "string",
          "name": "string",
          "type": "CREATE_NEW"
        }
      },
      "securityGroups": [
        {
          "guid": "string",
          "name": "string",
          "type": "CREATE_NEW"
        }
      ]
    },
    "networkTopologySettings": {
      "workloadServerGroup": {
        "id": 0,
        "name": "string",
        "type": "string"
      },
      "infrastructureServerGroup": {
        "id": 0,
        "name": "string",
        "type": "string"
      },
      "infrastructureNetworkGateway": "string"
    },
    "advancedSettings": {
      "serverGroup": {
        "id": 0,
        "name": "string",
        "type": "string"
      },
      "resourceGroup": {
        "guid": "string",
        "name": "string",
        "type": "CREATE_NEW"
      },
      "iamRole": {
        "guid": "string",
        "name": "string",
        "type": "CREATE_NEW"
      },
      "vmSize": {
        "guid": "string",
        "name": "string",
        "type": "CREATE_NEW"
      },
      "instanceType": {
        "guid": "string",
        "name": "string",
        "type": "CREATE_NEW"
      },
      "customImages": [
        {
          "imageGUID": "string",
          "imageName": "string",
          "operatingSystem": "UNIX"
        }
      ]
    }
  },
  "advanced": {
    "networkAddressSpace": {
      "virtualNetwork": "string",
      "recoveredEntity": "string",
      "infrastructure": "string",
      "deploySecureConnection": true,
      "endpointSubnet": "string",
      "publicSubnet": "string",
      "bastion": "string"
    },
    "securityGroupRules": {
      "recoveredEntity": [
        {
          "priority": 0,
          "isDefault": true,
          "name": "string",
          "sourceIPRange": "string",
          "sourcePortRange": "string",
          "destinationIPRange": "string",
          "destinationPortRange": "string",
          "sourceIPRanges": [
            "string"
          ],
          "sourcePortRanges": [
            "string"
          ],
          "destinationIPRanges": [
            "string"
          ],
          "destinationPortRanges": [
            "string"
          ],
          "direction": "INBOUND",
          "access": "ALLOW"
        }
      ],
      "infrastructure": [
        {
          "priority": 0,
          "isDefault": true,
          "name": "string",
          "sourceIPRange": "string",
          "sourcePortRange": "string",
          "destinationIPRange": "string",
          "destinationPortRange": "string",
          "sourceIPRanges": [
            "string"
          ],
          "sourcePortRanges": [
            "string"
          ],
          "destinationIPRanges": [
            "string"
          ],
          "destinationPortRanges": [
            "string"
          ],
          "direction": "INBOUND",
          "access": "ALLOW"
        }
      ]
    }
  }
}

Failure

application/json

Schema
Example (from schema)

Schema

errorMessage string
errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

GET Cleanroom Target​

GET Cleanroom Target