Method: projects.locations.azureClusters.delete

Deletes a specific AzureCluster resource.

Fails if the cluster has one or more associated AzureNodePool resources.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

HTTP request

DELETE https://{endpoint}/v1/{name=projects/*/locations/*/azureClusters/*}

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name the AzureCluster to delete.

AzureCluster names are formatted as projects/<project-id>/locations/<region>/azureClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

Query parameters

Parameters
allowMissing

boolean

If set to true, and the AzureCluster resource is not found, the request will succeed but no action will be taken on the server and a completed Operation will be returned.

Useful for idempotent deletion.

validateOnly

boolean

If set, only validate the request, but do not actually delete the resource.

etag

string

The current etag of the AzureCluster.

Allows clients to perform deletions through optimistic concurrency control.

If the provided etag does not match the current etag of the cluster, the request will fail and an ABORTED error will be returned.

ignoreErrors

boolean

Optional. If set to true, the deletion of AzureCluster resource will succeed even if errors occur during deleting in cluster resources. Using this parameter may result in orphaned resources in the cluster.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gkemulticloud.azureClusters.delete

For more information, see the IAM documentation.