[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Create Image Catalog

Description

Submit create image catalog request. This operation will occur in background.

Supported Source types & actions values:

1. Source AZURE_MARKET_PLACE, action=import (default): Import VM from Azure marketplace. Once Image status is IMPORT_COMPLETE, it can be customized and published.

2. Source AZURE_SIG, action=copy-existing-image: Copy published Image from Azure SIG. 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.

3. Source AZURE_CUSTOM_VM, action=import-custom-vm: Import Custom VM (Customer created VM) from Azure. Once Image status is IMPORT_COMPLETE, it can be customized and published. Refer notes on request model for more details.

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/imagemgmt/v1/images
Copy

Query Parameters

Query Parameters

string
action Optional

action


Request Body

Request Body

ImageCatalogRequest of mimetype application/json Required

imageCatalogRequest

{
    "gpuType": "NONE, AMD, NVIDIA",
    "osType": "WINDOWS, LINUX",
    "providerLabel": "AZURE,AKKA,VSPHERE",
    "sourceStreamType": "AZURE_MARKET_PLACE / AZURE_SIG",
    "streamDescription": "Example Description",
    "streamName": "ExampleImage",
    "versionDescription": "This is a test version",
    "versionSource": "0.0",
    "versionType": "MAJOR, MINOR, PATCH"
}
assetDetails Optional

string
gpuType Optional

Indicates if the image is of GPU or a non-GPU type

Possible values are: AMDNONENVIDIA


array of MarkerTO
markers Optional

Markers to be added to the Version.


string
orgId Optional

Org Id with which this image would be associated.


string
os Optional

Display name of the OS from image-sources api


string
osType Optional

OS type of the image

Possible values are: CLIENTLINUXSERVERWINDOWSWVD


string
providerInstanceId Optional

Provider instance id that gives provider specific region details


string
providerLabel Optional

ProviderType for this VM

Possible values are: AKKAAZUREVSPHEREZEROCLOUD


string
sourceStreamType Optional

Source for the VM

Possible values are: AKKA_CUSTOM_VMAKKA_MARKET_PLACEAKKA_SIGAZURE_CUSTOM_VMAZURE_MARKET_PLACEAZURE_SIGCOPIED_FROM_VERSIONIMPORTED_VMSUPLOADEDVSPHERE_CATALOG


string
streamDescription Optional

Image Description


string
streamName Optional

Image Name


string
versionDescription Optional

Description of the version


string
versionSource Optional

Version Source is mandatory - this should be set to 0.0 if you want version to start from 1.0.0


string
versionType Optional

Version Type is mandatory - This along with version source decides the version name

Possible values are: MAJORMINORPATCH

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns ImageCatalogRepresentation of type application/json

Successfully accepted create Image catalog request.

{
	"assetDetails": {
		"assetType": "AKKA_IMAGE_IN_RG",
		"data": {}
	},
	"assetId": "string",
	"assetStatus": "AGENT_INSTALLATION_FAILED",
	"assetType": "AKKA_IMAGE_IN_RG",
	"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",
	"os": "string",
	"sourceAssetId": "string",
	"sourceStreamId": "string",
	"sourceStreamType": "AKKA_CUSTOM_VM",
	"sourceVersionId": "string",
	"streamDescription": "string",
	"streamId": "string",
	"streamName": "string",
	"streamStatus": "AVAILABLE",
	"versionDescription": "string",
	"versionHistory": [
		"string"
	],
	"versionId": "string",
	"versionName": "string",
	"versionSource": "string",
	"versionStatus": "AVAILABLE",
	"versionType": "MAJOR"
}
assetDetails Optional

string
assetId Optional

string
assetStatus Optional

Possible values are: AGENT_INSTALLATION_FAILEDALLOW_RDP_FAILEDAVAILABLECAPTURE_AND_IMAGE_UPLOAD_FAILEDCAPTURING_AND_UPLOADING_IMAGE_TO_SIGCLONE_FAILEDCOPYING_IMAGEDELETINGDELETION_FAILEDDELETION_RETRY_PENDINGDEPLOYING_VMDISABLEDENABLING_RDS_AND_ALLOW_RDP_FAILEDGENERALIZINGGENERALIZING_FAILEDIMPORT_COMPLETEIMPORT_FAILEDIMPORT_FAILED_TIMEOUTIMPORT_PENDINGIMPORT_RETRY_PENDINGINSTALLING_AGENTSPUBLISH_BACKUP_FAILEDPUBLISH_BACKUP_IN_PROGRESSPUBLISH_CLEANUP_FAILEDPUBLISH_CLEANUP_IN_PROGRESSPUBLISH_COMPLETEPUBLISH_FAILEDPUBLISH_IN_PROGRESSPUBLISH_RETRY_PENDINGREPLICATINGREPLICATION_COMPLETEREPLICATION_FAILEDREPLICATION_FAILED_TIMEOUTRESTARTING_VMSCANNING_APPSSHUTTING_DOWN_VMSYSPREPINGSYSPREP_FAILEDVALIDATION_FAILEDVALIDATION_IN_PROGRESS


string
assetType Optional

Possible values are: AKKA_IMAGE_IN_RGAKKA_VM_IN_RGAZURE_IMAGE_IN_RGAZURE_IMAGE_IN_SIGAZURE_IMAGE_REPLICA_IN_SIGAZURE_VM_IN_RGVSPHERE_MASTER_VM


array of MarkerTO
markers Optional

string
orgId Optional

string
os Optional

string
sourceAssetId Optional

string
sourceStreamId Optional

string
sourceStreamType Optional

Possible values are: AKKA_CUSTOM_VMAKKA_MARKET_PLACEAKKA_SIGAZURE_CUSTOM_VMAZURE_MARKET_PLACEAZURE_SIGCOPIED_FROM_VERSIONIMPORTED_VMSUPLOADEDVSPHERE_CATALOG


string
sourceVersionId Optional

string
streamDescription Optional

string
streamId Optional

string
streamName Optional

string
streamStatus Optional

Possible values are: AVAILABLEDELETINGDISABLEDFAILEDIMPORT_COMPLETEIN_PROGRESSPARTIALLY_AVAILABLEPENDING


string
versionDescription Optional

array of string
versionHistory Optional

string
versionId Optional

string
versionName Optional

string
versionSource Optional

string
versionStatus Optional

Possible values are: AVAILABLEDELETINGDISABLEDFAILEDFAILED_UNRECOVERABLEIMPORT_COMPLETEIMPORT_IN_PROGRESSPARTIALLY_AVAILABLEPENDINGPUBLISH_IN_PROGRESSREPLICATION_IN_PROGRESSVALIDATION_FAILEDVALIDATION_IN_PROGRESS


string
versionType Optional

Possible values are: MAJORMINORPATCH

Errors

Errors

400

Bad request


401

Unauthorized


403

Forbidden


409

Conflict


500

Failed to create Image catalog request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"gpuType":"NONE, AMD, NVIDIA","osType":"WINDOWS, LINUX","providerLabel":"AZURE,AKKA,VSPHERE","sourceStreamType":"AZURE_MARKET_PLACE / AZURE_SIG","streamDescription":"Example Description","streamName":"ExampleImage","versionDescription":"This is a test version","versionSource":"0.0","versionType":"MAJOR, MINOR, PATCH"}' https://cloud.vmwarehorizon.com/imagemgmt/v1/images
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: imageCatalogRequest


[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Feedback

Was this page helpful?