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

Patch Edge Deployment

Description

Patch an Edge deployment

Request

Request

URL

URL


patch
https://cloud.vmwarehorizon.com/admin/v2/edge-deployments/{id}
Copy

Path Parameters

Path Parameters

string
id Required

Edge deployment ID


Query Parameters

Query Parameters

string
org_id Optional

Filter by orgId: non-super users can only query for their own orgIds


Request Body

Request Body

EdgeDeploymentPatchTOV2 of mimetype application/json Required

updatesToDeployment

{
	"agentMonitoringEdgeConfig": {
		"dataToCollect": [
			"string"
		],
		"interval": 0
	},
	"description": "My new edge deployment.",
	"enablePrivateEndpoint": false,
	"name": "my-first-edge-deployment",
	"proxyConfiguration": {
		"enabled": false,
		"exclusionPolicy": [
			"string"
		],
		"password": "string",
		"proxyHost": "string",
		"proxyName": "string",
		"proxyPort": 0,
		"proxyType": "HTTP",
		"sslEnabled": false,
		"username": "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
			}
		}
	]
}
agentMonitoringEdgeConfig Optional

string
description Optional

The name of the Edge Deployment


boolean
enablePrivateEndpoint Optional

Use Private Link Service and enable private endpoint


string
name Optional

The name of the Edge Deployment


proxyConfiguration Optional

map of string
resourceTags Optional

Resource tags that are added to edge deployment


ssoConfigurations Optional

Edge SSO configurations for the edge deployment.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted returns EdgeDeploymentTOV2 of type */*
{
	"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
}
string
adTwinSyncStatus Optional

Edge deployment synchronization status with AD twin

Possible values are: NONESYNCEDSYNC_NEEDED


agentMonitoringConfig Optional

authEngine Optional

string as date-time
createdAt Optional

Record creation timestamp


string
description Optional

The description of the Edge Deployment


edgeGatewayLocation Optional

edgeVmDetails Optional

array of ErrorDetail
errorDetails Optional

Error details in case of Edge VM operation failure


string
fqdn Optional

FQDN with which to resolve the Edge VM management IP


HDC
hdc Optional

string
id Optional

The id of the Edge Deployment


infrastructure Optional

Infrastructure Resources needed by the Edge Deployment such as managementNetwork


string
location Optional

location


string
name Optional

The name of the Edge Deployment


string
orgId Optional

The id of the CSP org


privateEndpointDetails Optional

string
providerInstanceId Optional

The ProviderInstance where the Edge Deployment is deployed


string
providerLabel Optional

The type of the provider edge deployment belongs to


proxyConfiguration Optional

map of string
registeredModules Optional

List of modules registered with the edge deployment


map of string
resourceTags Optional

Resource tags that are added to edge deployment


ssoConfigurations Optional

Edge SSO configuration


string
status Optional

The current status of the Edge Gateway deployment

Possible values are: CONNECT_PENDINGCREATE_ACCEPTEDCREATE_FAILEDCREATE_PENDINGCREATINGDELETEDDELETE_FAILEDDELETE_PENDINGDELETINGFORCE_DELETE_PENDINGFORCE_DELETINGREADYUPDATE_FAILEDUPDATE_PENDINGUPDATING


map of string
twinSyncStatusMap Optional

Edge deployment synchronization status of edge twins

Possible values are: NONESYNCEDSYNC_NEEDED


string as date-time
updatedAt Optional

Record update timestamp


integer as int64
version Optional

Record version (internal)

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


409

Conflict


500

Unexpected internal server error

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"agentMonitoringEdgeConfig":{"dataToCollect":["string"],"interval":0},"description":"My new edge deployment.","enablePrivateEndpoint":false,"name":"my-first-edge-deployment","proxyConfiguration":{"enabled":false,"exclusionPolicy":["string"],"password":"string","proxyHost":"string","proxyName":"string","proxyPort":0,"proxyType":"HTTP","sslEnabled":false,"username":"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}}]}' https://cloud.vmwarehorizon.com/admin/v2/edge-deployments/{id}
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?