delete Edge Deployments
DescriptionMarks an Edge deployment for deletion. Deletion will occur in the background.
Request
URLURL
Path Parameters
Path Parameters
Edge deployment ID
Query Parameters
Query Parameters
Delete the Edge deployment, ignoring any potential clean-up errors.
Organization ID: non-super users can only access their own organization
Authentication
Response
Response BodyResponse Body
202 Accepted
Accepted the request to delete the 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)
204 No Content
No Content
Errors
Bad Request
Unauthorized
Forbidden
Not Found
Conflict - deployment in use
Unexpected internal server error
