Patch Version
DescriptionSubmit Version update request. Supports updating description and markers of Version.
Marker update will trigger pool updates if the request is accepted and moved existing marker to this version.
Pool updates happen asynchronously and can be tracked via marker status.
Request
URLURL
Path Parameters
Path Parameters
imageId
versionId
Query Parameters
Query Parameters
Org Id of the Version to be updated.
Request Body
{
"description": "string",
"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"
}
]
}
Description to be updated for the Version
Authentication
Response
Response BodyResponse Body
202 Accepted
Successfully accepted Version update request
{
"id": "0123456789",
"lastTriggeredAction": "IMPORT",
"orgId": "0123456789",
"sourceType": "AZURE_MARKET_PLACE",
"state": "PUBLISHED",
"status": "AVAILABLE",
"streamId": "0123456789",
"versionHistory": [
"1.0.0",
"2.0.0"
],
"versionType": "MAJOR"
}
Timestamp of record creation
Description of this version of the image
Unique record ID
Indicates the last action performed on the version
Possible values are: CLONE , DELETE , IMPORT , PUBLISH , UNPUBLISH
Version name
Org ID that owns this record
OS name for this version. If this value is null at version level, value from Image can be referred.
Indicates source type of the 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
Indicates the specific version in the current stream that was used to create this version if any
Indicates state of the version
Possible values are: NOT_READY , PARTIALLY_PUBLISHED , PUBLISHED , UNPUBLISHED
Indicates the status of the version based on its stage in import or publish workflow
Possible values are: AVAILABLE , DELETING , DISABLED , FAILED , IMPORT_COMPLETE , IMPORT_IN_PROGRESS , PARTIALLY_AVAILABLE , PENDING , PUBLISH_IN_PROGRESS , REPLICATION_IN_PROGRESS
Stream id that this version belong to.
Timestamp of last record modification
Record version (internal)
Indicates lineage of all versions preceding this version
Indicates version type
Possible values are: MAJOR , MINOR , PATCH
Errors
Bad request
Unauthorized
Forbidden
Not Found
Conflict
Failed to validate or submit Version update request
Code Samples
cURL Command
Vendor Extensions
x-codegen-request-body-name: versionPatchTO
