Share via

Guest Agents - Delete

  • Reference
Service:
Azure Arc enabled SCVMM
API Version:
2024-06-01

Deletes a GuestAgent resource.
Implements GuestAgent DELETE method.

DELETE https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2024-06-01

URI Parameters

Name In Required Type Description
resourceUri
 path True

string

The fully qualified Azure Resource manager identifier of the resource.
api-version
 query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

Resource deleted successfully.
204 No Content

Resource does not exist.
Other Status Codes

ErrorResponse

An unexpected error response.

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

GuestAgents_Delete_MaximumSet
GuestAgents_Delete_MinimumSet

GuestAgents_Delete_MaximumSet

Sample request

DELETE https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2024-06-01

Sample response

Status code:
200
Status code:
204

GuestAgents_Delete_MinimumSet

Sample request

DELETE https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2024-06-01

Sample response

Status code:
200
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.