Share via


VirtualMachineScaleSetResource Class

Definition

A Class representing a VirtualMachineScaleSet along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a VirtualMachineScaleSetResource from an instance of ArmClient using the GetVirtualMachineScaleSetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetVirtualMachineScaleSet method.

public class VirtualMachineScaleSetResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.VirtualMachineScaleSetData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.VirtualMachineScaleSetData>
type VirtualMachineScaleSetResource = class
    inherit ArmResource
    interface IJsonModel<VirtualMachineScaleSetData>
    interface IPersistableModel<VirtualMachineScaleSetData>
Public Class VirtualMachineScaleSetResource
Inherits ArmResource
Implements IJsonModel(Of VirtualMachineScaleSetData), IPersistableModel(Of VirtualMachineScaleSetData)
Inheritance
VirtualMachineScaleSetResource
Implements

Constructors

VirtualMachineScaleSetResource()

Initializes a new instance of the VirtualMachineScaleSetResource 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}
  • Operation Id: VirtualMachineScaleSets_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

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

Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.

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

Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.

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

Cancels the current virtual machine scale set rolling upgrade.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel
  • Operation Id: VirtualMachineScaleSetRollingUpgrades_Cancel
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetRollingUpgradeResource
CancelVirtualMachineScaleSetRollingUpgradeAsync(WaitUntil, CancellationToken)

Cancels the current virtual machine scale set rolling upgrade.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel
  • Operation Id: VirtualMachineScaleSetRollingUpgrades_Cancel
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetRollingUpgradeResource
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)
ConvertToSinglePlacementGroup(VirtualMachineScaleSetConvertToSinglePlacementGroupContent, CancellationToken)

Converts SinglePlacementGroup property to false for a existing virtual machine scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/convertToSinglePlacementGroup
  • Operation Id: VirtualMachineScaleSets_ConvertToSinglePlacementGroup
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
ConvertToSinglePlacementGroupAsync(VirtualMachineScaleSetConvertToSinglePlacementGroupContent, CancellationToken)

Converts SinglePlacementGroup property to false for a existing virtual machine scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/convertToSinglePlacementGroup
  • Operation Id: VirtualMachineScaleSets_ConvertToSinglePlacementGroup
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
CreateResourceIdentifier(String, String, String)

Generate the resource identifier of a VirtualMachineScaleSetResource instance.

Deallocate(WaitUntil, VirtualMachineScaleSetVmInstanceIds, Nullable<Boolean>, CancellationToken)

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

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

Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

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

Deletes a VM scale set.

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

Deletes a VM scale set.

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

Deletes virtual machines in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete
  • Operation Id: VirtualMachineScaleSets_DeleteInstances
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
DeleteInstancesAsync(WaitUntil, VirtualMachineScaleSetVmInstanceRequiredIds, Nullable<Boolean>, CancellationToken)

Deletes virtual machines in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete
  • Operation Id: VirtualMachineScaleSets_DeleteInstances
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
ForceRecoveryServiceFabricPlatformUpdateDomainWalk(Int32, String, String, CancellationToken)

Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk
  • Operation Id: VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
ForceRecoveryServiceFabricPlatformUpdateDomainWalkAsync(Int32, String, String, CancellationToken)

Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk
  • Operation Id: VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
Get(Nullable<VirtualMachineScaleSetGetExpand>, CancellationToken)

Display information about a virtual machine scale set.

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

Display information about a virtual machine scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}
  • Operation Id: VirtualMachineScaleSets_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
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 VM scale set instance.

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

Gets the status of a VM scale set instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView
  • Operation Id: VirtualMachineScaleSets_GetInstanceView
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
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)
GetOSUpgradeHistory(CancellationToken)

Gets list of OS upgrades on a VM scale set instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory
  • Operation Id: VirtualMachineScaleSets_GetOSUpgradeHistory
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
GetOSUpgradeHistoryAsync(CancellationToken)

Gets list of OS upgrades on a VM scale set instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory
  • Operation Id: VirtualMachineScaleSets_GetOSUpgradeHistory
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
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)
GetSkus(CancellationToken)

Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus
  • Operation Id: VirtualMachineScaleSets_ListSkus
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
GetSkusAsync(CancellationToken)

Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus
  • Operation Id: VirtualMachineScaleSets_ListSkus
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetVirtualMachineScaleSetExtension(String, String, CancellationToken)

The operation to get the extension.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}
  • Operation Id: VirtualMachineScaleSetExtensions_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetExtensionResource
GetVirtualMachineScaleSetExtensionAsync(String, String, CancellationToken)

The operation to get the extension.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}
  • Operation Id: VirtualMachineScaleSetExtensions_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetExtensionResource
GetVirtualMachineScaleSetExtensions()

Gets a collection of VirtualMachineScaleSetExtensionResources in the VirtualMachineScaleSet.

GetVirtualMachineScaleSetRollingUpgrade()

Gets an object representing a VirtualMachineScaleSetRollingUpgradeResource along with the instance operations that can be performed on it in the VirtualMachineScaleSet.

GetVirtualMachineScaleSetVm(String, 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
GetVirtualMachineScaleSetVmAsync(String, 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
GetVirtualMachineScaleSetVms()

Gets a collection of VirtualMachineScaleSetVmResources in the VirtualMachineScaleSet.

PerformMaintenance(WaitUntil, VirtualMachineScaleSetVmInstanceIds, CancellationToken)

Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

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

Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance
  • Operation Id: VirtualMachineScaleSets_PerformMaintenance
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
PowerOff(WaitUntil, VirtualMachineScaleSetVmInstanceIds, Nullable<Boolean>, CancellationToken)

Power off (stop) one or more virtual machines 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}/poweroff
  • Operation Id: VirtualMachineScaleSets_PowerOff
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
PowerOffAsync(WaitUntil, VirtualMachineScaleSetVmInstanceIds, Nullable<Boolean>, CancellationToken)

Power off (stop) one or more virtual machines 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}/poweroff
  • Operation Id: VirtualMachineScaleSets_PowerOff
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
PowerOn(WaitUntil, VirtualMachineScaleSetVmInstanceIds, CancellationToken)

Starts one or more virtual machines in a VM scale set.

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

Starts one or more virtual machines in a VM scale set.

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

Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reapply
  • Operation Id: VirtualMachineScaleSets_Reapply
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
ReapplyAsync(WaitUntil, CancellationToken)

Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reapply
  • Operation Id: VirtualMachineScaleSets_Reapply
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
Redeploy(WaitUntil, VirtualMachineScaleSetVmInstanceIds, CancellationToken)

Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy
  • Operation Id: VirtualMachineScaleSets_Redeploy
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
RedeployAsync(WaitUntil, VirtualMachineScaleSetVmInstanceIds, CancellationToken)

Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.

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

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set 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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage
  • Operation Id: VirtualMachineScaleSets_Reimage
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
ReimageAll(WaitUntil, VirtualMachineScaleSetVmInstanceIds, CancellationToken)

Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall
  • Operation Id: VirtualMachineScaleSets_ReimageAll
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
ReimageAllAsync(WaitUntil, VirtualMachineScaleSetVmInstanceIds, CancellationToken)

Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.

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

Reimages (upgrade the operating system) one or more virtual machines in a VM scale set 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.

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

Removes a tag by key from the resource.

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

Removes a tag by key from the resource.

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

Restarts one or more virtual machines in a VM scale set.

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

Restarts one or more virtual machines in a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart
  • Operation Id: VirtualMachineScaleSets_Restart
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
SetOrchestrationServiceState(WaitUntil, OrchestrationServiceStateContent, CancellationToken)

Changes ServiceState property for a given service

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/setOrchestrationServiceState
  • Operation Id: VirtualMachineScaleSets_SetOrchestrationServiceState
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
SetOrchestrationServiceStateAsync(WaitUntil, OrchestrationServiceStateContent, CancellationToken)

Changes ServiceState property for a given service

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/setOrchestrationServiceState
  • Operation Id: VirtualMachineScaleSets_SetOrchestrationServiceState
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
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}
  • Operation Id: VirtualMachineScaleSets_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
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}
  • Operation Id: VirtualMachineScaleSets_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
StartExtensionUpgradeVirtualMachineScaleSetRollingUpgrade(WaitUntil, CancellationToken)

Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensionRollingUpgrade
  • Operation Id: VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetRollingUpgradeResource
StartExtensionUpgradeVirtualMachineScaleSetRollingUpgradeAsync(WaitUntil, CancellationToken)

Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensionRollingUpgrade
  • Operation Id: VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetRollingUpgradeResource
StartOSUpgrade(WaitUntil, CancellationToken)

Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade
  • Operation Id: VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetRollingUpgradeResource
StartOSUpgradeAsync(WaitUntil, CancellationToken)

Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.

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

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

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

Update a VM scale set.

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

Update a VM scale set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}
  • Operation Id: VirtualMachineScaleSets_Update
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
UpdateInstances(WaitUntil, VirtualMachineScaleSetVmInstanceRequiredIds, CancellationToken)

Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade
  • Operation Id: VirtualMachineScaleSets_UpdateInstances
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource
UpdateInstancesAsync(WaitUntil, VirtualMachineScaleSetVmInstanceRequiredIds, CancellationToken)

Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade
  • Operation Id: VirtualMachineScaleSets_UpdateInstances
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetResource

Explicit Interface Implementations

IJsonModel<VirtualMachineScaleSetData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<VirtualMachineScaleSetData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<VirtualMachineScaleSetData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<VirtualMachineScaleSetData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<VirtualMachineScaleSetData>.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