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

Bulk Delete

Description

bulkDelete

Request

Request

URL

URL


delete
https://cloud.vmwarehorizon.com/admin/v2/templates
Copy

Query Parameters

Query Parameters

boolean
force Optional

If true, template is deleted despite potential clean-up errors


Request Body

Request Body

TemplateQueryTO of mimetype */* Required

templateQuery

{
	"orgId": "string"
}
string
orgId Required

orgId of templates to query


array of string
ids Optional

list of template ids to query from

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns TemplateBulkResponseTO of type */*
{
	"errors": {
		"key": {
			"cause": "ErrorDetail Object",
			"code": "string",
			"detail": "string",
			"domain": "string",
			"message": "string",
			"parameters": {
				"key": "string"
			}
		}
	},
	"results": {
		"key": {
			"activeDirectoryId": "string",
			"agentCustomization": {
				"demSettingId": "string",
				"disconnectSessionTimeoutMins": 0,
				"dtemplateName": "string",
				"emptySessionLogoffType": "DISCONNECT",
				"emptySessionTimeoutMins": 0,
				"esUrl": "string",
				"proxyInfo": {
					"bypass": "10.12.100.10;10.120.100.10;100.12.*.100",
					"server": "http://<<ipaddress or cname>>:<<port>>"
				},
				"runOnceCommand": "string",
				"sessionLoadBalancingSettings": {
					"LBCHANGETHRESHOLD": 1,
					"LBCPUTHRESHOLD": 50,
					"LBDISKQUEUELENTHRESHOLD": 50,
					"LBDISKREADLATENCYTHRESHOLD": 50,
					"LBDISKWRITELATENCYTHRESHOLD": 50,
					"LBINCLUDESESSIONCOUNT": true,
					"LBMEMTHRESHOLD": 50,
					"LBUSECUSTOMSCRIPT": false,
					"loadIndexThresholdPercent": 0,
					"modelVersion": 0
				},
				"sessionsPerVm": 1,
				"skipDomainJoin": false
			},
			"applicationProperties": {
				"key": "string"
			},
			"clientAccessLicenseApplicable": false,
			"computerAccountOU": "string",
			"createdAt": "string",
			"deleting": false,
			"description": "My floating desktop template",
			"desktopAdminCredentialId": "string",
			"desktopAdminUsername": "string",
			"diskEncryption": {
				"enabled": false,
				"modelVersion": 0
			},
			"edgeDeployment": {
				"adTwinSyncStatus": "SYNCED",
				"agentMonitoringConfig": {
					"dataToCollect": [
						"string"
					],
					"interval": 0
				},
				"authEngine": {
					"status": {
						"errorDetails": [
							{
								"cause": "ErrorDetail Object",
								"code": "string",
								"detail": "string",
								"domain": "string",
								"message": "string",
								"parameters": {
									"key": "string"
								}
							}
						],
						"message": "string",
						"status": 0
					},
					"url": "string"
				},
				"createdAt": "string",
				"description": "My new edge deployment",
				"edgeGatewayLocation": {
					"deviceId": "string",
					"iotDeviceName": "string"
				},
				"edgeVmDetails": {
					"credentialId": "string",
					"managementIp": "string"
				},
				"errorDetails": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						}
					}
				],
				"fqdn": "edge.example.com",
				"hdc": {
					"edgeHubUrl": "string",
					"id": "string",
					"modelVersion": 0,
					"name": "string",
					"url": "string",
					"vmHub": {
						"name": "string",
						"url": "string"
					},
					"vmHubName": "string",
					"vmHubURL": "string"
				},
				"id": "id",
				"infrastructure": {
					"key": {
						"data": {},
						"id": "string",
						"infrastructureLinks": {},
						"kind": "string"
					}
				},
				"location": "US",
				"name": "edge-deployment-1",
				"orgId": "orgId",
				"privateEndpointDetails": {
					"dnsRecord": "string",
					"ip": "string",
					"name": "string",
					"nicResourceId": "string",
					"privateLinkServiceId": "string",
					"provisioningState": "string"
				},
				"providerInstanceId": "providerInstanceId",
				"providerLabel": "AZURE|VSPHERE",
				"proxyConfiguration": {
					"credentialId": "string",
					"deleting": false,
					"enabled": false,
					"exclusionPolicy": [
						"string"
					],
					"proxyHost": "string",
					"proxyName": "string",
					"proxyPort": "string",
					"proxyType": "HTTP",
					"sslEnabled": false
				},
				"registeredModules": {
					"key": "string"
				},
				"resourceTags": {
					"key": "string"
				},
				"ssoConfigurations": [
					{
						"caMode": "sub",
						"name": "my-sso",
						"ssoConfigurationId": "sso-id-1",
						"status": {
							"adDomainsStatus": [
								{
									"adId": "string",
									"message": "string",
									"status": 0
								}
							],
							"caBundlesStatus": [
								{
									"caCertVersion": 0,
									"installed": false
								}
							],
							"message": "string",
							"status": 0
						}
					}
				],
				"status": "PENDING",
				"twinSyncStatusMap": {
					"key": "NONE"
				},
				"updatedAt": "string",
				"version": 0
			},
			"edgeDeploymentId": "string",
			"hdc": {
				"edgeHubUrl": "string",
				"id": "string",
				"modelVersion": 0,
				"name": "string",
				"url": "string",
				"vmHub": {
					"name": "string",
					"url": "string"
				},
				"vmHubName": "string",
				"vmHubURL": "string"
			},
			"id": "string",
			"imageId": "string",
			"imageReference": {
				"modelVersion": 0,
				"streamId": "string",
				"versionId": "string"
			},
			"infrastructure": {
				"key": {
					"data": {},
					"id": "string",
					"infrastructureLinks": {},
					"kind": "string"
				}
			},
			"licenseProvided": false,
			"location": "US",
			"maxQuiescingServers": 10,
			"name": "My floating desktop template",
			"networks": [
				{
					"data": {},
					"id": "string",
					"infrastructureLinks": {},
					"kind": "string"
				}
			],
			"orgId": "string",
			"parentId": "string",
			"powerPolicy": {
				"enabled": false,
				"min": 2,
				"minUnit": "PERCENTAGE",
				"modelVersion": 0,
				"occupancyPresetMode": "BALANCED",
				"powerOffProtectTimeMins": 30,
				"powerSchedules": [
					{
						"allDay": false,
						"endTime": "17:00",
						"min": 5,
						"modelVersion": 0,
						"name": "VmwareWeekdaySchedule",
						"occursOn": 31,
						"startTime": "08:00",
						"timeZone": "Asia/Tokyo"
					}
				]
			},
			"protocols": [
				"BLAST"
			],
			"providerInstance": {
				"createdAt": "string",
				"credentialId": "0123456789",
				"denyOperations": [
					"EDGE_DEPLOYMENT"
				],
				"edgeDeploymentId": "0123456789",
				"hdc": {
					"edgeHubUrl": "string",
					"id": "string",
					"modelVersion": 0,
					"name": "string",
					"url": "string",
					"vmHub": {
						"name": "string",
						"url": "string"
					},
					"vmHubName": "string",
					"vmHubURL": "string"
				},
				"healthStatusDetails": {
					"errorDetails": [
						{
							"cause": "ErrorDetail Object",
							"code": "string",
							"detail": "string",
							"domain": "string",
							"message": "string",
							"parameters": {
								"key": "string"
							}
						}
					],
					"providerInstanceHealthStatus": "OK|ERROR|WARNING",
					"updatedAt": "string",
					"version": 0
				},
				"id": "0123456789",
				"infraTwinId": "0123456789",
				"infraTwinSyncStatus": "READY",
				"infrastructureLinks": {
					"key": "string"
				},
				"location": "US",
				"name": "My Instance Name",
				"orgId": "0123456789",
				"primaryProvider": false,
				"providerDetails": {
					"data": {
						"key": "string"
					},
					"method": "ByAppRegistration"
				},
				"providerLabel": "AZURE",
				"resourceTags": {
					"key": "string"
				},
				"updatedAt": "string",
				"version": 0
			},
			"providerInstanceId": "string",
			"reportedStatus": {
				"connectivityStatus": "OFFLINE",
				"consumedVMs": 0,
				"deletingVMs": 0,
				"errorVMs": 0,
				"freeSessions": 0,
				"location": "string",
				"maintenanceVMs": 0,
				"messages": [
					{
						"code": "string",
						"message": "string",
						"time": "string"
					}
				],
				"orgId": "string",
				"provisionedSessions": 0,
				"provisionedVMs": 0,
				"provisioningVMs": 0,
				"status": "string",
				"templateId": "string",
				"updatedAt": "string",
				"version": 0
			},
			"resourceTags": {
				"key": "string"
			},
			"sessionsPerVm": 0,
			"sparePolicy": {
				"increment": 200,
				"limit": 10,
				"max": 4,
				"min": 2,
				"modelVersion": 0
			},
			"syncStatus": "SYNC_COMPLETE",
			"templateConnectivityStatus": "OFFLINE",
			"templateType": "DEDICATED",
			"uagDeployment": {
				"createdAt": "string",
				"description": "string",
				"errorDetails": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						}
					}
				],
				"fqdn": "www.example.com",
				"gateways": [
					{
						"desktopPrivateIp": "string",
						"dmzPrivateIp": "string",
						"errorDetails": [
							{
								"cause": "ErrorDetail Object",
								"code": "string",
								"detail": "string",
								"domain": "string",
								"message": "string",
								"parameters": {
									"key": "string"
								}
							}
						],
						"id": "string",
						"managementPrivateIp": "string",
						"markedForDeletion": false,
						"status": "DELETED",
						"version": "string",
						"vmName": "string"
					}
				],
				"hdc": {
					"edgeHubUrl": "string",
					"id": "string",
					"modelVersion": 0,
					"name": "string",
					"url": "string",
					"vmHub": {
						"name": "string",
						"url": "string"
					},
					"vmHubName": "string",
					"vmHubURL": "string"
				},
				"id": "string",
				"infrastructure": {
					"key": {
						"data": {},
						"id": "string",
						"infrastructureLinks": {},
						"kind": "string"
					}
				},
				"loadBalancer": {
					"fqdn": "string",
					"ipAddress": "string",
					"publicIpEnabled": false
				},
				"location": "US",
				"name": "My Instance Name",
				"numberOfGateways": 2,
				"orgId": "0123456789",
				"passwordCredentialId": "string",
				"privateLoadBalancer": {
					"fqdn": "string",
					"ipAddress": "string",
					"publicIpEnabled": false
				},
				"providerInstanceId": "0123456789",
				"providerLabel": "AZURE",
				"proxyConfiguration": {
					"certificateData": "string",
					"certificateName": "string",
					"deleting": false,
					"enabled": false,
					"proxyHost": "string",
					"proxyIncludedHosts": [
						"string"
					],
					"proxyName": "string",
					"proxyPort": 0,
					"proxyType": "HTTP"
				},
				"reportedProperties": {
					"location": "string",
					"orgId": "string",
					"reportedGatewayDetails": [
						{
							"certUpdateErrorDetails": [
								{
									"cause": "ErrorDetail Object",
									"code": "string",
									"detail": "string",
									"domain": "string",
									"message": "string",
									"parameters": {
										"key": "string"
									}
								}
							],
							"certUpdateStatus": "DELETED",
							"fqdnUpdateErrorDetails": [
								{
									"cause": "ErrorDetail Object",
									"code": "string",
									"detail": "string",
									"domain": "string",
									"message": "string",
									"parameters": {
										"key": "string"
									}
								}
							],
							"fqdnUpdateStatus": "DELETED",
							"gatewayHealthErrorDetails": [
								{
									"cause": "ErrorDetail Object",
									"code": "string",
									"detail": "string",
									"domain": "string",
									"message": "string",
									"parameters": {
										"key": "string"
									}
								}
							],
							"gatewayHealthStatus": "ERROR",
							"gatewayId": "string",
							"proxyUpdateErrorDetails": [
								{
									"cause": "ErrorDetail Object",
									"code": "string",
									"detail": "string",
									"domain": "string",
									"message": "string",
									"parameters": {
										"key": "string"
									}
								}
							],
							"proxyUpdateStatus": "DELETED"
						}
					],
					"uagDeploymentId": "string",
					"updatedAt": "string",
					"version": 0
				},
				"resourceTags": {
					"key": "string"
				},
				"sslCertificateCredentialId": "string",
				"sslCertificateTO": {
					"credentialId": "string",
					"expiryDate": "string",
					"sslCertificateType": "PEM"
				},
				"status": "PENDING",
				"type": "EXTERNAL | INTERNAL_AND_EXTERNAL",
				"updatedAt": "string",
				"version": 0
			},
			"uagDeploymentId": "string",
			"updatedAt": "string",
			"vmLicenseType": "NONE",
			"vmNamePattern": "string"
		}
	}
}
map of ErrorDetail
errors Optional

map of TemplateTOV2
results Optional

Searchable fields are “id”,“activeDirectoryId”,“diskEncryption.enabled”,“edgeDeploymentId”,“imageReference.streamId”,“imageReference.versionId”,“name”,“parentId”,“protocols”,“providerInstanceId”,“templateType”,“uagDeploymentId”

Errors

Errors

400

Bad request


401

Unauthorized


403

Forbidden

Code Samples

Code Samples

cURL Command

curl -X DELETE -H "Content-Type: */*" -d '{"ids":["string"],"orgId":"string"}' https://cloud.vmwarehorizon.com/admin/v2/templates
Vendor Extensions

Vendor Extensions

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


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

Was this page helpful?