Freigeben über


VirtualMachineScaleSetVmResource Class

Definition

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 GetVirtualMachineScaleSetVmResource method. Otherwise you can get one from its parent resource VirtualMachineScaleSetResource using the GetVirtualMachineScaleSetVm 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
VirtualMachineScaleSetVmResource
Implements

Constructors

VirtualMachineScaleSetVmResource()

Initializes a new instance of the VirtualMachineScaleSetVmResource 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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
ApproveRollingUpgrade(WaitUntil, CancellationToken)

Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/approveRollingUpgrade
  • Operation Id: VirtualMachineScaleSetVMs_ApproveRollingUpgrade
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
ApproveRollingUpgradeAsync(WaitUntil, CancellationToken)

Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/approveRollingUpgrade
  • Operation Id: VirtualMachineScaleSetVMs_ApproveRollingUpgrade
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
AttachDetachDataDisks(WaitUntil, AttachDetachDataDisksRequest, CancellationToken)

Attach and detach data disks to/from a virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/attachDetachDataDisks
  • Operation Id: VirtualMachineScaleSetVMs_AttachDetachDataDisks
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
AttachDetachDataDisksAsync(WaitUntil, AttachDetachDataDisksRequest, CancellationToken)

Attach and detach data disks to/from a virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/attachDetachDataDisks
  • Operation Id: VirtualMachineScaleSetVMs_AttachDetachDataDisks
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
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 of a VirtualMachineScaleSetVmResource instance.

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/deallocate
  • Operation Id: VirtualMachineScaleSetVMs_Deallocate
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/deallocate
  • Operation Id: VirtualMachineScaleSetVMs_Deallocate
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
Delete(WaitUntil, Nullable<Boolean>, CancellationToken)

Deletes a virtual machine from a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Delete
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
DeleteAsync(WaitUntil, Nullable<Boolean>, CancellationToken)

Deletes a virtual machine from a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Delete
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
Get(Nullable<InstanceViewType>, CancellationToken)

Gets a virtual machine from a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
GetAsync(Nullable<InstanceViewType>, CancellationToken)

Gets a virtual machine from a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView
  • Operation Id: VirtualMachineScaleSetVMs_GetInstanceView
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
GetInstanceViewAsync(CancellationToken)

Gets the status of a virtual machine from a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView
  • Operation Id: VirtualMachineScaleSetVMs_GetInstanceView
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}
  • Operation Id: VirtualMachineScaleSetVMExtensions_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmExtensionResource
GetVirtualMachineScaleSetVmExtensionAsync(String, String, CancellationToken)

The operation to get the VMSS VM extension.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}
  • Operation Id: VirtualMachineScaleSetVMExtensions_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmExtensionResource
GetVirtualMachineScaleSetVmExtensions()

Gets a collection of VirtualMachineScaleSetVmExtensionResources in the VirtualMachineScaleSetVm.

GetVirtualMachineScaleSetVmRunCommand(String, String, CancellationToken)

The operation to get the VMSS VM run command.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}
  • Operation Id: VirtualMachineScaleSetVMRunCommands_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmRunCommandResource
GetVirtualMachineScaleSetVmRunCommandAsync(String, String, CancellationToken)

The operation to get the VMSS VM run command.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}
  • Operation Id: VirtualMachineScaleSetVMRunCommands_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmRunCommandResource
GetVirtualMachineScaleSetVmRunCommands()

Gets a collection of VirtualMachineScaleSetVmRunCommandResources in the VirtualMachineScaleSetVm.

PerformMaintenance(WaitUntil, CancellationToken)

Performs maintenance on a virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance
  • Operation Id: VirtualMachineScaleSetVMs_PerformMaintenance
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
PerformMaintenanceAsync(WaitUntil, CancellationToken)

Performs maintenance on a virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance
  • Operation Id: VirtualMachineScaleSetVMs_PerformMaintenance
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff
  • Operation Id: VirtualMachineScaleSetVMs_PowerOff
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff
  • Operation Id: VirtualMachineScaleSetVMs_PowerOff
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
PowerOn(WaitUntil, CancellationToken)

Starts a virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start
  • Operation Id: VirtualMachineScaleSetVMs_Start
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
PowerOnAsync(WaitUntil, CancellationToken)

Starts a virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start
  • Operation Id: VirtualMachineScaleSetVMs_Start
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy
  • Operation Id: VirtualMachineScaleSetVMs_Redeploy
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy
  • Operation Id: VirtualMachineScaleSetVMs_Redeploy
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
Reimage(WaitUntil, VirtualMachineScaleSetVmReimageContent, CancellationToken)

Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimage
  • Operation Id: VirtualMachineScaleSetVMs_Reimage
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimageall
  • Operation Id: VirtualMachineScaleSetVMs_ReimageAll
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimageall
  • Operation Id: VirtualMachineScaleSetVMs_ReimageAll
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
ReimageAsync(WaitUntil, VirtualMachineScaleSetVmReimageContent, CancellationToken)

Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimage
  • Operation Id: VirtualMachineScaleSetVMs_Reimage
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
Restart(WaitUntil, CancellationToken)

Restarts a virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart
  • Operation Id: VirtualMachineScaleSetVMs_Restart
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
RestartAsync(WaitUntil, CancellationToken)

Restarts a virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart
  • Operation Id: VirtualMachineScaleSetVMs_Restart
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
RetrieveBootDiagnosticsData(Nullable<Int32>, CancellationToken)

The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/retrieveBootDiagnosticsData
  • Operation Id: VirtualMachineScaleSetVMs_RetrieveBootDiagnosticsData
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
RetrieveBootDiagnosticsDataAsync(Nullable<Int32>, CancellationToken)

The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/retrieveBootDiagnosticsData
  • Operation Id: VirtualMachineScaleSetVMs_RetrieveBootDiagnosticsData
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
RunCommand(WaitUntil, RunCommandInput, CancellationToken)

Run command on a virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/runCommand
  • Operation Id: VirtualMachineScaleSetVMs_RunCommand
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
RunCommandAsync(WaitUntil, RunCommandInput, CancellationToken)

Run command on a virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/runCommand
  • Operation Id: VirtualMachineScaleSetVMs_RunCommand
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
SimulateEviction(CancellationToken)

The operation to simulate the eviction of spot virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/simulateEviction
  • Operation Id: VirtualMachineScaleSetVMs_SimulateEviction
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
SimulateEvictionAsync(CancellationToken)

The operation to simulate the eviction of spot virtual machine in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/simulateEviction
  • Operation Id: VirtualMachineScaleSetVMs_SimulateEviction
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, VirtualMachineScaleSetVmData, String, String, CancellationToken)

Updates a virtual machine of a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Update
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
UpdateAsync(WaitUntil, VirtualMachineScaleSetVmData, String, String, CancellationToken)

Updates a virtual machine of a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Update
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource

Explicit Interface Implementations

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

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
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

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
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

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
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

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
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

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
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.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to