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

Upgrade Edge Deployment

Description

Upgrade edge deployment cluster kubernetes version

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
id Required

Edge deployment ID


Query Parameters

Query Parameters

string
org_id Optional

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


Request Body

Request Body

EdgeDeploymentUpgradeTO of mimetype application/json Required

upgrade

{
    "desiredKubernetesVersion": "1.22.6"
}
string
desiredKubernetesVersion Optional

Cluster desired kubernetes version

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK Response Body>

Response Body

200 OK

Returns EdgeDeploymentTOV2 of type */*
{
    "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 Optional

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


deploymentModeDetails Optional

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


reportedStatus Optional

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_DELETINGMIGRATE_FAILEDMIGRATE_PENDINGMIGRATINGPOST_PROVISIONING_CONFIG_IN_PROGRESSREADYUPDATE_FAILEDUPDATE_PENDINGUPDATINGUPGRADE_FAILEDUPGRADE_PENDINGUPGRADING


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)


201 Created

Created


202 Accepted Response Body>

Response Body

202 Accepted

Returns EdgeDeploymentTOV2 of type */*

Successfully accepted edge deployment upgrade request

{
    "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 Optional

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


deploymentModeDetails Optional

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


reportedStatus Optional

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_DELETINGMIGRATE_FAILEDMIGRATE_PENDINGMIGRATINGPOST_PROVISIONING_CONFIG_IN_PROGRESSREADYUPDATE_FAILEDUPDATE_PENDINGUPDATINGUPGRADE_FAILEDUPGRADE_PENDINGUPGRADING


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

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

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"desiredKubernetesVersion":"1.22.6"}' https://cloud.vmwarehorizon.com/admin/v2/edge-deployments/{id}/upgrade
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?