Add Version
DescriptionSubmit request to add version to existing Image.
Currently this is allowed only for an Image having source type AZURE_SIG or AZURE_CUSTOM_VM.
1. Source AZURE_SIG : Copy published Image from Azure SIG and add it as MAJOR / MINOR version to the existing image. Ensure Azure RBAC Access is granted on source Image for target provider instance. In case source image is prepared by the Partner org using Image Management APIs, provide ‘mspOrgId’ in assetDetails to copy source image metadata and application scan data. In case of externally prepared Image, make sure to provide appropriate attributes in assetDetails including ‘isClientAccessLicenseApplicable’ and ‘multiSession’ apart from mandatory attributes. Refer notes on request model for more details. Once Image status is AVAILABLE, it can be used to create templates.
2. Source AZURE_CUSTOM_VM : Import Custom VM (Customer created VM) from Azure and add it as MAJOR / MINOR version to the existing image. Once Image status is IMPORT_COMPLETE, it can be customized and published as a new version. Refer notes on request model for more details.
This operation will occur in background.
Request
URLURL
Path Parameters
Path Parameters
imageId
Request Body
{
"gpuType": "NONE, AMD, NVIDIA",
"osType": "WINDOWS, LINUX",
"providerLabel": "AZURE,AKKA,VSPHERE",
"sourceType": "AZURE_SIG / AZURE_CUSTOM_VM",
"versionType": "MAJOR, MINOR"
}
Description of new Version.
Indicates if the new version is of GPU or a non-GPU type. It must match the GPU type of Image.
Possible values are: AMD , NONE , NVIDIA
Org Id
Display name of the OS from image-sources api
OS type of the image. It must match the OS Type of Image.
Possible values are: CLIENT , LINUX , SERVER , WINDOWS , WVD
Provider instance id that gives provider specific region details
ProviderType for this VM
Possible values are: AKKA , AZURE , VSPHERE , ZEROCLOUD
Source type of new Version.
Possible values are: AKKA_CUSTOM_VM , AKKA_MARKET_PLACE , AKKA_SIG , AZURE_CUSTOM_VM , AZURE_MARKET_PLACE , AZURE_SIG , COPIED_FROM_VERSION , IMPORTED_VMS , UPLOADED , VSPHERE_CATALOG
Source Version used for creating new version. Its needed when versionType is MINOR
Version Type of new Version. Only Major and Minor are supported currently. Version type and version number of source decides the new version number.
Possible values are: MAJOR , MINOR , PATCH
Authentication
Response
Response BodyResponse Body
201 Created
Successfully created a new version record.Provisioning of resources in provider will happen in background.
{
"assetDetails": {
"assetType": "AKKA_IMAGE_IN_RG",
"data": {}
},
"assetId": "string",
"assetStatus": "AGENT_INSTALLATION_FAILED",
"assetType": "AKKA_IMAGE_IN_RG",
"imageDescription": "string",
"imageId": "string",
"imageName": "string",
"imageStatus": "AVAILABLE",
"markers": [
{
"createdAt": "string",
"errorCode": "UPDATES_FAILED",
"errorDetails": "string",
"errorDetailsParameters": {
"key": "string"
},
"id": "0123456789",
"imageId": "0123456789",
"name": "HRLite,HRPro",
"nextVersionId": "0123456789",
"orgId": "0123456789",
"status": "IN_PROGRESS",
"templateCount": 0,
"updatedAt": "string",
"versionId": "0123456789"
}
],
"orgId": "string",
"sourceAssetId": "string",
"sourceImageId": "string",
"sourceImageType": "AKKA_CUSTOM_VM",
"sourceType": "AKKA_CUSTOM_VM",
"sourceVersionId": "string",
"versionDescription": "string",
"versionHistory": [
"string"
],
"versionId": "string",
"versionName": "string",
"versionStatus": "AVAILABLE",
"versionType": "MAJOR"
}
Possible values are: AGENT_INSTALLATION_FAILED , ALLOW_RDP_FAILED , AVAILABLE , CAPTURE_AND_IMAGE_UPLOAD_FAILED , CAPTURING_AND_UPLOADING_IMAGE_TO_SIG , CLONE_FAILED , COPYING_IMAGE , DELETING , DELETION_FAILED , DELETION_RETRY_PENDING , DEPLOYING_VM , DISABLED , ENABLING_RDS_AND_ALLOW_RDP_FAILED , GENERALIZING , GENERALIZING_FAILED , IMPORT_COMPLETE , IMPORT_FAILED , IMPORT_FAILED_TIMEOUT , IMPORT_PENDING , IMPORT_RETRY_PENDING , INSTALLING_AGENTS , PUBLISH_BACKUP_FAILED , PUBLISH_BACKUP_IN_PROGRESS , PUBLISH_CLEANUP_FAILED , PUBLISH_CLEANUP_IN_PROGRESS , PUBLISH_COMPLETE , PUBLISH_FAILED , PUBLISH_IN_PROGRESS , PUBLISH_RETRY_PENDING , REPLICATING , REPLICATION_COMPLETE , REPLICATION_FAILED , REPLICATION_FAILED_TIMEOUT , RESTARTING_VM , SCANNING_APPS , SHUTTING_DOWN_VM , SYSPREPING , SYSPREP_FAILED , VALIDATION_FAILED , VALIDATION_IN_PROGRESS
Possible values are: AKKA_IMAGE_IN_RG , AKKA_VM_IN_RG , AZURE_IMAGE_IN_RG , AZURE_IMAGE_IN_SIG , AZURE_IMAGE_REPLICA_IN_SIG , AZURE_VM_IN_RG , VSPHERE_MASTER_VM
Possible values are: AVAILABLE , DELETING , DISABLED , FAILED , IMPORT_COMPLETE , IN_PROGRESS , PARTIALLY_AVAILABLE , PENDING
Possible values are: AKKA_CUSTOM_VM , AKKA_MARKET_PLACE , AKKA_SIG , AZURE_CUSTOM_VM , AZURE_MARKET_PLACE , AZURE_SIG , COPIED_FROM_VERSION , IMPORTED_VMS , UPLOADED , VSPHERE_CATALOG
Possible values are: AKKA_CUSTOM_VM , AKKA_MARKET_PLACE , AKKA_SIG , AZURE_CUSTOM_VM , AZURE_MARKET_PLACE , AZURE_SIG , COPIED_FROM_VERSION , IMPORTED_VMS , UPLOADED , VSPHERE_CATALOG
Possible values are: AVAILABLE , DELETING , DISABLED , FAILED , FAILED_UNRECOVERABLE , IMPORT_COMPLETE , IMPORT_IN_PROGRESS , PARTIALLY_AVAILABLE , PENDING , PUBLISH_IN_PROGRESS , REPLICATION_IN_PROGRESS , VALIDATION_FAILED , VALIDATION_IN_PROGRESS
Possible values are: MAJOR , MINOR , PATCH
Errors
Bad request
Unauthorized
Forbidden
Source Image or Version is not found for given imageId and versionId
Conflict
Failed to submit add version request
Code Samples
cURL Command
Vendor Extensions
x-codegen-request-body-name: versionCreateTO
