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

Register Edge Gateway

Description

Associate an Edge Deployment with a provider instance.

Request

Request

URL

URL


patch
https://cloud.vmwarehorizon.com/admin/v2/providers/{label}/instances/{id}/edge-deployment
Copy

Path Parameters

Path Parameters

string
id Required

Provider instance ID


string
label Required

Provider label


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

ProviderInstancePatchEdgeTOV2 of mimetype application/json Required

edgeGatewayLocation

{
	"edgeDeploymentId": "string"
}
string
edgeDeploymentId Optional
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns ProviderInstanceTOV2 of type */*

Successfully registered edge gateway for provider instance

{
	"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
}
string as date-time
createdAt Optional

Record creation timestamp


string
credentialId Optional

ID of the credential storing the sensitive data of provider


array of string
denyOperations Optional

User defined operations to be deny on this instance

Possible values are: EDGE_DEPLOYMENTTEMPLATE_CREATIONUAG_DEPLOYMENT


string
edgeDeploymentId Optional

EdgeGateway Deployment which we can use to manage and monitor infrastructure


HDC
hdc Optional

healthStatusDetails Optional

string
id Optional

Unique record ID


string
infraTwinId Optional

Id of the Infrastructure Twin which can be use to talk to the corresponding infra module.


string
infraTwinSyncStatus Optional

Status of this provider instance

Possible values are: NONESYNCEDSYNC_NEEDED


map of string
infrastructureLinks Optional

Links to all infrastructure available from this provider


string
location Optional

location


string
name Optional

User defined name for this instance


string
orgId Optional

Org ID that owns this record


boolean
primaryProvider Optional

True if this provider has an edge deployment deployed in it.


providerDetails Optional

string
providerLabel Optional

Provider label (provider of which this is an instance)


map of string
resourceTags Optional

Resource tags that are added to Provider Instance


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


423

Provider disabled

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"edgeDeploymentId":"string"}' https://cloud.vmwarehorizon.com/admin/v2/providers/{label}/instances/{id}/edge-deployment
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?