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

Create

Description

Create a new provider instance.

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/admin/v2/providers/{label}/instances
Copy

Path Parameters

Path Parameters

string
label Required

Provider label


Query Parameters

Query Parameters

boolean
ignore_warnings Optional

If true, errors classified as warnings will be ignored


Request Body

Request Body

ProviderInstanceCreateTOV2 of mimetype application/json Required

newProviderInstance

{
    "edgeDeploymentId": "0123456789",
    "name": "My Instance Name",
    "orgId": "0123456789"
}
array of string
denyOperations Optional

User defined operations to be denied on this instance

Possible values are: EDGE_DEPLOYMENTTEMPLATE_CREATIONUAG_DEPLOYMENT


string
edgeDeploymentId Optional

EdgeGateway Deployment which we can use to manage and monitor infrastructure


string
name Optional

User defined name for this instance


string
orgId Optional

Org ID that owns this record


providerDetails Optional

map of string
resourceTags Optional

Resource tags that are added to Provider Instance

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns ProviderInstanceTOV2 of type */*

Successfully create provider instance

{
    "credentialId": "0123456789",
    "edgeDeploymentId": "0123456789",
    "id": "0123456789",
    "infraTwinId": "0123456789",
    "infraTwinSyncStatus": "READY",
    "location": "US",
    "name": "My Instance Name",
    "orgId": "0123456789",
    "primaryProvider": false,
    "providerLabel": "AZURE"
}
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 denied on this instance

Possible values are: EDGE_DEPLOYMENTTEMPLATE_CREATIONUAG_DEPLOYMENT


string
description Optional

User defined description for this instance


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

ErrorResponse
400

Bad Request


ErrorResponse
401

Unauthorized


ErrorResponse
403

Forbidden


ErrorResponse
404

Not Found


ErrorResponse
409

Conflict


ErrorResponse
423

Provider disabled


ErrorResponse
500

Unexpected internal server error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"edgeDeploymentId":"0123456789","name":"My Instance Name","orgId":"0123456789"}' https://cloud.vmwarehorizon.com/admin/v2/providers/{label}/instances
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?