VirtualMachineResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A Class representing a VirtualMachine along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a VirtualMachineResource from an instance of ArmClient using the GetVirtualMachineResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetVirtualMachine method.
public class VirtualMachineResource : Azure.ResourceManager.ArmResourcetype VirtualMachineResource = class
inherit ArmResourcePublic Class VirtualMachineResource
Inherits ArmResource- Inheritance
Constructors
| VirtualMachineResource() |
Initializes a new instance of the VirtualMachineResource class for mocking. |
Fields
| ResourceType |
Gets the resource type for the operations. |
Properties
| Client |
Gets the ArmClient this resource client was created from. (Inherited from ArmResource) |
| Data |
Gets the data representing this Feature. |
| Diagnostics |
Gets the diagnostic options for this resource client. (Inherited from ArmResource) |
| Endpoint |
Gets the base uri for this resource client. (Inherited from ArmResource) |
| HasData |
Gets whether or not the current instance has data. |
| Id |
Gets the resource identifier. (Inherited from ArmResource) |
| Pipeline |
Gets the pipeline for this resource client. (Inherited from ArmResource) |
Methods
| AddTag(String, String, CancellationToken) |
Add a tag to the current resource.
|
| AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource.
|
| AssessPatches(WaitUntil, CancellationToken) |
Assess patches on the VM.
|
| AssessPatchesAsync(WaitUntil, CancellationToken) |
Assess patches on the VM.
|
| AttachDetachDataDisks(WaitUntil, AttachDetachDataDisksRequest, CancellationToken) |
Attach and detach data disks to/from the virtual machine.
|
| AttachDetachDataDisksAsync(WaitUntil, AttachDetachDataDisksRequest, CancellationToken) |
Attach and detach data disks to/from the virtual machine.
|
| CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| Capture(WaitUntil, VirtualMachineCaptureContent, CancellationToken) |
Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.
|
| CaptureAsync(WaitUntil, VirtualMachineCaptureContent, CancellationToken) |
Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.
|
| ConvertToManagedDisks(WaitUntil, CancellationToken) |
Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.
|
| ConvertToManagedDisksAsync(WaitUntil, CancellationToken) |
Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.
|
| CreateResourceIdentifier(String, String, String) |
Generate the resource identifier of a VirtualMachineResource instance. |
| Deallocate(WaitUntil, Nullable<Boolean>, CancellationToken) |
Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.
|
| DeallocateAsync(WaitUntil, Nullable<Boolean>, CancellationToken) |
Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.
|
| Delete(WaitUntil, Nullable<Boolean>, CancellationToken) |
The operation to delete a virtual machine.
|
| DeleteAsync(WaitUntil, Nullable<Boolean>, CancellationToken) |
The operation to delete a virtual machine.
|
| Generalize(CancellationToken) |
Sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation. For Windows, please refer to Create a managed image of a generalized VM in Azure. For Linux, please refer to How to create an image of a virtual machine or VHD.
|
| GeneralizeAsync(CancellationToken) |
Sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation. For Windows, please refer to Create a managed image of a generalized VM in Azure. For Linux, please refer to How to create an image of a virtual machine or VHD.
|
| Get(Nullable<InstanceViewType>, CancellationToken) |
Retrieves information about the model view or the instance view of a virtual machine.
|
| GetAsync(Nullable<InstanceViewType>, CancellationToken) |
Retrieves information about the model view or the instance view of a virtual machine.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableSizes(CancellationToken) |
Lists all available virtual machine sizes to which the specified virtual machine can be resized.
|
| GetAvailableSizesAsync(CancellationToken) |
Lists all available virtual machine sizes to which the specified virtual machine can be resized.
|
| GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
| GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| GetVirtualMachineExtension(String, String, CancellationToken) |
The operation to get the extension.
|
| GetVirtualMachineExtensionAsync(String, String, CancellationToken) |
The operation to get the extension.
|
| GetVirtualMachineExtensions() |
Gets a collection of VirtualMachineExtensionResources in the VirtualMachine. |
| GetVirtualMachineRunCommand(String, String, CancellationToken) |
The operation to get the run command.
|
| GetVirtualMachineRunCommandAsync(String, String, CancellationToken) |
The operation to get the run command.
|
| GetVirtualMachineRunCommands() |
Gets a collection of VirtualMachineRunCommandResources in the VirtualMachine. |
| InstallPatches(WaitUntil, VirtualMachineInstallPatchesContent, CancellationToken) |
Installs patches on the VM.
|
| InstallPatchesAsync(WaitUntil, VirtualMachineInstallPatchesContent, CancellationToken) |
Installs patches on the VM.
|
| InstanceView(CancellationToken) |
Retrieves information about the run-time state of a virtual machine.
|
| InstanceViewAsync(CancellationToken) |
Retrieves information about the run-time state of a virtual machine.
|
| PerformMaintenance(WaitUntil, CancellationToken) |
The operation to perform maintenance on a virtual machine.
|
| PerformMaintenanceAsync(WaitUntil, CancellationToken) |
The operation to perform maintenance on a virtual machine.
|
| PowerOff(WaitUntil, Nullable<Boolean>, CancellationToken) |
The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.
|
| PowerOffAsync(WaitUntil, Nullable<Boolean>, CancellationToken) |
The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.
|
| PowerOn(WaitUntil, CancellationToken) |
The operation to start a virtual machine.
|
| PowerOnAsync(WaitUntil, CancellationToken) |
The operation to start a virtual machine.
|
| Reapply(WaitUntil, CancellationToken) |
The operation to reapply a virtual machine's state.
|
| ReapplyAsync(WaitUntil, CancellationToken) |
The operation to reapply a virtual machine's state.
|
| Redeploy(WaitUntil, CancellationToken) |
Shuts down the virtual machine, moves it to a new node, and powers it back on.
|
| RedeployAsync(WaitUntil, CancellationToken) |
Shuts down the virtual machine, moves it to a new node, and powers it back on.
|
| Reimage(WaitUntil, VirtualMachineReimageContent, CancellationToken) |
Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.
|
| ReimageAsync(WaitUntil, VirtualMachineReimageContent, CancellationToken) |
Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.
|
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource.
|
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource.
|
| Restart(WaitUntil, CancellationToken) |
The operation to restart a virtual machine.
|
| RestartAsync(WaitUntil, CancellationToken) |
The operation to restart a virtual machine.
|
| RetrieveBootDiagnosticsData(Nullable<Int32>, CancellationToken) |
The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.
|
| RetrieveBootDiagnosticsDataAsync(Nullable<Int32>, CancellationToken) |
The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.
|
| RunCommand(WaitUntil, RunCommandInput, CancellationToken) |
Run command on the VM.
|
| RunCommandAsync(WaitUntil, RunCommandInput, CancellationToken) |
Run command on the VM.
|
| SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
| SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
| SimulateEviction(CancellationToken) |
The operation to simulate the eviction of spot virtual machine.
|
| SimulateEvictionAsync(CancellationToken) |
The operation to simulate the eviction of spot virtual machine.
|
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(WaitUntil, VirtualMachinePatch, String, String, CancellationToken) |
The operation to update a virtual machine.
|
| UpdateAsync(WaitUntil, VirtualMachinePatch, String, String, CancellationToken) |
The operation to update a virtual machine.
|
Extension Methods
| GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
| GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
| GetAuthorizationRoleDefinitions(ArmResource) |
Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead. |
| GetDenyAssignment(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
| GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
| GetDenyAssignments(ArmResource) |
Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead. |
| GetRoleAssignment(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
| GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
| GetRoleAssignments(ArmResource) |
Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead. |
| GetRoleAssignmentSchedule(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
| GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
| GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
| GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
| GetRoleAssignmentScheduleInstances(ArmResource) |
Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead. |
| GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
| GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
| GetRoleAssignmentScheduleRequests(ArmResource) |
Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead. |
| GetRoleAssignmentSchedules(ArmResource) |
Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead. |
| GetRoleEligibilitySchedule(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
| GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
| GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
| GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
| GetRoleEligibilityScheduleInstances(ArmResource) |
Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead. |
| GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
| GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
| GetRoleEligibilityScheduleRequests(ArmResource) |
Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead. |
| GetRoleEligibilitySchedules(ArmResource) |
Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead. |
| GetRoleManagementPolicies(ArmResource) |
Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead. |
| GetRoleManagementPolicy(ArmResource, String, CancellationToken) |
Get the specified role management policy for a resource scope
|
| GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
| GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
| GetRoleManagementPolicyAssignments(ArmResource) |
Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead. |
| GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy for a resource scope
|
| GetSystemAssignedIdentity(ArmResource) |
Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead. |
| GetLinkerResource(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
| GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
| GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for