[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Patch Edge Deployment

Description

Patch an Edge deployment

Request

URL

patch

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

Copy

Path Parameters

string

id Required

Edge deployment ID

Query Parameters

string

org_id Optional

Organization ID: non-super users can only access their own organization

Request Body

EdgeDeploymentPatchTOV2 of mimetype application/json Required

updatesToDeployment

{
    "description": "My new edge deployment.",
    "name": "my-first-edge-deployment"
}

AdMonitoring

adMonitoring Optional

AgentMonitoringEdgeConfig

agentMonitoringEdgeConfig Optional

EdgeDeploymentModeDetailsPatchTO

deploymentModeDetails 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

EdgeProxyConfigurationTO

proxyConfiguration Optional

map of string

resourceTags Optional

Resource tags that are added to edge deployment

array of EdgeSsoConfiguration

ssoConfigurations Optional

Edge SSO configurations for the edge deployment.

Authentication

This operation uses the following authentication methods.

Bearer

Response

Response Body

202 Accepted

Returns EdgeDeploymentTOV2 of type */*

Successfully updated Edge Deployment

{
    "adTwinSyncStatus": "SYNCED",
    "description": "My new edge deployment",
    "fqdn": "edge.example.com",
    "id": "id",
    "location": "US",
    "name": "edge-deployment-1",
    "orgId": "orgId",
    "providerInstanceId": "providerInstanceId",
    "providerLabel": "AZURE|VSPHERE",
    "status": "PENDING"
}

AdMonitoring

adMonitoring Optional

string

adTwinSyncStatus Optional

Edge deployment synchronization status with AD twin

Possible values are: NONE , SYNCED , SYNC_NEEDED

AgentMonitoringEdgeConfig

agentMonitoringConfig Optional

AuthEngine

authEngine Optional

string as date-time

createdAt Optional

Record creation timestamp

EdgeDeploymentModeDetailsTO

deploymentModeDetails Optional

string

description Optional

The description of the Edge Deployment

EdgeGatewayLocation

edgeGatewayLocation Optional

EdgeVmDetailsV2

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

map of InfrastructureResource

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

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

EdgeProxyConfiguration

proxyConfiguration Optional

map of string

registeredModules Optional

List of modules registered with the edge deployment

EdgeReportedTO

reportedStatus Optional

map of string

resourceTags Optional

Resource tags that are added to edge deployment

array of EdgeSsoConfiguration

ssoConfigurations Optional

Edge SSO configuration

string

status Optional

The current status of the Edge Gateway deployment

Possible values are: CONNECT_PENDING , CREATE_ACCEPTED , CREATE_FAILED , CREATE_PENDING , CREATING , DELETED , DELETE_FAILED , DELETE_PENDING , DELETING , FORCE_DELETE_PENDING , FORCE_DELETING , MIGRATE_FAILED , MIGRATE_PENDING , MIGRATING , POST_PROVISIONING_CONFIG_IN_PROGRESS , READY , UPDATE_FAILED , UPDATE_PENDING , UPDATING , UPGRADE_FAILED , UPGRADE_PENDING , UPGRADING

map of string

twinSyncStatusMap Optional

Edge deployment synchronization status of edge twins

Possible values are: NONE , SYNCED , SYNC_NEEDED

string as date-time

updatedAt Optional

Record update timestamp

integer as int64

version Optional

Record version (internal)

204 No Content

No Content

Operation doesn't return any data structure.

Errors

ErrorResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

403

Forbidden

ErrorResponse

404

Not Found

ErrorResponse

409

Conflict

ErrorResponse

500

Unexpected internal server error

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"description":"My new edge deployment.","name":"my-first-edge-deployment"}' https://cloud.vmwarehorizon.com/admin/v2/edge-deployments/{id}

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-codegen-request-body-name: updatesToDeployment

[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Admin Operations

post

Create

post

Create And Upload Logs

get

Get All Edge Deployments

get

Get Device Connection String

get

Get Diagnostics Data

get

Get Edge Deployment By ID

get

Get Edge Deployment Log By ID

get

Get Edge Deployment Logs

post

Notify Edge Deployment Log Status

patch

Patch Edge Deployment

post

Save Edge Reported Attributes

delete

delete Edge Deployments

Patch Edge Deployment

Request

URL

Path Parameters

Query Parameters

Request Body

Authentication

Bearer

Response

Response Body

202 Accepted

204 No Content

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Admin Operations

Was this page helpful?