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
| Name | Description |
|---|---|
| VirtualMachineResource() |
Initializes a new instance of the VirtualMachineResource class for mocking. |
Fields
| Name | Description |
|---|---|
| ResourceType |
Gets the resource type for the operations. |
Properties
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| AddTag(String, String, CancellationToken) |
Add a tag to the current resource.
|
| AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource.
|
| 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) |
| CreateResourceIdentifier(String, String, String) |
Generate the resource identifier of a VirtualMachineResource instance. |
| Delete(WaitUntil, Nullable<Boolean>, CancellationToken) |
Implements virtual machine DELETE method.
|
| DeleteAsync(WaitUntil, Nullable<Boolean>, CancellationToken) |
Implements virtual machine DELETE method.
|
| Get(CancellationToken) |
Implements virtual machine GET method.
|
| GetAllHybridIdentityMetadata() |
Gets a collection of HybridIdentityMetadataResources in the VirtualMachine. |
| GetAsync(CancellationToken) |
Implements virtual machine GET method.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetGuestAgent(String, CancellationToken) |
Implements GuestAgent GET method.
|
| GetGuestAgentAsync(String, CancellationToken) |
Implements GuestAgent GET method.
|
| GetGuestAgents() |
Gets a collection of GuestAgentResources in the VirtualMachine. |
| GetHybridIdentityMetadata(String, CancellationToken) |
Implements HybridIdentityMetadata GET method.
|
| GetHybridIdentityMetadataAsync(String, CancellationToken) |
Implements HybridIdentityMetadata GET method.
|
| GetMachineExtension(String, CancellationToken) |
The operation to get the extension.
|
| GetMachineExtensionAsync(String, CancellationToken) |
The operation to get the extension.
|
| GetMachineExtensions() |
Gets a collection of MachineExtensionResources in the VirtualMachine. |
| 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) |
| 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) |
Restart virtual machine.
|
| RestartAsync(WaitUntil, CancellationToken) |
Restart virtual machine.
|
| 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.
|
| Start(WaitUntil, CancellationToken) |
Start virtual machine.
|
| StartAsync(WaitUntil, CancellationToken) |
Start virtual machine.
|
| Stop(WaitUntil, StopVirtualMachineContent, CancellationToken) |
Stop virtual machine.
|
| StopAsync(WaitUntil, StopVirtualMachineContent, CancellationToken) |
Stop 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, CancellationToken) |
API to update certain properties of the virtual machine resource.
|
| UpdateAsync(WaitUntil, VirtualMachinePatch, CancellationToken) |
API to update certain properties of the virtual machine resource.
|
