Delete Zones
DescriptionDeletes the zone with the specified identifier. In order to delete a zone, there must not be any workload running in that zone because deleting the zone without removing all the dependencies on that zone can cause undefined behavior for the entities depending on this zone to be present. if you do not have all of the privileges described as follows: - Operation execution requires Zone.Manage.
Request
URLURL
https://{api_host}/api/vcenter/consumption-domains/zones/{zone}
Path Parameters
Path Parameters
string
zone
Required
Identifier of the zone to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if there is a workload running in the specified zone and depends on this zone to be present.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have all of the privileges described as follows: - The resource com.vmware.vcenter.consumption_domains.Zone referenced by the parameter zone requires Zones.Manage privilege.
404
com.vmware.vapi.std.errors.not_found : if no zone with the specified identifier is found in this vCenter server.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-DeleteZoneConsumptionDomains -Zone "MyZone"
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/consumption-domains/zones/{zone}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: delete
Availability
Added in 8.0.0.1
