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

Patch Uag Deployment

Description

Patches an existing UAG deployment record with new values.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
id Required

UAG Deployment ID


Query Parameters

Query Parameters

boolean
ignore_warnings Optional

If true, errors classified as warnings will be ignored


string
org_id Optional

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


Request Body

Request Body

UAGDeploymentPatchTOV2 of mimetype application/json Required

uagDeploymentPatchToV2

{
    "fqdn": "uag.example.com",
    "numberOfGateways": 2
}
string
fqdn Optional

Admin-defined FQDN of the UAG cluster


integer as int32
numberOfGateways Optional

Number of Gateways needed in the UAG deployment cluster


proxyConfiguration Optional

sslCertificate Optional
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK Response Body>

Response Body

200 OK

Returns UAGDeploymentTOV2 of type */*
{
    "fqdn": "www.example.com",
    "location": "US",
    "name": "My Instance Name",
    "numberOfGateways": 2,
    "orgId": "0123456789",
    "providerInstanceId": "0123456789",
    "providerLabel": "AZURE",
    "status": "PENDING",
    "type": "EXTERNAL | INTERNAL_AND_EXTERNAL"
}
string as date-time
createdAt Optional

Record creation timestamp


string
description Optional

array of ErrorDetail
errorDetails Optional

List of Error Details


string
fqdn Optional

Admin-defined FQDN of the UAG cluster


array of UAGVmDetails
gateways Optional

List of UAG VMs and their details which are deployed


HDC
hdc Optional

string
id Optional

infrastructure Optional

Other infrastructure resources for the deployment. The keys in this map and the interpretation of the values depend on the provider type.


loadBalancer Optional

string
location Optional

location


string
name Optional

User defined name for this instance


integer as int32
numberOfGateways Optional

Number of Gateways needed in the UAG deployment cluster


string
orgId Optional

Org ID that owns this record


string
passwordCredentialId Optional

CredentialId where the Gateway password is stored.


privateLoadBalancer Optional

string
providerInstanceId Optional

Provider instance to where this UAG deployment is deployed


string
providerLabel Optional

Provider label (provider of which this is an instance)


proxyConfiguration Optional

reportedProperties Optional

map of string
resourceTags Optional

Resource tags that are added to UAG deployment


string
sslCertificateCredentialId Optional

CredentialId where the SSL certificate is stored.


sslCertificateTO Optional

string
status Optional

The configured status of the UAG Cluster deployment

Possible values are: DELETEDDELETE_PENDINGDELETINGDELETION_FAILEDDEPLOYINGFAILEDPENDINGREADYUPDATE_FAILEDUPDATE_PENDINGUPDATINGUPGRADE_FAILEDUPGRADE_PENDINGUPGRADING


string
type Optional

UAG deployment type

Possible values are: EXTERNALINTERNAL_AND_EXTERNAL


string as date-time
updatedAt Optional

Record updated timestamp


integer as int64
version Optional

Record version (internal)


202 Accepted Response Body>

Response Body

202 Accepted

Returns UAGDeploymentTOV2 of type */*

Accepted the request to patch existing UAG deployment record

{
    "fqdn": "www.example.com",
    "location": "US",
    "name": "My Instance Name",
    "numberOfGateways": 2,
    "orgId": "0123456789",
    "providerInstanceId": "0123456789",
    "providerLabel": "AZURE",
    "status": "PENDING",
    "type": "EXTERNAL | INTERNAL_AND_EXTERNAL"
}
string as date-time
createdAt Optional

Record creation timestamp


string
description Optional

array of ErrorDetail
errorDetails Optional

List of Error Details


string
fqdn Optional

Admin-defined FQDN of the UAG cluster


array of UAGVmDetails
gateways Optional

List of UAG VMs and their details which are deployed


HDC
hdc Optional

string
id Optional

infrastructure Optional

Other infrastructure resources for the deployment. The keys in this map and the interpretation of the values depend on the provider type.


loadBalancer Optional

string
location Optional

location


string
name Optional

User defined name for this instance


integer as int32
numberOfGateways Optional

Number of Gateways needed in the UAG deployment cluster


string
orgId Optional

Org ID that owns this record


string
passwordCredentialId Optional

CredentialId where the Gateway password is stored.


privateLoadBalancer Optional

string
providerInstanceId Optional

Provider instance to where this UAG deployment is deployed


string
providerLabel Optional

Provider label (provider of which this is an instance)


proxyConfiguration Optional

reportedProperties Optional

map of string
resourceTags Optional

Resource tags that are added to UAG deployment


string
sslCertificateCredentialId Optional

CredentialId where the SSL certificate is stored.


sslCertificateTO Optional

string
status Optional

The configured status of the UAG Cluster deployment

Possible values are: DELETEDDELETE_PENDINGDELETINGDELETION_FAILEDDEPLOYINGFAILEDPENDINGREADYUPDATE_FAILEDUPDATE_PENDINGUPDATINGUPGRADE_FAILEDUPGRADE_PENDINGUPGRADING


string
type Optional

UAG deployment type

Possible values are: EXTERNALINTERNAL_AND_EXTERNAL


string as date-time
updatedAt Optional

Record updated timestamp


integer as int64
version Optional

Record version (internal)

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


409

Conflict - concurrent updates


500

Unexpected internal server error

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"fqdn":"uag.example.com","numberOfGateways":2}' https://cloud.vmwarehorizon.com/admin/v2/uag-deployments/{id}
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?