VirtualMachineScaleSetVmResource 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 VirtualMachineScaleSetVm along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a VirtualMachineScaleSetVmResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource VirtualMachineScaleSetResource using the GetVirtualMachineScaleSetVms method.
public class VirtualMachineScaleSetVmResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.VirtualMachineScaleSetVmData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.VirtualMachineScaleSetVmData>type VirtualMachineScaleSetVmResource = class
inherit ArmResource
interface IJsonModel<VirtualMachineScaleSetVmData>
interface IPersistableModel<VirtualMachineScaleSetVmData>Public Class VirtualMachineScaleSetVmResource
Inherits ArmResource
Implements IJsonModel(Of VirtualMachineScaleSetVmData), IPersistableModel(Of VirtualMachineScaleSetVmData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| VirtualMachineScaleSetVmResource() |
Initializes a new instance of VirtualMachineScaleSetVmResource 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. |
| ApproveRollingUpgrade(WaitUntil, CancellationToken) |
Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.
|
| ApproveRollingUpgradeAsync(WaitUntil, CancellationToken) |
Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.
|
| AttachDetachDataDisks(WaitUntil, AttachDetachDataDisksRequest, CancellationToken) |
Attach and detach data disks to/from a virtual machine in a VM scale set.
|
| AttachDetachDataDisksAsync(WaitUntil, AttachDetachDataDisksRequest, CancellationToken) |
Attach and detach data disks to/from a virtual machine in a VM scale set.
|
| 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, String) |
Generate the resource identifier for this resource. |
| Deallocate(WaitUntil, CancellationToken) |
Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.
|
| DeallocateAsync(WaitUntil, CancellationToken) |
Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.
|
| Delete(WaitUntil, Nullable<Boolean>, CancellationToken) |
Deletes a virtual machine from a VM scale set.
|
| DeleteAsync(WaitUntil, Nullable<Boolean>, CancellationToken) |
Deletes a virtual machine from a VM scale set.
|
| Get(Nullable<InstanceViewType>, CancellationToken) |
Gets a virtual machine from a VM scale set.
|
| GetAsync(Nullable<InstanceViewType>, CancellationToken) |
Gets a virtual machine from a VM scale set.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetInstanceView(CancellationToken) |
Gets the status of a virtual machine from a VM scale set.
|
| GetInstanceViewAsync(CancellationToken) |
Gets the status of a virtual machine from a VM scale set.
|
| 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) |
| GetVirtualMachineScaleSetVmExtension(String, String, CancellationToken) |
The operation to get the VMSS VM extension. |
| GetVirtualMachineScaleSetVmExtensionAsync(String, String, CancellationToken) |
The operation to get the VMSS VM extension. |
| GetVirtualMachineScaleSetVmExtensions() |
Gets a collection of VirtualMachineScaleSetVmExtensions in the VirtualMachineScaleSetVmResource. |
| GetVirtualMachineScaleSetVmRunCommand(String, String, CancellationToken) |
The operation to get the VMSS VM run command. |
| GetVirtualMachineScaleSetVmRunCommandAsync(String, String, CancellationToken) |
The operation to get the VMSS VM run command. |
| GetVirtualMachineScaleSetVmRunCommands() |
Gets a collection of VirtualMachineScaleSetVmRunCommands in the VirtualMachineScaleSetVmResource. |
| PerformMaintenance(WaitUntil, CancellationToken) |
Performs maintenance on a virtual machine in a VM scale set.
|
| PerformMaintenanceAsync(WaitUntil, CancellationToken) |
Performs maintenance on a virtual machine in a VM scale set.
|
| PowerOff(WaitUntil, Nullable<Boolean>, CancellationToken) |
Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.
|
| PowerOffAsync(WaitUntil, Nullable<Boolean>, CancellationToken) |
Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.
|
| PowerOn(WaitUntil, CancellationToken) |
Starts a virtual machine in a VM scale set.
|
| PowerOnAsync(WaitUntil, CancellationToken) |
Starts a virtual machine in a VM scale set.
|
| Redeploy(WaitUntil, CancellationToken) |
Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.
|
| RedeployAsync(WaitUntil, CancellationToken) |
Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.
|
| Reimage(WaitUntil, VirtualMachineScaleSetVmReimageContent, CancellationToken) |
Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.
|
| ReimageAll(WaitUntil, CancellationToken) |
Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.
|
| ReimageAllAsync(WaitUntil, CancellationToken) |
Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.
|
| ReimageAsync(WaitUntil, VirtualMachineScaleSetVmReimageContent, CancellationToken) |
Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.
|
| 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) |
Restarts a virtual machine in a VM scale set.
|
| RestartAsync(WaitUntil, CancellationToken) |
Restarts a virtual machine in a VM scale set.
|
| RetrieveBootDiagnosticsData(Nullable<Int32>, CancellationToken) |
The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.
|
| RetrieveBootDiagnosticsDataAsync(Nullable<Int32>, CancellationToken) |
The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.
|
| RunCommand(WaitUntil, RunCommandInput, CancellationToken) |
Run command on a virtual machine in a VM scale set.
|
| RunCommandAsync(WaitUntil, RunCommandInput, CancellationToken) |
Run command on a virtual machine in a VM scale set.
|
| 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 in a VM scale set.
|
| SimulateEvictionAsync(CancellationToken) |
The operation to simulate the eviction of spot virtual machine in a VM scale set.
|
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(WaitUntil, VirtualMachineScaleSetVmData, MatchConditions, CancellationToken) |
Update a VirtualMachineScaleSetVm.
|
| UpdateAsync(WaitUntil, VirtualMachineScaleSetVmData, MatchConditions, CancellationToken) |
Update a VirtualMachineScaleSetVm.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<VirtualMachineScaleSetVmData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<VirtualMachineScaleSetVmData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<VirtualMachineScaleSetVmData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<VirtualMachineScaleSetVmData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<VirtualMachineScaleSetVmData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
Extension Methods
| Name | Description |
|---|---|
| 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. <item>MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.</item> |
| 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. <item>MockingTo mock this method, please mock GetDenyAssignments() instead.</item> |
| 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. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item> |
| 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. <item>MockingTo mock this method, please mock GetRoleAssignments() instead.</item> |
| 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. <item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.</item> |
| 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. <item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.</item> |
| GetRoleAssignmentSchedules(ArmResource) |
Gets a collection of RoleAssignmentScheduleResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.</item> |
| 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. <item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.</item> |
| 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. <item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.</item> |
| GetRoleEligibilitySchedules(ArmResource) |
Gets a collection of RoleEligibilityScheduleResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.</item> |
| GetRoleManagementPolicies(ArmResource) |
Gets a collection of RoleManagementPolicyResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleManagementPolicies() instead.</item> |
| 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. <item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.</item> |
| 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 scope. |
