VirtualMachineScaleSetResource 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 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
- 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.
|
| AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource.
|
| ApproveRollingUpgrade(WaitUntil, VirtualMachineScaleSetVmInstanceIds, CancellationToken) |
Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.
|
| ApproveRollingUpgradeAsync(WaitUntil, VirtualMachineScaleSetVmInstanceIds, CancellationToken) |
Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.
|
| CancelVirtualMachineScaleSetRollingUpgrade(WaitUntil, CancellationToken) |
Cancels the current virtual machine scale set rolling upgrade.
|
| CancelVirtualMachineScaleSetRollingUpgradeAsync(WaitUntil, CancellationToken) |
Cancels the current virtual machine scale set rolling upgrade.
|
| 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.
|
| ConvertToSinglePlacementGroupAsync(VirtualMachineScaleSetConvertToSinglePlacementGroupContent, CancellationToken) |
Converts SinglePlacementGroup property to false for a existing virtual machine scale set.
|
| 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.
|
| 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.
|
| Delete(WaitUntil, Nullable<Boolean>, CancellationToken) |
Deletes a VM scale set.
|
| DeleteAsync(WaitUntil, Nullable<Boolean>, CancellationToken) |
Deletes a VM scale set.
|
| DeleteInstances(WaitUntil, VirtualMachineScaleSetVmInstanceRequiredIds, Nullable<Boolean>, CancellationToken) |
Deletes virtual machines in a VM scale set.
|
| DeleteInstancesAsync(WaitUntil, VirtualMachineScaleSetVmInstanceRequiredIds, Nullable<Boolean>, CancellationToken) |
Deletes virtual machines in a VM scale set.
|
| ForceRecoveryServiceFabricPlatformUpdateDomainWalk(Int32, String, String, CancellationToken) |
Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.
|
| ForceRecoveryServiceFabricPlatformUpdateDomainWalkAsync(Int32, String, String, CancellationToken) |
Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.
|
| Get(Nullable<VirtualMachineScaleSetGetExpand>, CancellationToken) |
Display information about a virtual machine scale set.
|
| GetAsync(Nullable<VirtualMachineScaleSetGetExpand>, CancellationToken) |
Display information about a virtual machine 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 VM scale set instance.
|
| GetInstanceViewAsync(CancellationToken) |
Gets the status of a VM scale set instance.
|
| 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) |
| GetOSUpgradeHistory(CancellationToken) |
Gets list of OS upgrades on a VM scale set instance.
|
| GetOSUpgradeHistoryAsync(CancellationToken) |
Gets list of OS upgrades on a VM scale set instance.
|
| 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) |
| GetSkus(CancellationToken) |
Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.
|
| GetSkusAsync(CancellationToken) |
Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.
|
| 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.
|
| GetVirtualMachineScaleSetExtensionAsync(String, String, CancellationToken) |
The operation to get the extension.
|
| 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.
|
| GetVirtualMachineScaleSetVmAsync(String, Nullable<InstanceViewType>, CancellationToken) |
Gets a virtual machine from a VM scale set.
|
| 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
|
| 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
|
| 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.
|
| 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.
|
| PowerOn(WaitUntil, VirtualMachineScaleSetVmInstanceIds, CancellationToken) |
Starts one or more virtual machines in a VM scale set.
|
| PowerOnAsync(WaitUntil, VirtualMachineScaleSetVmInstanceIds, CancellationToken) |
Starts one or more virtual machines in a VM scale set.
|
| Reapply(WaitUntil, CancellationToken) |
Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances
|
| ReapplyAsync(WaitUntil, CancellationToken) |
Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource.
|
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource.
|
| Restart(WaitUntil, VirtualMachineScaleSetVmInstanceIds, CancellationToken) |
Restarts one or more virtual machines in a VM scale set.
|
| RestartAsync(WaitUntil, VirtualMachineScaleSetVmInstanceIds, CancellationToken) |
Restarts one or more virtual machines in a VM scale set.
|
| SetOrchestrationServiceState(WaitUntil, OrchestrationServiceStateContent, CancellationToken) |
Changes ServiceState property for a given service
|
| SetOrchestrationServiceStateAsync(WaitUntil, OrchestrationServiceStateContent, CancellationToken) |
Changes ServiceState property for a given service
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| UpdateAsync(WaitUntil, VirtualMachineScaleSetPatch, String, String, CancellationToken) |
Update a VM scale set.
|
| UpdateInstances(WaitUntil, VirtualMachineScaleSetVmInstanceRequiredIds, CancellationToken) |
Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.
|
| UpdateInstancesAsync(WaitUntil, VirtualMachineScaleSetVmInstanceRequiredIds, CancellationToken) |
Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.
|
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).
|
| GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
| GetAuthorizationRoleDefinitions(ArmResource) |
Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead. |
| GetDenyAssignment(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
| GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
| GetDenyAssignments(ArmResource) |
Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead. |
| GetRoleAssignment(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
| GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
| GetRoleAssignments(ArmResource) |
Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead. |
| GetRoleAssignmentSchedule(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
| GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
| GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
| GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
| GetRoleAssignmentScheduleInstances(ArmResource) |
Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead. |
| GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
| GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
| GetRoleAssignmentScheduleRequests(ArmResource) |
Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead. |
| GetRoleAssignmentSchedules(ArmResource) |
Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead. |
| GetRoleEligibilitySchedule(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
| GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
| GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
| GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
| GetRoleEligibilityScheduleInstances(ArmResource) |
Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead. |
| GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
| GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
| GetRoleEligibilityScheduleRequests(ArmResource) |
Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead. |
| GetRoleEligibilitySchedules(ArmResource) |
Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead. |
| GetRoleManagementPolicies(ArmResource) |
Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead. |
| GetRoleManagementPolicy(ArmResource, String, CancellationToken) |
Get the specified role management policy for a resource scope
|
| GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
| GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
| GetRoleManagementPolicyAssignments(ArmResource) |
Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead. |
| GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy for a resource scope
|
| GetSystemAssignedIdentity(ArmResource) |
Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead. |
| GetLinkerResource(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
| GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
| GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |
