Create
DescriptionCreate a new Edge deployment: initiates the deployment process
Request
URLURL
Request Body
{
"description": "My new edge deployment.",
"fqdn": "edge-deployment.example.com",
"name": "my-first-edge-deployment",
"orgId": "1234556",
"providerInstanceId": "123456"
}
The name of the Edge Deployment
Use Private Link Service and enable private endpoint
FQDN with which to resolve the Edge VM management IP
Infrastructure resources needed by the Edge Deployment such as managementNetwork
The name of the Edge Deployment
The id of the CSP org
The ProviderInstance where the Edge Deployment is deployed
Resource tags that are added to edge deployment
SSO configurations for the edge deployment.
Authentication
Response
Response BodyResponse Body
201 Created
Successfully created 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"
}
Edge deployment synchronization status with AD twin
Possible values are: NONE , SYNCED , SYNC_NEEDED
Record creation timestamp
The description of the Edge Deployment
FQDN with which to resolve the Edge VM management IP
The id of the Edge Deployment
Infrastructure Resources needed by the Edge Deployment such as managementNetwork
location
The name of the Edge Deployment
The id of the CSP org
The ProviderInstance where the Edge Deployment is deployed
The type of the provider edge deployment belongs to
List of modules registered with the edge deployment
Resource tags that are added to edge deployment
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
Edge deployment synchronization status of edge twins
Possible values are: NONE , SYNCED , SYNC_NEEDED
Record update timestamp
Record version (internal)
Errors
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unexpected internal server error
Code Samples
cURL Command
Vendor Extensions
x-codegen-request-body-name: newEdgeDeployment
