Delete a working environment

07/12/2024 Contributors

You can delete an existing Azure Cloud Volumes ONTAP working environment.

Choose the workflow to use based on the type of Cloud Volumes ONTAP deployment:

Single Node
HA pair

Delete working environment for single node

You can use this workflow to delete a single node working environment.

Step 1. Create the working environment to use

Perform the workflow Create Azure single node working environment and choose the publicId value of the working environment for the workingEnvironmentId path parameter.

Step 2. Delete the working environment

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method	Path
DELETE	/occm/api/azure/vsa/working-environments/{workingEnvironmentId}

HTTP method

Path

DELETE

/occm/api/azure/vsa/working-environments/{workingEnvironmentId}

Curl example

curl --request DELETE \
--location DELETE "https://cloudmanager.cloud.netapp.com/occm/api/azure/vsa/working-environments/<WORKING_ENV_ID>" \
--header "Content-Type: application/json" \
--header "x-agent-id: <AGENT_ID>" \
--header "Authorization: Bearer <ACCESS_TOKEN>"

Additional input parameters

The JSON input example includes the minimum list of parameters.

Path parameter <WORKING_ENV_ID> (workingEnvironmentId) string
(Optional) Query parameters:
- localDelete boolean
  
  If true the Cloud Volumes ONTAP instance in the cloud is not terminated, but Cloud Manager no longer manages it (default is false).
- forceDelete boolean
  
  If true the working environment is deleted even if it is part of one or more SnapMirror relationships (default is false).

Output

None

Delete working environment for high availability pair

You can use this workflow to delete an HA working environment.