Hosts - Delete

Reference

Service:: Azure Arc enabled VMware

API Version:: 2023-12-01

Deletes an host.
Implements host DELETE method.

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/hosts/{hostName}?api-version=2023-12-01

With optional parameters:

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/hosts/{hostName}?api-version=2023-12-01&force={force}

URI Parameters

Name	In	Required	Type	Description
hostName	path	True	string	Name of the host.
resourceGroupName	path	True	string	The Resource Group Name.
subscriptionId	path	True	string	The Subscription ID.
api-version	query	True	string	Client Api Version.
force	query		boolean	Whether force delete was specified.

Responses

Name	Type	Description
200 OK		Success
202 Accepted		Accepted Headers Location: string
204 No Content		No Content
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

DeleteHost

DELETE https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/hosts/HRHost?api-version=2023-12-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ConnectedVMwarevSphere.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ConnectedVMwarevSphere;

// Generated from example definition: specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/stable/2023-12-01/examples/DeleteHost.json
// this example is just showing the usage of "Hosts_Delete" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VMwareHostResource created on azure
// for more information of creating VMwareHostResource, please refer to the document of VMwareHostResource
string subscriptionId = "fd3c3665-1729-4b7b-9a38-238e83b0f98b";
string resourceGroupName = "testrg";
string hostName = "HRHost";
ResourceIdentifier vMwareHostResourceId = VMwareHostResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, hostName);
VMwareHostResource vMwareHost = client.GetVMwareHostResource(vMwareHostResourceId);

// invoke the operation
await vMwareHost.DeleteAsync(WaitUntil.Completed);

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/providers/Microsoft.ConnectedVMwarevSphere/locations/WESTEUROPE/operationStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-12-01

Status code:: 204

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Share via